de.ipcon.schema

Class InstrumentingSchema

java.lang.Object

de.ipcon.schema.SchemaWrapper

de.ipcon.schema.InstrumentingSchema

All Implemented Interfaces:

InstrumentingSchemaI, SchemaI

public class InstrumentingSchema
extends SchemaWrapper
implements InstrumentingSchemaI

Diese Klasse ist eine Art Meta-Schema, um ein bestehendes Schema dynamisch erweitern, ohne es dafuer komplett zu duplizieren - was notwendig waere, wenn wir die Klasse einfach ableiten wuerden.

Field Summary

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, SUFFIX_FOLDER_KEY

Method Summary

Modifier and Type	Method and Description
void	addDefinerFuture(java.util.concurrent.Future f)
void	addInitFuture(java.util.concurrent.Future f)
VirtualEntity	addVirtualEntity(BasicEntityI baseEntity, java.lang.String name) Creates a new virtual sub entity to this schema and its namespace.
VirtualEntity	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) Adds a virtual property to this schema using an XML element.
AttributeI	addVirtualProperty(electric.xml.Element el, java.util.Map parameters) Adds a virtual property to this schema using an XML element.
AttributeI	addVirtualProperty(electric.xml.Element el, java.util.Map parameters, boolean ignoreError) Adds a virtual property to this schema using an XML element definition.
AttributeI	addVirtualProperty(java.util.Map def) Creates a new virtual property using a definition from a flat map.
AttributeI	addVirtualProperty(java.util.Map def, java.util.Map parameters) Creates a new virtual property using a definition from a flat map.
AttributeI	addVirtualProperty(java.util.Map def, java.util.Map parameters, boolean ignoreError) Creates a new virtual property using a definition from a flat map.
InstrumentingEntity	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)
java.lang.String	describe(java.lang.Object o) "format" an object.
java.lang.String	describe(java.lang.Object o, java.lang.String formatdef) "format" an object.
java.lang.String	describe(java.lang.Object o, java.lang.String formatdef, java.util.Map variables) "format" an object.
java.lang.String	describe(java.lang.Object o, java.lang.String formatdef, java.util.Map variables, SchemaI onBehalfOfSchema) "format" an object.
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.List<ScriptImport>	getDefaultImports()
java.util.function.Consumer<SetValueEventI>	getDefaultSetValueCallback()
java.util.List<EntityI>	getEntitiesForInterface(java.lang.Class clazz) Returns a list of all entities that implement the given interface.
InstrumentingEntity	getEntity(java.lang.String name)
EntityI	getEntityForClass(java.lang.Class<? extends BOI> clazz)
EntityI	getEntityForClassName(java.lang.String className)
EntityI	getEntityForObject(java.lang.Object o)
java.util.List<EntityI>	getEntityList() Retrieves a list of all entities known and defined within this schema.
java.util.List<GDPRConfigurationElement>	getGDPRConfigElements()
static InstrumentingSchemaI	getInstance(SchemaI schema)
static InstrumentingSchemaI	getInstanceForFormReload(SchemaI schema)
static InstrumentingSchemaI	getInstanceForTests(SchemaI schema)
java.util.Collection<? extends SchemaInterfaceI>	getInterfaces() Returns a collection of all interfaces defined in the schema.
EntityI	getLowestCommonDenominateEntity(BOI[] bos)
java.util.Collection<? extends SchemaInterfaceI>	getProjectInterfaces() Returns a collection of all project-specific interfaces defined in the schema.
AbstractScript	getScript() Script support for instrumenting etc.
AbstractScript	getScript(java.lang.String _language)
AbstractScript	getSubScript()
AbstractScript	getSubScript(java.util.List<ScriptImport> additionalImports)
AbstractScript	getSubScript(java.util.List<ScriptImport> additionalImports, java.lang.Class baseClass)
AbstractScript	getSubScript(java.util.List<ScriptImport> additionalImports, java.lang.Class baseClass, java.lang.String language)
AbstractScript	getSubScript(java.util.List<ScriptImport> additionalImports, java.lang.String language)
AbstractScript	getSubScript(java.lang.String language)
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)
void	setDefaultSetValueCallback(java.util.function.Consumer<SetValueEventI> callback)
java.util.List<java.lang.Throwable>	waitForCompilationAndGetErrors()
void	waitForDefinerCompilation()

Methods inherited from class de.ipcon.schema.SchemaWrapper

