SchemaI (MyTISM API Documentation)

All Known Subinterfaces:

InstrumentingSchemaI

All Known Implementing Classes:

CBOSchema, InstrumentingSchema, SchemaWrapper
```
public interface SchemaI
```
The SchemaI interface defines the methods for accessing and manipulating schema information in the IPCON MyTISM system.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATT_NAME_DEFAULT_PACKAGE`
`static char`	`INITIALDATA_LINE_ENCLOSING_CHAR`
`static char`	`INITIALDATA_LINE_SEPARATOR_CHAR`
`static java.lang.String`	`INITIALDATA_SCHEMA_ADDITIONS_FILENAME`
`static java.lang.String`	`MD_DISABLE`
`static java.lang.String`	`MD_NON_DESTRUCTIVE`
`static java.lang.String`	`MD_RECREATE_INDEXES`
`static int`	`NAME_MINLENGTH`
`static java.lang.String`	`RELATION_TYPE_1_N` Type representing one-to-many relations with value "1-n".
`static java.lang.String`	`RELATION_TYPE_N_1` Type representing many-to-one relations with value "n-1".
`static java.lang.String`	`RELATION_TYPE_N_M` Type representing many-to-many relations with value "n-m".
`static java.lang.String`	`SUFFIX_FOLDER_KEY`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRelationObject(java.lang.Object bo, java.lang.String attPath, java.lang.Object toAdd)`
`AggregateFunctionI`	`aggregate(AggregateFunctionI a, BOI bo, java.lang.String pathlist)`
`AggregateFunctionI`	`aggregate(java.lang.String aggregateName, BOI bo, java.lang.String pathlist)`
`AggregateFunctionI`	`aggregate(java.lang.String aggregateName, BOI bo, java.lang.String pathlist, java.lang.String parameters)`
`AggregateFunctionI`	`aggregate(java.lang.String aggregateName, BOI bo, java.lang.String pathlist, java.lang.String parameters, boolean ignoreDeleted)`
`static void`	`checkSyntacticallyValid(electric.xml.Element el, java.lang.String s, java.lang.String name)` Checks if the given `String` represents a syntactically valid name for an entity or attribute.
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src)`
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes)`
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType)`
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName)`
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName)`
`ScriptFunctionI`	`createFunction(java.lang.String language, java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName, int lineOffset)`
`ScriptFunctionI`	`createFunctionFromXML(java.lang.String xml, java.lang.String[] parmNames, java.lang.Class[] parmTypes)`
`ScriptFunctionI`	`createFunctionFromXML(java.lang.String xml, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType)`
`ScriptFunctionI`	`createFunctionFromXML(java.lang.String xml, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName)`
`ScriptFunctionI`	`createFunctionFromXML(java.lang.String xml, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName, int lineOffset)`
`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.
`default java.lang.String`	`describeNE(java.lang.Object o)` "format" an object but never return an empty String.
`default java.lang.String`	`describeNE(java.lang.Object o, java.lang.String formatdef)` "format" an object but never return an empty String.
`default java.lang.String`	`describeNE(java.lang.Object o, java.lang.String formatdef, java.util.Map variables)` "format" an object but never return an empty String.
`default java.lang.String`	`describeNE(java.lang.Object o, java.lang.String formatdef, java.util.Map variables, SchemaI onBehalfOfSchema)` "format" an object but never return an empty String.
`static java.util.List<EntityI>`	`filterEntities(java.util.List<EntityI> entities, java.util.function.Predicate<EntityI> predicate)` A static helper method to filter a list of entities based on a given predicate.
`java.lang.String`	`flattenToString()` Generates a normalized string representation of the schema.
`AnnotatedValue`	`getAnnotatedValue(java.lang.Object bo, java.lang.String attPath)`
`AnnotatedValue`	`getAnnotatedValue(java.lang.Object bo, java.lang.String[] attPath)`
`AnnotatedValue`	`getAnnotatedValueAsString(java.lang.Object bo, java.lang.String attPath)`
`AnnotatedValue`	`getAnnotatedValueAsString(java.lang.Object bo, java.lang.String[] attPath)`
`AttributeI`	`getAttribute(java.lang.Object bo, java.lang.String attPath)` Getting Attributes via name or given object.
`AttributeI`	`getAttribute(java.lang.Object bo, java.lang.String attPath, boolean noThrow)` Getting Attributes via name or given object.
`BOI`	`getBOForLastPathElement(BOI rootBo, java.lang.String path)`
`default java.lang.String[]`	`getBundleLookupPath(java.lang.String bundleName, java.lang.String bundlePostfix)` Generates an array of lookup paths for a resource bundle.
`BOI`	`getClosestAvailableAggregateAnchor(BOI bo, java.lang.String pathlist)`
`default java.util.List<EntityI>`	`getCoreEntityList()` Retrieves a list of entities that were initially defined in the MyTISM core schema.
`CryptoHandlerI`	`getCryptoHandler()` Retrieves the CryptoHandlerI of this schema.
`java.lang.String`	`getCurrentFolder()`
`java.lang.String`	`getCurrentModuleOrProject()`
`java.lang.String`	`getCurrentModulePackage()`
`java.util.List<ScriptImport>`	`getDefaultImports()`
`java.lang.String`	`getDefaultPackage()`
`java.util.Map`	`getDiscriminators()` Needed between the Entities of a Schema.
`java.util.List<EntityI>`	`getEntitiesForInterface(java.lang.Class clazz)` Returns a list of all entities that implement the given interface.
`default EntityI`	`getEntity(BasicEntityI entityToLookup)` Looks up the passed BasicEntityI in this SchemaI and returns the fitting EntityI from this SchemaI, i.e. the one with the same name.
`EntityI`	`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.
`static java.lang.String`	`getEntityOrAttributeNameValidationError(java.lang.String s)` Validates the given `String` as a syntactically valid name for an entity or attribute.
`java.lang.String`	`getFingerprint()` Base64 coded SHA-digest of `getSerialVersionUIDs()` result.
`FormatterI`	`getFormatter()` "format" an object.
`FormatterI`	`getFormatter(java.lang.Object rootObject)` "format" an object.
`FormatterI`	`getFormatter(java.lang.Object rootObject, java.util.Map objectMap)` "format" an object.
`FormatterI`	`getFormatter(java.lang.Object rootObject, java.util.Map objectMap, SchemaI onBehalfOfSchema)` "format" an object.
`AttributeI[]`	`getFrappingAttributes(BOI bo)`
`java.util.List<GDPRConfigurationElement>`	`getGDPRConfigElements()`
`SchemaInterfaceI`	`getInterface(java.lang.String name)` Returns the `SchemaInterfaceI` for the passed name.
`java.util.Collection<? extends SchemaInterfaceI>`	`getInterfaces()` Returns a collection of all interfaces defined in the schema.
`EntityI`	`getLowestCommonDenominateEntity(BOI[] bos)`
`default java.util.List<EntityI>`	`getModuleEntityList()` Retrieves a list of entities that were initially defined in the schema of any module.
`AttributeI[]`	`getNonPersistentAttributes(BOI bo)`
`java.util.List<java.lang.String>`	`getPackageList()`
`PermissionHandlerI`	`getPermissionHandler()` Retrieves the PermissionHandlerI of this schema.
`default java.util.List<EntityI>`	`getProjectEntityList()` Retrieves a list of entities that were initially defined in the schema of the current project.
`java.util.Collection<? extends SchemaInterfaceI>`	`getProjectInterfaces()` Returns a collection of all project-specific interfaces defined in the schema.
`java.lang.String`	`getProjectPackage()`
`java.lang.String`	`getProperty(java.lang.String name)`
`java.lang.String`	`getProperty(java.lang.String name, java.lang.String theDefault)`
`java.util.Map<java.lang.String,ModuleProvider>`	`getRegisteredModuleProviders()`
`java.util.Map`	`getRelationObjects(java.lang.Object bo, java.lang.String attPath)`
`AbstractScript`	`getScript()` Script support for instrumenting etc.
`AbstractScript`	`getScript(java.lang.String language)`
`java.lang.String`	`getSerializationRelevantDiff(SchemaI another)`
`java.lang.String`	`getSerialVersionUIDs()` Text with line per entity in the form "entity.fqname':'entity.getSerialVersionUID".
`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.lang.String[]`	`getToolTipBundleLookupPath()`
`CBOAttributeTypeI`	`getType(java.lang.String name)` Type factory.
`java.util.Map<java.lang.String,java.util.List<Module>>`	`getUsedModules()`
`java.lang.Object`	`getValue(java.lang.Object bo, AttributeI[] attPath)` Deprecated. please use `getValue(Object, String)` instead, as that one is polymorphic
`java.lang.Object`	`getValue(java.lang.Object bo, java.lang.String attPath)` Setting/getting Values from Objects.
`java.lang.Object`	`getValue(java.lang.Object bo, java.lang.String attPath, boolean nullOnPathNull)` Setting/getting Values from Objects.
`java.lang.Object`	`getValue(java.lang.Object bo, java.lang.String attPath, boolean nullOnPathNull, boolean noAttrOnPathNull)` Setting/getting Values from Objects.
`java.lang.String`	`getValueAsString(java.lang.Object bo, AttributeI[] attPath)` Deprecated. please use `getValueAsString(Object, String)` instead, as that one is polymorphic
`java.lang.String`	`getValueAsString(java.lang.Object bo, java.lang.String attPath)` Setting/getting Values from Objects.
`java.lang.String`	`getValueAsString(java.lang.Object bo, java.lang.String attPath, boolean nullIfNullOnPath)` Setting/getting Values from Objects.
`java.lang.String`	`getVersion()` Just version "schema-artikel2008-02-29".
`boolean`	`hasRelationObject(java.lang.Object bo, java.lang.String attPath, java.lang.Object toHave)`
`default boolean`	`isUsingModules()` Returns `true` if this SchemaI is using modules.
`static java.util.Map<java.lang.String,java.lang.String>`	`parseGuiTips(java.lang.String v)` Parses whitespace-delimited 'variable:value'-pairs stored as a string in GUI tips.
`static java.util.Map<java.lang.String,java.lang.String>`	`parseGuiTips(java.lang.String v, java.util.Map<java.lang.String,java.lang.String> m)` Parses whitespace-delimited 'variable:value'-pairs stored as a string in GUI tips.
`void`	`releaseDefinitionSource()`
`void`	`removeRelationObject(java.lang.Object bo, java.lang.String attPath, java.lang.Object toRemove)`
`void`	`setCryptoHandler(CryptoHandlerI ch)` Sets the CryptoHandlerI for this schema.
`void`	`setPermissionHandler(PermissionHandlerI ph)` Sets the PermissionHandlerI for this schema.
`void`	`setProperty(java.lang.String name, java.lang.String value)`
`void`	`setValue(java.lang.Object bo, java.lang.String attPath, java.lang.Object value)` Setting/getting Values from Objects.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String attPath, java.lang.String value)` Setting/getting Values from Objects.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String attPath, java.lang.String value, boolean checkConstraints)` Setting/getting Values from Objects.
`static java.lang.String[]`	`splitInitialDataLine(java.lang.String line)` Helper method to split a given initial data line stored in an EntityI (String) into fields.

Field Detail
- ATT_NAME_DEFAULT_PACKAGE
```
static final java.lang.String ATT_NAME_DEFAULT_PACKAGE
```
  See Also:
  
  Constant Field Values
- MD_DISABLE
```
static final java.lang.String MD_DISABLE
```
  See Also:
  
  Constant Field Values
- MD_NON_DESTRUCTIVE
```
static final java.lang.String MD_NON_DESTRUCTIVE
```
  See Also:
  
  Constant Field Values
- MD_RECREATE_INDEXES
```
static final java.lang.String MD_RECREATE_INDEXES
```
  See Also:
  
  Constant Field Values
- NAME_MINLENGTH
```
static final int NAME_MINLENGTH
```
  See Also:
  
  Constant Field Values
- RELATION_TYPE_N_1
```
static final java.lang.String RELATION_TYPE_N_1
```
  Type representing many-to-one relations with value "n-1".
  
  See Also:
  
  Constant Field Values
- RELATION_TYPE_1_N
```
static final java.lang.String RELATION_TYPE_1_N
```
  Type representing one-to-many relations with value "1-n".
  
  See Also:
  
  Constant Field Values
- RELATION_TYPE_N_M
```
static final java.lang.String RELATION_TYPE_N_M
```
  Type representing many-to-many relations with value "n-m".
  
  See Also:
  
  Constant Field Values
- SUFFIX_FOLDER_KEY
```
static final java.lang.String SUFFIX_FOLDER_KEY
```
  See Also:
  
  Constant Field Values
- INITIALDATA_LINE_ENCLOSING_CHAR
```
static final char INITIALDATA_LINE_ENCLOSING_CHAR
```
  See Also:
  
  Constant Field Values
- INITIALDATA_LINE_SEPARATOR_CHAR
```
static final char INITIALDATA_LINE_SEPARATOR_CHAR
```
  See Also:
  
  Constant Field Values
- INITIALDATA_SCHEMA_ADDITIONS_FILENAME
```
static final java.lang.String INITIALDATA_SCHEMA_ADDITIONS_FILENAME
```
  See Also:
  
  Constant Field Values

Method Detail

parseGuiTips
```
static java.util.Map<java.lang.String,java.lang.String> parseGuiTips(java.lang.String v)
```
Parses whitespace-delimited 'variable:value'-pairs stored as a string in GUI tips. This method splits the pairs by the whitespace delimiter and stores them in a newly created map as key-value relationships.

Parameters:

v - The whitespace-delimited 'variable:value'-pairs as a string.

Returns:

A map containing the parsed key-value pairs.

parseGuiTips
```
static java.util.Map<java.lang.String,java.lang.String> parseGuiTips(java.lang.String v,
                                                                     java.util.Map<java.lang.String,java.lang.String> m)
