de.ipcon.schema

Class InstrumentingEntity

java.lang.Object

de.ipcon.schema.EntityWrapper

de.ipcon.schema.InstrumentingEntity

All Implemented Interfaces:

BasicEntityI, EntityI, InstrumentingSchemaProviderI, SchemaProviderI, StructuredEntityI, DirectedGraphNodeI, OnlyToDirectedGraphNodeI, java.lang.Comparable

Direct Known Subclasses:

VirtualEntity

public class InstrumentingEntity
extends EntityWrapper
implements InstrumentingSchemaProviderI

Das Problem, warum wir eigentlich diese Klasse brauchen ist, dass die Entitaeten untereinander recht stark vernetzt sind. Dadurch koennte man, wenn man in einer "Schicht" ueber dem normalen Schema operiert, in einer "unten drunter" geraten, weil man in der EntityI nach getBase() fragt, sollte natuerlich eine EntityI *dieses* Schemas herauskommen, nicht eine des Schemas von dem das kommt. Hoffe, das erklaert diesen Heckmeck hier ein wenig... Vorsicht: Diese Implementation geht davon aus, dass keine neuen Entitaeten gebaut werden und auch keine verschwinden - sonst muesste man auch neue Klassen einfuehren oder ClassLoader dafuer bauen. Das lassen wir mal fuer den Moment... ;-)

Nested Class Summary

Nested classes/interfaces inherited from interface de.ipcon.schema.EntityI

EntityI.EntityMatcher, EntityI.NonPersistentEdgeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY_RELATION_POSTIFX

Fields inherited from interface de.ipcon.schema.EntityI

ATT_NAME_ABSTRACT, ATT_NAME_CODE_CUSTOM, ATT_NAME_CODE_DEPENDENTS, ATT_NAME_CODE_GENERATE, ATT_NAME_CODE_GENERATE_AS, ATT_NAME_CODE_PACKAGE, ATT_NAME_DB_FORBID_DIRECT_CHANGES, ATT_NAME_DB_LOW_INSTANCE_COUNT, ATT_NAME_DB_NAME, ATT_NAME_DB_NO_STREAM_RESOURCE_HISTORY, ATT_NAME_DB_PERSISTENT, ATT_NAME_DB_STREAM_RESOURCE, ATT_NAME_DISCRIMINATOR, ATT_NAME_EXPORT_MODE, ATT_NAME_EXPORT_NAME, ATT_NAME_EXPORT_PRIMARY_KEY, ATT_NAME_EXTENDS, ATT_NAME_FOLDER, ATT_NAME_FULLTEXT_BOOST, ATT_NAME_FULLTEXT_INDEXED, ATT_NAME_GDPR_DATA_CATEGORY, ATT_NAME_GDPR_RETENTION_START_DATE_PATH, ATT_NAME_IGNORE_REVERSE_RELATIONS, ATT_NAME_IMPLEMENTS_NAME, ATT_NAME_LOOKUP_DEFAULT_CASE_SENSITIVE, ATT_NAME_LOOKUP_DEFAULT_PROPERTY, ATT_NAME_LOOKUP_DEFAULT_SUBSTRING, ATT_NAME_MERGE, ATT_NAME_NAME, ATT_NAME_NO_ABSTRACT_WARNING, ATT_NAME_PACKAGE, ATT_NAME_PLURAL, ATT_NAME_REPORT_FONT_SIZE_BIG, ATT_NAME_REPORT_FONT_SIZE_NORMAL, ATT_NAME_REPORT_ORIENTATION, ATT_NAME_REPORT_TITLE, ATT_NAME_SUID, ATT_NAME_UI_DEFAULT_SELECTION_FILTER, ATT_NAME_UI_DEFAULT_SORTING, ATT_NAME_UI_DESCRIPTION, ATT_NAME_UI_LINK_ONLY, ATT_NAME_UI_LOAD_IMMEDIATE, ATT_NAME_UI_TIPS, DEFAULT_GENERATE_AS_SUFFIX, DEFAULT_SORTING_ASC, DEFAULT_SORTING_DESC, DEPENDENTS_SEPARATOR_CHAR, EL_NAME_ACTION, EL_NAME_ATTR, EL_NAME_CODE, EL_NAME_COMMENT, EL_NAME_DB, EL_NAME_EXPORT, EL_NAME_FULLTEXT, EL_NAME_GDPR, EL_NAME_IMPLEMENTS, EL_NAME_LOOKUP, EL_NAME_NPATTR, EL_NAME_REPORT, EL_NAME_UI, EL_NAME_VATTR, EMPTY_ARRAY, EXPORT_MODE_IF_REFERENCED, EXPORT_MODE_LIST, EXPORT_MODE_NEVER, EXPORT_MODE_SINGLE, GENERATE_AS_DELIMITER_CHAR, PREFIX_L10N_KEY, RESERVED_TABLE_NAMES, SUFFIX_L10N_PLURAL_KEY

