de.ipcon.schema

Interface StructuredEntityI

All Superinterfaces:

BasicEntityI

All Known Subinterfaces:

EntityI

All Known Implementing Classes:

CBOEntity, EntityDefinition, EntityWrapper, InstrumentingEntity, VirtualEntity

public interface StructuredEntityI
extends BasicEntityI

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0
static netrexx.lang.Rexx	$01
static StructuredEntityI[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
default java.util.List<AttributeI>	getAllAttributeList() Returns a List of all AttributeI instances (including many-relations) of only this EntityI, i.e. excluding attributes from its sub-EntityI instances.
default java.util.List<AttributeI>	getAllAttributeList(boolean includeSubEntities) Returns a List of all AttributeI instances (including many-relations) of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.
default java.util.List<AttributeI>	getAllAttributeList(boolean includeSubEntities, boolean excludeManyRelations) Returns a List of all AttributeI instances of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.
default java.util.List<AttributeI>	getAllAttributeListByType() Returns a List of all persistent AttributeI-s of this EntityI based on the specified criteria, including many-relations, but excluding AttributeI-s from sub-EntityI-s.
default java.util.List<AttributeI>	getAllAttributeListByType(boolean virtual) Returns a List of AttributeI-s of this EntityI based on the specified criteria, including many-relations, but excluding AttributeI-s from sub-EntityI-s.
default java.util.List<AttributeI>	getAllAttributeListByType(boolean virtual, boolean includeSubEntities) Returns a List of AttributeI-s of this EntityI based on the specified criteria, including many-relations.
default java.util.List<AttributeI>	getAllAttributeListByType(boolean virtual, boolean includeSubEntities, boolean excludeManyRelations) Returns a List of AttributeI-s of this EntityI based on the specified criteria.
default java.util.List<AttributeI>	getAllAttributeListWithoutSubentities() Returns a List of all attributes of this StructuredEntityI, including many-relations and including the attributes from base entities but excluding attributes from subentities of this StructuredEntityI.
default java.util.List<AttributeI>	getAllAttributeListWithoutSubentities(boolean excludeManyRelations) Returns a List of all attributes of this StructuredEntityI, including the attributes from base entities but excluding attributes from subentities of this StructuredEntityI.
default java.util.List<EntityI>	getAllSubEntityList() Returns a List of all sub-EntityI-s of this EntityI
default java.util.List<EntityI>	getAllSubEntityList(boolean includeSelf) Returns a List of all sub-EntityI instances of this EntityI.
default java.util.List<EntityI>	getAllSubEntityList(boolean includeSelf, boolean filterAbstract) Returns a List of all sub-EntityI instances of this EntityI.
default AttributeI[]	getAttChain(java.lang.String attPath) Retrieves an array of AttributeI representing the attribute chain necessary to navigate to the attribute specified by the given path within this StructuredEntityI.
default AttributeI[]	getAttChain(java.lang.String attPath, boolean noThrow) Retrieves an array of AttributeI representing the attribute chain necessary to navigate to the attribute specified by the given path within this StructuredEntityI.
default AttributeI	getAttribute(java.lang.String attPath) Retrieves the AttributeI reached by the specified attribute path.
default AttributeI	getAttribute(java.lang.String attPath, boolean noThrow)
EntityI	getBaseEntity()
default EntityI	getPersistentBaseEntity() Returns the persistent base entity for this EntityDefinition, returns null if persistent base couldn't be retrieved from the base entity of this EntityDefinition wasn't set or no persistent base entity was retrievable.
java.util.List<EntityI>	getSubEntityList() return a List of EntityI containing every EntityI that has this StructuredEntityI as getBaseEntity().
default boolean	hasPersistentSubentity() Returns true if any sub-EntityI of this StructuredEntityI is persistent.
boolean	hasSubEntities()
default boolean	isEffectivelyPersistent() Returns true if this StructuredEntityI is either persistent itself or any sub-entity of it is and thus it is implicitly persistent.
default boolean	isImplicitlyPersistent() Returns true if this StructuredEntityI is has any persistent sub-entity.
default boolean	isSubEntityOf(java.lang.String possibleSuperEntityName) Returns true if we are a subentity of the EntityI with the given name or that StructuredEntityI ourself.
default boolean	isSubEntityOf(StructuredEntityI possibleSuperEntity) Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

Methods inherited from interface de.ipcon.schema.BasicEntityI

getAttributeList, getAttributeListByType, getAttributeListByType, getClazz, getDescription, getFolderName, getImplementedSchemaInterfaces, getName, getPlural, getRelations, getSchema, getSingleAttribute, isCustom, isPersistent, isUserAbstract, newInstance

Field Detail

$01

static final netrexx.lang.Rexx $01

$0

static final java.lang.String $0

See Also:

Constant Field Values

EMPTY_ARRAY

static final StructuredEntityI[] EMPTY_ARRAY

Method Detail

isImplicitlyPersistent

default boolean isImplicitlyPersistent()

Returns true if this StructuredEntityI is has any persistent sub-entity.

isEffectivelyPersistent

default boolean isEffectivelyPersistent()

Returns true if this StructuredEntityI is either persistent itself or any sub-entity of it is and thus it is implicitly persistent.

isSubEntityOf

default boolean isSubEntityOf(java.lang.String possibleSuperEntityName)

Returns true if we are a subentity of the EntityI with the given name or that StructuredEntityI ourself.

Parameters:

possibleSuperEntityName - the name of the EntityI to check

Returns:

true if we are a subentity of the EntityI with the given name or that StructuredEntityI ourself.

isSubEntityOf

default boolean isSubEntityOf(StructuredEntityI possibleSuperEntity)

Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

Parameters:

possibleSuperEntity - the EntityI to check

Returns:

true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

getPersistentBaseEntity

default EntityI getPersistentBaseEntity()

Returns the persistent base entity for this EntityDefinition, returns null if persistent base couldn't be retrieved from the base entity of this EntityDefinition wasn't set or no persistent base entity was retrievable.

Returns:

the persistent base entity for this EntityDefinition

getBaseEntity

EntityI getBaseEntity()

Returns:

the base (i.e. super-) EntityI of this EntityI

hasSubEntities

boolean hasSubEntities()

Returns:

true if this EntityI has sub entities

getSubEntityList

java.util.List<EntityI> getSubEntityList()

return a List of EntityI containing every EntityI that has this StructuredEntityI as getBaseEntity(). Does not include this StructuredEntityI or transitive sub-EntityI-s.

hasPersistentSubentity

default boolean hasPersistentSubentity()

Returns true if any sub-EntityI of this StructuredEntityI is persistent.

getAllSubEntityList

default java.util.List<EntityI> getAllSubEntityList()

Returns a List of all sub-EntityI-s of this EntityI

Returns:

a List of all sub-EntityI-s of this EntityI, including the abstract ones.

getAllSubEntityList

default java.util.List<EntityI> getAllSubEntityList(boolean includeSelf)

Returns a List of all sub-EntityI instances of this EntityI.

Parameters:

includeSelf - If true, this EntityI will be included in the list.

Returns:

A List of all sub-EntityI instances of this EntityI, including the abstract ones, optionally excluding this.

getAllSubEntityList

default java.util.List<EntityI> getAllSubEntityList(boolean includeSelf,
                                                    boolean filterAbstract)

Returns a List of all sub-EntityI instances of this EntityI.

Parameters:

includeSelf - If true, this EntityI will be included in the list.

filterAbstract - If true, all abstract EntityI instances will be excluded from the list.

Returns:

A List of all sub-EntityI instances of this EntityI, optionally excluding this and the abstract ones.

getAllAttributeList

default java.util.List<AttributeI> getAllAttributeList()

Returns a List of all AttributeI instances (including many-relations) of only this EntityI, i.e. excluding attributes from its sub-EntityI instances.

Returns:

A List of all AttributeI instances of this EntityI.

getAllAttributeList

default java.util.List<AttributeI> getAllAttributeList(boolean includeSubEntities)

Returns a List of all AttributeI instances (including many-relations) of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.

Parameters:

includeSubEntities - If true, AttributeI instances from sub-EntityI instances will be included in the result list.

Returns:

A List of all AttributeI instances of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.

getAllAttributeList

default java.util.List<AttributeI> getAllAttributeList(boolean includeSubEntities,
                                                       boolean excludeManyRelations)

Returns a List of all AttributeI instances of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.

Parameters:

includeSubEntities - If true, AttributeI instances from sub-EntityI instances will be included in the result list.

excludeManyRelations - If true, many-relation AttributeI instances will not be included in the result list.

Returns:

A List of all AttributeI instances of this EntityI, and optionally, also includes attributes from its sub-EntityI instances based on the passed parameters.

getAllAttributeListWithoutSubentities

default java.util.List<AttributeI> getAllAttributeListWithoutSubentities()

Returns a List of all attributes of this StructuredEntityI, including many-relations and including the attributes from base entities but excluding attributes from subentities of this StructuredEntityI.

Returns:

A List of all attributes from this StructuredEntityI, including the attributes from the entities it is based on, but excluding attributes from subentities.

getAllAttributeListWithoutSubentities

default java.util.List<AttributeI> getAllAttributeListWithoutSubentities(boolean excludeManyRelations)

Returns a List of all attributes of this StructuredEntityI, including the attributes from base entities but excluding attributes from subentities of this StructuredEntityI.

Parameters:

excludeManyRelations - If true, many-relational attributes will be excluded from the result list.

Returns:

A List of all attributes from this StructuredEntityI, including the attributes from the entities it is based on, but excluding attributes from subentities.

getAllAttributeListByType

default java.util.List<AttributeI> getAllAttributeListByType()

Returns a List of all persistent AttributeI-s of this EntityI based on the specified criteria, including many-relations, but excluding AttributeI-s from sub-EntityI-s.

Returns:

A List of AttributeI-s of this EntityI based on the specified criteria.

getAllAttributeListByType

default java.util.List<AttributeI> getAllAttributeListByType(boolean virtual)

Returns a List of AttributeI-s of this EntityI based on the specified criteria, including many-relations, but excluding AttributeI-s from sub-EntityI-s.

Parameters:

virtual - If true, only virtual AttributeI-s will be included; if false, only persistent AttributeI-s will be included.

Returns:

A List of AttributeI-s of this EntityI based on the specified criteria.

getAllAttributeListByType

default java.util.List<AttributeI> getAllAttributeListByType(boolean virtual,
                                                             boolean includeSubEntities)

Returns a List of AttributeI-s of this EntityI based on the specified criteria, including many-relations.

Parameters:

virtual - If true, only virtual AttributeI-s will be included; if false, only persistent AttributeI-s will be included.

includeSubEntities - If true, AttributeI-s from sub-EntityI-s will be included.

Returns:

A List of AttributeI-s of this EntityI based on the specified criteria.

getAllAttributeListByType

default java.util.List<AttributeI> getAllAttributeListByType(boolean virtual,
                                                             boolean includeSubEntities,
                                                             boolean excludeManyRelations)

Returns a List of AttributeI-s of this EntityI based on the specified criteria.

Parameters:

virtual - If true, only virtual AttributeI-s will be included; if false, only persistent AttributeI-s will be included.

includeSubEntities - If true, AttributeI-s from sub-EntityI-s will be included.

excludeManyRelations - If true, many-relation AttributeI-s will be excluded.

Returns:

A List of AttributeI-s of this EntityI based on the specified criteria.

getAttribute

default AttributeI getAttribute(java.lang.String attPath)

Retrieves the AttributeI reached by the specified attribute path.

Parameters:

attPath - The path to the desired AttributeI.

noThrow - If true, the method will return null if the attribute cannot be resolved, instead of throwing an exception. Defaults to true.

Returns:

The AttributeI reached by the given path, or null if noThrow is true and the attribute cannot be resolved.

Throws:

java.lang.IllegalArgumentException - If the provided attribute path is null and noThrow is false.

getAttribute

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

getAttChain

default AttributeI[] getAttChain(java.lang.String attPath)
                          throws java.lang.IllegalArgumentException

Retrieves an array of AttributeI representing the attribute chain necessary to navigate to the attribute specified by the given path within this StructuredEntityI.

The attribute path is a string where attribute names are separated by the delimiter ".". This method attempts to resolve each segment of the path to an AttributeI object, building a chain that leads to the target attribute.

Parameters:

attPath - The attribute path to resolve. For example, "Service.Maintainer.Name".

Returns:

An array of AttributeI objects representing the attribute chain.

Throws:

java.lang.IllegalArgumentException - If the provided attribute path is invalid.

getAttChain

default AttributeI[] getAttChain(java.lang.String attPath,
                                 boolean noThrow)
                          throws java.lang.IllegalArgumentException

Retrieves an array of AttributeI representing the attribute chain necessary to navigate to the attribute specified by the given path within this StructuredEntityI.

The attribute path is a string where attribute names are separated by the delimiter ".". This method tries to resolve each segment of the path to an AttributeI object, building a chain that leads to the target attribute.

Parameters:

attPath - The attribute path to resolve. For example, "Service.Maintainer.Name".

noThrow - If true, the method will return an empty array if any part of the attribute path cannot be resolved, instead of throwing an exception. If false, an IllegalArgumentException will be thrown if the path is invalid.

Returns:

An array of AttributeI objects representing the attribute chain. The array will be empty if noThrow is true and the path cannot be fully resolved.

Throws:

java.lang.IllegalArgumentException - If the provided attribute path is invalid and noThrow is false.