```
Parses whitespace-delimited 'variable:value'-pairs stored as a string in GUI tips. This method splits the pairs by the whitespace delimiter and stores them in the given map as key-value relationships. If the given map is null, a new map will be created.
Note: Some GUI tips may not have the 'variable:value' format, but just a single value. In this case, the value is used key and the value in the map is set to the empty String.

Parameters:

v - The whitespace-delimited 'variable:value'-pairs as a string.

m - The map to put the key-value pairs into.

Returns:

The passed map, containing the parsed key-value pairs.

Throws:

java.lang.IllegalArgumentException - if one of the 'variable:value'-pairs contains more than one colon

splitInitialDataLine
```
static java.lang.String[] splitInitialDataLine(java.lang.String line)
```
Helper method to split a given initial data line stored in an EntityI (String) into fields. The line is split based on the INITIALDATA_LINE_ENCLOSING_CHAR and INITIALDATA_LINE_SEPARATOR_CHAR characters.

Parameters:

line - the initial data line to split

Returns:

an array of strings representing the split fields, or null if the line is empty or null

getEntityOrAttributeNameValidationError
```
static java.lang.String getEntityOrAttributeNameValidationError(java.lang.String s)
```
Validates the given String as a syntactically valid name for an entity or attribute. A valid name must meet the following criteria:
- Not null or empty
- Starts with an ASCII letter or underscore
- Contains only ASCII letters, digits, and underscores
- Has a length of at least NAME_MINLENGTH
Parameters:

s - the String to validate

Returns:

an error message if the name is invalid, or null if the name is valid

checkSyntacticallyValid
```
static void checkSyntacticallyValid(electric.xml.Element el,
                                    java.lang.String s,
                                    java.lang.String name)
                             throws SchemaDefinitionException