Fields inherited from interface de.ipcon.schema.StructuredEntityI

$01

Method Summary

Modifier and Type	Method and Description
void	addAttribute(AttributeI a)
void	flushCaches() Iterates over all ScriptedAttributes and triggers a flushCache on them.
java.util.List	getAttributeList() Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity.
EntityI	getBaseEntity()
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces() Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces(boolean checkBaseEntities)
static InstrumentingEntity	getInstance(InstrumentingSchemaI schema, EntityI entity)
InstrumentingSchemaI	getSchema()
AttributeI	getSingleAttribute(java.lang.String attName) Returns the AttributeI for the specified name, which must match either the plural or singular form.
java.util.List	getSubEntityList() return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity().
boolean	hasSubEntities()
boolean	isSubEntityOf(StructuredEntityI possibleSuperEntity) Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

Methods inherited from class de.ipcon.schema.EntityWrapper

addRelationObject, compareTo, getActionList, getClassesUpToPreviousEntity, getClazz, getCustomClassInModulesOrProject, getDefaultLookupCaseSensitive, getDefaultLookupProperty, getDefaultLookupStartingWith, getDefaultLookupSubstring, getDefaultSelectionFilter, getDefaultSortDirection, getDefaultSorting, getDefaultSortLevel, getDependentClasses, getDescription, getDiscriminator, getExport, getExport, getExports, getExports, getFolderName, getFQName, getFTSBoost, getGDPRPolicy, getGuiTip, getGuiTip, getGuiTipAsInt, getGuiTipAsInt, getIndexedForFTS, getL10nName, getL10nName, getL10nNameKey, getL10nNameVar, getL10nPlural, getL10nPlural, getL10nPluralKey, getL10nPluralVar, getLinkOnly, getModulePackages, getName, getOrCreateCustomClassInModulesOrProjectSet, getOrCreateModulePackagesSet, getPackage, getPackageAsPath, getPersistenceAspectClass, getPlural, getRelationObjects, getReportFontSizeBig, getReportFontSizeNormal, getReportOrientation, getReportTitle, getValue, getValueAsString, hasGuiTip, hasGuiTip, hasRelationObject, isCustom, isForbidDirectChanges, isLinkOnly, isLoadImmediate, isNoStreamResourceHistory, isPersistent, isStreamResource, isUserAbstract, newInstance, parametersToString, realEntity, removeRelationObject, setDiscriminator, setValue, setValueAsString, setValueAsString, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.schema.EntityI

findReachableAttrsWithType, findReachableAttrsWithType, getFromNodes, getIncomingEdges, getOutgoingEdges, getToNodes, getToolTipTextForAttribute, isCoreEntity, isCoreEntityClass, isCoreEntityPackageName, isCoreNative, isModuleNative, isPartOfModule, isProjectEntity, isProjectEntityClass, isProjectEntityPackageName, isProjectNative, toEntities