addRelationObject, aggregate, aggregate, aggregate, aggregate, createFunction, createFunction, createFunction, createFunction, createFunction, createFunction, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, flattenToString, getAnnotatedValue, getAnnotatedValue, getAnnotatedValueAsString, getAnnotatedValueAsString, getAttribute, getAttribute, getBOForLastPathElement, getClosestAvailableAggregateAnchor, getCryptoHandler, getCurrentFolder, getCurrentModuleOrProject, getCurrentModulePackage, getDefaultPackage, getDiscriminators, getFingerprint, getFormatter, getFormatter, getFormatter, getFormatter, getFrappingAttributes, getInterface, getNonPersistentAttributes, getPackageList, getPermissionHandler, getProjectPackage, getProperty, getProperty, getRegisteredModuleProviders, getRelationObjects, getSerializationRelevantDiff, getSerialVersionUIDs, getToolTipBundleLookupPath, getType, getUsedModules, getValue, getValue, getValue, getValue, getValueAsString, getValueAsString, getValueAsString, getVersion, hasRelationObject, releaseDefinitionSource, removeRelationObject, setCryptoHandler, setPermissionHandler, setProperty, setValue, setValueAsString, setValueAsString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.schema.SchemaI

addRelationObject, aggregate, aggregate, aggregate, aggregate, checkSyntacticallyValid, createFunction, createFunction, createFunction, createFunction, createFunction, createFunction, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, createFunctionFromXML, describeNE, describeNE, describeNE, describeNE, filterEntities, flattenToString, getAnnotatedValue, getAnnotatedValue, getAnnotatedValueAsString, getAnnotatedValueAsString, getAttribute, getAttribute, getBOForLastPathElement, getBundleLookupPath, getClosestAvailableAggregateAnchor, getCoreEntityList, getCryptoHandler, getCurrentFolder, getCurrentModuleOrProject, getCurrentModulePackage, getDefaultPackage, getDiscriminators, getEntity, getEntityOrAttributeNameValidationError, getFingerprint, getFormatter, getFormatter, getFormatter, getFormatter, getFrappingAttributes, getInterface, getModuleEntityList, getNonPersistentAttributes, getPackageList, getPermissionHandler, getProjectEntityList, getProjectPackage, getProperty, getProperty, getRegisteredModuleProviders, getRelationObjects, getSerializationRelevantDiff, getSerialVersionUIDs, getToolTipBundleLookupPath, getType, getUsedModules, getValue, getValue, getValue, getValue, getValueAsString, getValueAsString, getValueAsString, getVersion, hasRelationObject, isUsingModules, parseGuiTips, parseGuiTips, releaseDefinitionSource, removeRelationObject, setCryptoHandler, setPermissionHandler, setProperty, setValue, setValueAsString, setValueAsString, splitInitialDataLine

Method Detail

getInstance

public static InstrumentingSchemaI getInstance(SchemaI schema)

getInstanceForTests

public static InstrumentingSchemaI getInstanceForTests(SchemaI schema)

getInstanceForFormReload

public static InstrumentingSchemaI getInstanceForFormReload(SchemaI schema)

setDefaultSetValueCallback

public void setDefaultSetValueCallback(java.util.function.Consumer<SetValueEventI> callback)

getDefaultSetValueCallback

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

Specified by:

getDefaultSetValueCallback in interface InstrumentingSchemaI

Returns:

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

getEntity

public InstrumentingEntity getEntity(java.lang.String name)

Specified by:

getEntity in interface SchemaI

Overrides:

getEntity in class SchemaWrapper

getEntityForClassName

public EntityI getEntityForClassName(java.lang.String className)

Specified by:

getEntityForClassName in interface SchemaI

Overrides:

getEntityForClassName in class SchemaWrapper

getEntityForClass

public EntityI getEntityForClass(java.lang.Class<? extends BOI> clazz)

Specified by:

getEntityForClass in interface SchemaI

Overrides:

getEntityForClass in class SchemaWrapper

getEntityForObject

public EntityI getEntityForObject(java.lang.Object o)

Specified by:

getEntityForObject in interface SchemaI

Overrides:

getEntityForObject in class SchemaWrapper

getEntitiesForInterface

public java.util.List<EntityI> getEntitiesForInterface(java.lang.Class clazz)

Description copied from interface: SchemaI

Returns a list of all entities that implement the given interface.

This method retrieves all entities within the schema that implement the specified interface. The provided class must represent an interface; otherwise, an IllegalArgumentException is thrown.

Specified by:

getEntitiesForInterface in interface SchemaI

Overrides:

getEntitiesForInterface in class SchemaWrapper

Parameters:

clazz - The interface class.

Returns:

A list of all entities implementing the given interface.

getInterfaces

public java.util.Collection<? extends SchemaInterfaceI> getInterfaces()

