de.ipcon.schema

Interface InstrumentingSchemaI

All Superinterfaces:

SchemaI

All Known Implementing Classes:

InstrumentingSchema

public interface InstrumentingSchemaI
extends SchemaI

An instrumenting schema is a special type of Schema which provides the ability to dynamically add virtual properties and (sub) entities to the structure during runtime.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Fields inherited from interface de.ipcon.schema.SchemaI

ATT_NAME_DEFAULT_PACKAGE, INITIALDATA_LINE_ENCLOSING_CHAR, INITIALDATA_LINE_SEPARATOR_CHAR, INITIALDATA_SCHEMA_ADDITIONS_FILENAME, MD_DISABLE, MD_NON_DESTRUCTIVE, MD_RECREATE_INDEXES, NAME_MINLENGTH, RELATION_TYPE_1_N, RELATION_TYPE_N_1, RELATION_TYPE_N_M

Method Summary

Modifier and Type	Method and Description
void	addDefinerFuture(java.util.concurrent.CompletableFuture f)
void	addInitFuture(java.util.concurrent.CompletableFuture f)
EntityI	addVirtualEntity(BasicEntityI baseEntity, java.lang.String name) Creates a new virtual sub entity to this schema and its namespace.
EntityI	addVirtualEntity(java.lang.String baseEntityName, java.lang.String name) Creates a new VirtualEntity extending the given BaseEntity and returns it.
AttributeI	addVirtualProperty(electric.xml.Element el)
AttributeI	addVirtualProperty(electric.xml.Element el, java.util.Map parameters)
AttributeI	addVirtualProperty(electric.xml.Element el, java.util.Map parameters, boolean ignoreError) Adds a virtual property to this Instrumenting schema.
AttributeI	addVirtualProperty(java.util.Map def)
AttributeI	addVirtualProperty(java.util.Map def, java.util.Map parameters)
AttributeI	addVirtualProperty(java.util.Map def, java.util.Map parameters, boolean ignoreError) Creates a new virtual property using a definition from a (flat) map.
EntityI	coerceEntity(EntityI e, java.lang.String reason) Wraps and returns the wrapped EntityI into this InstrumentingSchemaI
java.util.List<EntityI>	coerceEntityList(java.util.List<EntityI> l, java.lang.String reason)
void	flushCaches() Iterates over all Entities and flushes caches which may contain references to previously loaded BOs, e.g. the value cache in ScriptedAttributes.
java.util.function.Consumer<SetValueEventI>	getDefaultSetValueCallback()
java.util.List<EntityI>	getVirtualSubEntityList(EntityI baseEntity)
java.util.List<EntityI>	getVirtualSubEntityList(java.lang.String baseEntityName)
boolean	hasVirtualSubEntities(EntityI baseEntity)
boolean	hasVirtualSubEntities(java.lang.String baseEntityName)
java.util.List<java.lang.Throwable>	waitForCompilationAndGetErrors()
void	waitForDefinerCompilation()

Methods inherited from interface de.ipcon.schema.SchemaI

addRelationObject, aggregate, aggregate, aggregate, checkSyntacticallyValid, createFunction, createFunction, createFunction, createFunction, createFunction, createFunction, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, describe, describe, describe, describe, describeNE, describeNE, describeNE, describeNE, flattenToString, getAnnotatedValue, getAnnotatedValueAsString, getAttribute, getAttribute, getBOForLastPathElement, getBundleLookupPath, getClosestAvailableAggregateAnchor, getCryptoHandler, getCurrentFolder, getDefaultImports, getDefaultPackage, getDiscriminators, getEntitiesForInterface, getEntity, getEntity, getEntityForClass, getEntityForClassName, getEntityForObject, getEntityList, getEntityOrAttributeNameValidationError, getFingerprint, getFormatter, getFormatter, getFormatter, getFormatter, getFrappingAttributes, getGDPRConfigElements, getInterface, getInterfaces, getLowestCommonDenominateEntity, getNonPersistentAttributes, getPackageList, getPermissionHandler, getProjectInterfaces, getProjectPackage, getProperty, getProperty, getRegisteredModuleProviders, getRelationObjects, getScript, getScript, getSerializationRelevantDiff, getSerialVersionUIDs, getSubScript, getSubScript, getSubScript, getSubScript, getSubScript, getSubScript, getToolTipBundleLookupPath, getType, getUsedModules, getValue, getValue, getValue, getValue, getValueAsString, getValueAsString, getValueAsString, getVersion, hasRelationObject, isUsingModules, parseGuiTips, parseGuiTips, releaseDefinitionSource, removeRelationObject, setCryptoHandler, setPermissionHandler, setProperty, setValue, setValueAsString, setValueAsString, splitInitialDataLine

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