Methods inherited from interface de.ipcon.schema.StructuredEntityI

filterAttributes, getAllAttributeList, getAllAttributeList, getAllAttributeList, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListWithoutSubentities, getAllAttributeListWithoutSubentities, getAllCoreAttributeList, getAllModuleAttributeList, getAllProjectAttributeList, getAllSubEntityList, getAllSubEntityList, getAllSubEntityList, getAttChain, getAttChain, getAttribute, getAttribute, getPersistentBaseEntity, hasPersistentSubentity, isEffectivelyPersistent, isImplicitlyPersistent, isSubEntityOf

Methods inherited from interface de.ipcon.schema.BasicEntityI

getAttributeListByType, getAttributeListByType, getCurrentModuleOrProject, getRelations, isCustom

Field Detail

ARRAY_RELATION_POSTIFX

public static final java.lang.String ARRAY_RELATION_POSTIFX

See Also:

Constant Field Values

Method Detail

getInstance

public static InstrumentingEntity getInstance(InstrumentingSchemaI schema,
                                              EntityI entity)

getSchema

public InstrumentingSchemaI getSchema()

Specified by:

getSchema in interface BasicEntityI

Specified by:

getSchema in interface InstrumentingSchemaProviderI

Specified by:

getSchema in interface SchemaProviderI

Overrides:

getSchema in class EntityWrapper

Returns:

the InstrumentingSchemaI instance used by this object or null, if no Schema is available

getImplementedSchemaInterfaces

public java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces()

Description copied from interface: BasicEntityI

Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.

Specified by:

getImplementedSchemaInterfaces in interface BasicEntityI

Overrides:

getImplementedSchemaInterfaces in class EntityWrapper

Returns:

all implemented interfaces as SchemaInterfaceI objects.

getImplementedSchemaInterfaces

public java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces(boolean checkBaseEntities)

Specified by:

getImplementedSchemaInterfaces in interface BasicEntityI

Overrides:

getImplementedSchemaInterfaces in class EntityWrapper

getSingleAttribute

public AttributeI getSingleAttribute(java.lang.String attName)

Description copied from interface: BasicEntityI

Returns the AttributeI for the specified name, which must match either the plural or singular form.

Specified by:

getSingleAttribute in interface BasicEntityI

Overrides:

getSingleAttribute in class EntityWrapper

Parameters:

attName - The name to get the AttributeI for.

Returns:

The AttributeI for the specified name.

getAttributeList

public java.util.List getAttributeList()

Description copied from interface: BasicEntityI

Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity. Excludes inherited Attributes.

Specified by:

getAttributeList in interface BasicEntityI

Overrides:

getAttributeList in class EntityWrapper

Returns:

A List of attributes specific to this CBOEntity.

isSubEntityOf

public boolean isSubEntityOf(StructuredEntityI possibleSuperEntity)

Description copied from interface: StructuredEntityI

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

Specified by:

isSubEntityOf in interface StructuredEntityI

Overrides:

isSubEntityOf in class EntityWrapper

Parameters:

possibleSuperEntity - the EntityI to check

Returns:

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

getBaseEntity

public EntityI getBaseEntity()

Specified by:

getBaseEntity in interface StructuredEntityI

Overrides:

getBaseEntity in class EntityWrapper

Returns:

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

hasSubEntities

public boolean hasSubEntities()

Specified by:

hasSubEntities in interface StructuredEntityI

Overrides:

hasSubEntities in class EntityWrapper

Returns:

true if this EntityI has sub entities

getSubEntityList

public java.util.List getSubEntityList()

Description copied from interface: StructuredEntityI

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

Specified by:

getSubEntityList in interface StructuredEntityI

Overrides:

getSubEntityList in class EntityWrapper

addAttribute

public void addAttribute(AttributeI a)

flushCaches

public void flushCaches()

Iterates over all ScriptedAttributes and triggers a flushCache on them.