Description copied from interface: SchemaI

Returns a collection of all interfaces defined in the schema.

Specified by:

getInterfaces in interface SchemaI

Overrides:

getInterfaces in class SchemaWrapper

Returns:

A collection of SchemaInterfaceI representing all interfaces in the schema.

getProjectInterfaces

public java.util.Collection<? extends SchemaInterfaceI> getProjectInterfaces()

Description copied from interface: SchemaI

Returns a collection of all project-specific interfaces defined in the schema.

Project-specific interfaces are those that belong to the current project's package.

Specified by:

getProjectInterfaces in interface SchemaI

Overrides:

getProjectInterfaces in class SchemaWrapper

Returns:

A collection of SchemaInterfaceI representing all project-specific interfaces in the schema.

getGDPRConfigElements

public java.util.List<GDPRConfigurationElement> getGDPRConfigElements()

Specified by:

getGDPRConfigElements in interface SchemaI

Overrides:

getGDPRConfigElements in class SchemaWrapper

getEntityList

public java.util.List<EntityI> getEntityList()

Description copied from interface: SchemaI

Retrieves a list of all entities known and defined within this schema.

Specified by:

getEntityList in interface SchemaI

Overrides:

getEntityList in class SchemaWrapper

Returns:

A List of all EntityI objects. Returns an empty list if no entities are defined.

getLowestCommonDenominateEntity

public EntityI getLowestCommonDenominateEntity(BOI[] bos)

Specified by:

getLowestCommonDenominateEntity in interface SchemaI

Overrides:

getLowestCommonDenominateEntity in class SchemaWrapper

coerceEntity

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

Description copied from interface: InstrumentingSchemaI

Wraps and returns the wrapped EntityI into this InstrumentingSchemaI

Specified by:

coerceEntity in interface InstrumentingSchemaI

coerceEntityList

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

Specified by:

coerceEntityList in interface InstrumentingSchemaI

addVirtualProperty

public AttributeI addVirtualProperty(electric.xml.Element el)

Description copied from interface: InstrumentingSchemaI

Adds a virtual property to this schema using an XML element.

This is a convenience method that delegates to InstrumentingSchemaI.addVirtualProperty(Element, Map, boolean), using a default 'null' for parameters and not ignoring errors.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

el - The non-null root 'virtualProperty' XML element defining the property.

Returns:

The newly created virtual property.

addVirtualProperty

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

Description copied from interface: InstrumentingSchemaI

Adds a virtual property to this schema using an XML element.

This is a convenience method that delegates to InstrumentingSchemaI.addVirtualProperty(Element, Map, boolean), with error handling set to not ignore errors by default.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

el - The non-null root 'virtualProperty' XML element defining the property.

parameters - A map of additional parameters.

Returns:

The newly created virtual property.

addVirtualProperty

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

Description copied from interface: InstrumentingSchemaI

Adds a virtual property to this schema using an XML element definition.

If a virtual property with the same name already exists within the entity's context, the existing property is returned, and the new definition is ignored. This behavior ensures that an existing, valid property is not accidentally overwritten. If the name is already defined by a different type of attribute (e.g. a physical database column), a RuntimeException may be thrown, depending on the ignoreError flag.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

el - The non-null root 'virtualProperty' XML element defining the property.

parameters - A map of additional parameters (String -> Object) to be injected into the property's scripts at execution time (e.g. a logger or context accessor).

ignoreError - If true, and the virtual property cannot be constructed (e.g. due to a naming clash or invalid script), exceptions are caught, logged, and the method returns null. If false, the exception is re-thrown.

Returns:

The newly created virtual property, or the existing one if a name clash occurred, or null if the property could not be constructed and the error was ignored.

See Also:

ScriptedAttribute

addVirtualProperty

public AttributeI addVirtualProperty(java.util.Map def)

Description copied from interface: InstrumentingSchemaI

Creates a new virtual property using a definition from a flat map.

This convenience method delegates to InstrumentingSchemaI.addVirtualProperty(Map, Map, boolean), using a default 'null' for parameters and not ignoring errors.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

def - The map containing key-value pairs that define the virtual property.

Returns:

The newly created virtual property.

addVirtualProperty

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

Description copied from interface: InstrumentingSchemaI

Creates a new virtual property using a definition from a flat map.

This convenience method delegates to InstrumentingSchemaI.addVirtualProperty(Map, Map, boolean), with error handling set to not ignore errors by default.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

def - The map containing key-value pairs that define the virtual property.

parameters - A map of additional parameters.

Returns:

The newly created virtual property.

addVirtualProperty

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

Description copied from interface: InstrumentingSchemaI