addVirtualProperty

AttributeI addVirtualProperty(electric.xml.Element el,
                              java.util.Map parameters,
                              boolean ignoreError)

Adds a virtual property to this Instrumenting schema. If a virtual property of the same name is already defined in the context of that entity, then that virtual property is returned and the ScriptedAttribute definition is ignored. If this name is already defined by another type of attribute, then will return either null or throws an RuntimeException.

Parameters:

el - the nonnull root 'virtualProperty' element defining the property

parameters - a map of additional parameters String->Object to be injected into the scripts when executing, e.g. logger or context accessor

ignoreError - if true and the virtual property cannot be constructed, e.g. due to a naming clash or invalid scripts, catch exceptions and return null.

Returns:

the newly created virtual property, constructed according to the passed Map or null, if the virtual property could not be constructed for some reason, which is logged.

See Also:

ScriptedAttribute

addVirtualProperty

AttributeI addVirtualProperty(electric.xml.Element el,
                              java.util.Map parameters)

addVirtualProperty

AttributeI addVirtualProperty(electric.xml.Element el)

addVirtualProperty

AttributeI addVirtualProperty(java.util.Map def,
                              java.util.Map parameters,
                              boolean ignoreError)

Creates a new virtual property using a definition from a (flat) map. Script values are expected to be Groovy closure values.

See Also:

ScriptedAttribute

addVirtualProperty

AttributeI addVirtualProperty(java.util.Map def,
                              java.util.Map parameters)

addVirtualProperty

AttributeI addVirtualProperty(java.util.Map def)

coerceEntity

EntityI coerceEntity(EntityI e,
                     java.lang.String reason)

Wraps and returns the wrapped EntityI into this InstrumentingSchemaI

coerceEntityList

java.util.List<EntityI> coerceEntityList(java.util.List<EntityI> l,
                                         java.lang.String reason)

getDefaultSetValueCallback

java.util.function.Consumer<SetValueEventI> getDefaultSetValueCallback()

Returns:

the default consumer that is used as callback after setting the value on a ScriptedAttribute

flushCaches

void flushCaches()

Iterates over all Entities and flushes caches which may contain references to previously loaded BOs, e.g. the value cache in ScriptedAttributes.

addVirtualEntity

EntityI addVirtualEntity(BasicEntityI baseEntity,
                         java.lang.String name)

Creates a new virtual sub entity to this schema and its namespace. The virtual entity always has to extend a pre-existing entity and have a name that is unique in this schema. Virtual entities behave like normal entities with the exception of not having their own implementation class and changes induced by this limitations. BO instances that use this entity will always return their original entity when calling BOI.getEntity() or SchemaI.getEntityForClass(java.lang.Class), but the virtual entity when using SchemaI.getEntityForObject(java.lang.Object). Adding virtual properties to these is allowed, e.g. to create virtual namespaces for otherwise clashing attribute definitions.

Parameters:

baseEntity - a nonnull BasicEntityI instance to add the virtualEntity to.

name - the name of the VirtualEntity to create, nonnull.

Returns:

a nonnull VirtualEntity with this name and baseEntity.

addVirtualEntity

EntityI addVirtualEntity(java.lang.String baseEntityName,
                         java.lang.String name)

Creates a new VirtualEntity extending the given BaseEntity and returns it.

Parameters:

baseEntityName - the name of the EntityI instance to add this entity to.

name - the name of the VirtualEntity to create, nonnull.

Returns:

a nonnull VirtualEntity with this name and baseEntity.

getVirtualSubEntityList

java.util.List<EntityI> getVirtualSubEntityList(EntityI baseEntity)

Returns:

a list of virtual entities that have the provided entityI as its direct base entity, nonnull.

getVirtualSubEntityList

java.util.List<EntityI> getVirtualSubEntityList(java.lang.String baseEntityName)

Returns:

a list of virtual entities that have the provided entityI as its direct base entity, nonnull.

hasVirtualSubEntities

boolean hasVirtualSubEntities(EntityI baseEntity)

Returns:

true if there exist virtual entities with this as baseEntity. Non-transitive

hasVirtualSubEntities

boolean hasVirtualSubEntities(java.lang.String baseEntityName)

Returns:

true if there exist virtual entities with this as baseEntity. Non-transitive

addDefinerFuture

void addDefinerFuture(java.util.concurrent.CompletableFuture f)

waitForDefinerCompilation

void waitForDefinerCompilation()

addInitFuture

void addInitFuture(java.util.concurrent.CompletableFuture f)

waitForCompilationAndGetErrors

java.util.List<java.lang.Throwable> waitForCompilationAndGetErrors()