```
Checks if the given String represents a syntactically valid name for an entity or attribute. This method uses getEntityOrAttributeNameValidationError(String) to perform the validation and throws a SchemaDefinitionException if the name is invalid.

Parameters:

el - the Element that the name to check appears in

s - the String to check

name - the name of the String to check

Throws:

SchemaDefinitionException - if the given name is not valid

getProperty

java.lang.String getProperty(java.lang.String name,
                             java.lang.String theDefault)

getProperty

java.lang.String getProperty(java.lang.String name)

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

getVersion
```
java.lang.String getVersion()
```
Just version "schema-artikel2008-02-29".

getFingerprint
```
java.lang.String getFingerprint()
```
Base64 coded SHA-digest of getSerialVersionUIDs() result.

getSerialVersionUIDs
```
java.lang.String getSerialVersionUIDs()
```
Text with line per entity in the form "entity.fqname':'entity.getSerialVersionUID".

getSerializationRelevantDiff

java.lang.String getSerializationRelevantDiff(SchemaI another)

flattenToString
```
java.lang.String flattenToString()
```
Generates a normalized string representation of the schema.
This method creates a flattened, string-based representation of the schema, suitable for transmission and reconstruction on a remote system. This is crucial for scenarios where services or clients lack a local schema and need to obtain it from a remote server (e.g., via ServerConnectionI.getRemoteSchema()).

Important: Keep this method updated whenever the schema XML structure is modified or extended to ensure this mechanism still works!

Returns:

A normalized string representation of the schema.

releaseDefinitionSource
```
void releaseDefinitionSource()
```

getToolTipBundleLookupPath

java.lang.String[] getToolTipBundleLookupPath()

getProjectPackage
```
java.lang.String getProjectPackage()
```

getDefaultPackage
```
java.lang.String getDefaultPackage()
```

getCurrentFolder
```
java.lang.String getCurrentFolder()
```

getCurrentModuleOrProject

java.lang.String getCurrentModuleOrProject()

getCurrentModulePackage

java.lang.String getCurrentModulePackage()

setCryptoHandler
```
void setCryptoHandler(CryptoHandlerI ch)
```
Sets the CryptoHandlerI for this schema.

getCryptoHandler
```
CryptoHandlerI getCryptoHandler()
```
Retrieves the CryptoHandlerI of this schema.

setPermissionHandler
```
void setPermissionHandler(PermissionHandlerI ph)
```
Sets the PermissionHandlerI for this schema.

getPermissionHandler
```
PermissionHandlerI getPermissionHandler()
```
Retrieves the PermissionHandlerI of this schema.

getScript
```
AbstractScript getScript()
```
Script support for instrumenting etc.

getScript

AbstractScript getScript(java.lang.String language)

getSubScript
```
AbstractScript getSubScript()
```

getSubScript

AbstractScript getSubScript(java.lang.String language)

getSubScript

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

getSubScript

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

getSubScript

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

getSubScript

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

getDefaultImports

java.util.List<ScriptImport> getDefaultImports()

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src)

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src,
                               java.lang.String[] parmNames,
                               java.lang.Class[] parmTypes)

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src,
                               java.lang.String[] parmNames,
                               java.lang.Class[] parmTypes,
                               java.lang.Class returnType)

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src,
                               java.lang.String[] parmNames,
                               java.lang.Class[] parmTypes,
                               java.lang.Class returnType,
                               java.lang.String scriptName)

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src,
                               java.lang.String[] parmNames,
                               java.lang.Class[] parmTypes,
                               java.lang.Class returnType,
                               java.lang.String scriptName,
                               java.lang.String functionName)

createFunction

ScriptFunctionI createFunction(java.lang.String language,
                               java.lang.String src,
                               java.lang.String[] parmNames,
                               java.lang.Class[] parmTypes,
                               java.lang.Class returnType,
                               java.lang.String scriptName,
                               java.lang.String functionName,
                               int lineOffset)

createFunctionFromXML

ScriptFunctionI createFunctionFromXML(java.lang.String xml,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes)
                               throws electric.xml.ParseException

Throws:: electric.xml.ParseException

createFunctionFromXML

ScriptFunctionI createFunctionFromXML(java.lang.String xml,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType)
                               throws electric.xml.ParseException

Throws:: electric.xml.ParseException

createFunctionFromXML

ScriptFunctionI createFunctionFromXML(java.lang.String xml,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String scriptName,
                                      java.lang.String functionName)
                               throws electric.xml.ParseException

Throws:: electric.xml.ParseException

createFunctionFromXML

ScriptFunctionI createFunctionFromXML(java.lang.String xml,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String scriptName,
                                      java.lang.String functionName,
                                      int lineOffset)
                               throws electric.xml.ParseException

Throws:: electric.xml.ParseException

getEntity
```
default EntityI getEntity(BasicEntityI entityToLookup)
```
Looks up the passed BasicEntityI in this SchemaI and returns the fitting EntityI from this SchemaI, i.e. the one with the same name.

Parameters:

entityToLookup - the BasicEntityI we want to look up in this SchemaI

Returns:

the EntityI with the same name, but taken from this SchemaI, or null if a null BasicEntityI was passed.

getEntity

EntityI getEntity(java.lang.String name)

getEntityForClassName

EntityI getEntityForClassName(java.lang.String className)

getEntityForClass

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

getEntityForObject

EntityI getEntityForObject(java.lang.Object o)

getEntitiesForInterface
```
java.util.List<EntityI> getEntitiesForInterface(java.lang.Class clazz)
```
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.

Parameters:

clazz - The interface class.

Returns:

A list of all entities implementing the given interface.

Throws:

java.lang.IllegalArgumentException - If the provided class is not an interface.

getInterfaces
```
java.util.Collection<? extends SchemaInterfaceI> getInterfaces()
```
Returns a collection of all interfaces defined in the schema.

Returns:

A collection of SchemaInterfaceI representing all interfaces in the schema.

getProjectInterfaces
```
java.util.Collection<? extends SchemaInterfaceI> getProjectInterfaces()
```
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.

Returns:

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

getGDPRConfigElements

java.util.List<GDPRConfigurationElement> getGDPRConfigElements()

getEntityList
```
java.util.List<EntityI> getEntityList()
```
Retrieves a list of all entities known and defined within this schema.

Returns:

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

getCoreEntityList
```
default java.util.List<EntityI> getCoreEntityList()
```
Retrieves a list of entities that were initially defined in the MyTISM core schema. The filtering criterion for core entities typically aligns with EntityI.isCoreNative().

Returns:

A List of EntityI objects belonging to the core schema. Returns an empty list if no core entities are found, but that will never happen, as we always have core entities.

getModuleEntityList
```
default java.util.List<EntityI> getModuleEntityList()
```
Retrieves a list of entities that were initially defined in the schema of any module. The filtering criterion for module entities typically aligns with EntityI.isModuleNative().

Returns:

A List of EntityI objects belonging to module schemas. Returns an empty list if no module entities are found.

getProjectEntityList
```
default java.util.List<EntityI> getProjectEntityList()
```
Retrieves a list of entities that were initially defined in the schema of the current project. The filtering criterion for project entities typically aligns with EntityI.isProjectNative().

Returns:

A List of EntityI objects belonging to the project's schema. Returns an empty list if no project entities are found.

filterEntities
```
static java.util.List<EntityI> filterEntities(java.util.List<EntityI> entities,
                                              java.util.function.Predicate<EntityI> predicate)
```
A static helper method to filter a list of entities based on a given predicate. This method is primarily intended for internal use by default methods within this interface to remove redundancy in filtering logic.

Parameters:

entities - The list of EntityI objects to filter.

predicate - The Predicate to apply for filtering entities.

Returns:

A new List containing only the entities that satisfy the predicate.

getLowestCommonDenominateEntity

EntityI getLowestCommonDenominateEntity(BOI[] bos)

getPackageList

java.util.List<java.lang.String> getPackageList()

getAttribute

AttributeI getAttribute(java.lang.Object bo,
                        java.lang.String attPath,
                        boolean noThrow)

Getting Attributes via name or given object.

getAttribute

AttributeI getAttribute(java.lang.Object bo,
                        java.lang.String attPath)

Getting Attributes via name or given object.

getFrappingAttributes

AttributeI[] getFrappingAttributes(BOI bo)