Creates a new virtual property using a definition from a flat map.

This method provides a programmatic way to define a virtual property. The keys in the map correspond to the attributes of the XML element, and script values are expected to be Groovy closures.

Specified by:

addVirtualProperty in interface InstrumentingSchemaI

Parameters:

def - The map containing key-value pairs that define the virtual property.

parameters - A map of additional parameters to be injected into the scripts.

ignoreError - If true, and the property cannot be constructed, exceptions are caught and the method returns null.

Returns:

The newly created virtual property, or null if an error occurred and was ignored.

See Also:

ScriptedAttribute

describe

public java.lang.String describe(java.lang.Object o,
                                 java.lang.String formatdef,
                                 java.util.Map variables,
                                 SchemaI onBehalfOfSchema)

Description copied from interface: SchemaI

"format" an object.

Specified by:

describe in interface SchemaI

Overrides:

describe in class SchemaWrapper

describe

public java.lang.String describe(java.lang.Object o,
                                 java.lang.String formatdef,
                                 java.util.Map variables)

Description copied from interface: SchemaI

"format" an object.

Specified by:

describe in interface SchemaI

Overrides:

describe in class SchemaWrapper

describe

public java.lang.String describe(java.lang.Object o,
                                 java.lang.String formatdef)

Description copied from interface: SchemaI

"format" an object.

Specified by:

describe in interface SchemaI

Overrides:

describe in class SchemaWrapper

describe

public java.lang.String describe(java.lang.Object o)

Description copied from interface: SchemaI

"format" an object.

Specified by:

describe in interface SchemaI

Overrides:

describe in class SchemaWrapper

getDefaultImports

public java.util.List<ScriptImport> getDefaultImports()

Specified by:

getDefaultImports in interface SchemaI

Overrides:

getDefaultImports in class SchemaWrapper

getScript

public AbstractScript getScript()

Description copied from interface: SchemaI

Script support for instrumenting etc.

Specified by:

getScript in interface SchemaI

Overrides:

getScript in class SchemaWrapper

getScript

public AbstractScript getScript(java.lang.String _language)

Specified by:

getScript in interface SchemaI

Overrides:

getScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript()

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript(java.lang.String language)

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript(java.util.List<ScriptImport> additionalImports)

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript(java.util.List<ScriptImport> additionalImports,
                                   java.lang.String language)

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript(java.util.List<ScriptImport> additionalImports,
                                   java.lang.Class baseClass)

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

getSubScript

public AbstractScript getSubScript(java.util.List<ScriptImport> additionalImports,
                                   java.lang.Class baseClass,
                                   java.lang.String language)

Specified by:

getSubScript in interface SchemaI

Overrides:

getSubScript in class SchemaWrapper

flushCaches

public void flushCaches()

Description copied from interface: InstrumentingSchemaI

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

Specified by:

flushCaches in interface InstrumentingSchemaI

addVirtualEntity

public VirtualEntity addVirtualEntity(BasicEntityI baseEntity,
                                      java.lang.String name)

Description copied from interface: InstrumentingSchemaI

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.

Specified by:

addVirtualEntity in interface InstrumentingSchemaI

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

public VirtualEntity addVirtualEntity(java.lang.String baseEntityName,
                                      java.lang.String name)

Description copied from interface: InstrumentingSchemaI

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

Specified by:

addVirtualEntity in interface InstrumentingSchemaI

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

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

Specified by:

getVirtualSubEntityList in interface InstrumentingSchemaI

Returns:

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

getVirtualSubEntityList

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

Specified by:

getVirtualSubEntityList in interface InstrumentingSchemaI

Returns:

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

hasVirtualSubEntities

public boolean hasVirtualSubEntities(EntityI baseEntity)

Specified by:

hasVirtualSubEntities in interface InstrumentingSchemaI

Returns:

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

hasVirtualSubEntities

public boolean hasVirtualSubEntities(java.lang.String baseEntityName)

Specified by:

hasVirtualSubEntities in interface InstrumentingSchemaI

Returns:

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

addDefinerFuture

public void addDefinerFuture(java.util.concurrent.Future f)

Specified by:

addDefinerFuture in interface InstrumentingSchemaI

waitForDefinerCompilation

public void waitForDefinerCompilation()

Specified by:

waitForDefinerCompilation in interface InstrumentingSchemaI

addInitFuture

public void addInitFuture(java.util.concurrent.Future f)

Specified by:

addInitFuture in interface InstrumentingSchemaI

waitForCompilationAndGetErrors

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

Specified by:

waitForCompilationAndGetErrors in interface InstrumentingSchemaI