de.ipcon.schema

Class VirtualEntity

java.lang.Object

de.ipcon.schema.EntityWrapper

de.ipcon.schema.InstrumentingEntity

de.ipcon.schema.VirtualEntity

All Implemented Interfaces:

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

public class VirtualEntity
extends InstrumentingEntity

This class represents a virtual sub-entity of an InstrumentingEntity, which creates a distinct namespace for all virtual properties added directly to this namespace. This InstrumentingEntity shares the implementation clazz of the extended entity and falls back to it. It will, however, never be responsible generically for these. BO instances that want to use virtual entities have to provide basic support for it via the marker interface InstrumentingBO. Virtual Entities exist as long as its containing InstrumentingSchema exists and aren't shared between different Schema instances. As with other entities, the singular name needs to be unique in the containing Schema. Virtual Entities of Virtual Entities are possible.

Nested Class Summary

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

EntityI.EntityMatcher, EntityI.NonPersistentEdgeFilter

Field Summary

Fields inherited from class de.ipcon.schema.InstrumentingEntity

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
java.util.List<AttributeI>	getAttributeList() Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity.
InstrumentingEntity	getBaseEntity()
java.util.List<java.lang.String>	getDependentClasses()
java.lang.String	getL10nName() Returns the localized singular name of this entity.
java.lang.String	getL10nName(boolean returnKeyWhenNotFound) Returns the localized singular name of this entity, with configurable fallback behavior.
java.lang.String	getL10nNameKey() Returns the localization key for the singular name of this entity.
java.lang.String	getL10nNameVar() Returns a localizable String variable reference for the singular name of this entity.
java.lang.String	getL10nPlural() Returns the localized plural name of this entity.
java.lang.String	getL10nPlural(boolean returnKeyWhenNotFound) Returns the localized plural name of this entity, with configurable fallback behavior.
java.lang.String	getL10nPluralKey() Returns the localization key for the plural name of this entity.
java.lang.String	getL10nPluralVar() Returns a localizable String variable reference for the plural name of this entity.
java.lang.String	getName() Returns the name of this BasicEntityI instance.
java.lang.String	getPlural()
java.util.List<EntityI>	getSubEntityList() return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity().
boolean	hasSubEntities()
boolean	isCustom()
boolean	isSubEntityOf(StructuredEntityI possibleSuperEntity) Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.
static VirtualEntity	of(InstrumentingSchemaI schema, InstrumentingEntity extendsEntity, java.lang.String name)
void	setDiscriminator(java.lang.Long id) Sets the Discriminator (i.e. the BOT Id) for this EntityI
java.lang.String	toString()

Methods inherited from class de.ipcon.schema.InstrumentingEntity

addAttribute, flushCaches, getImplementedSchemaInterfaces, getInstance, getSchema, getSingleAttribute

Methods inherited from class de.ipcon.schema.EntityWrapper

addRelationObject, compareTo, getActionList, getClassesUpToPreviousEntity, getClazz, getCustomClassInModulesOrProject, getDefaultLookupCaseSensitive, getDefaultLookupProperty, getDefaultLookupStartingWith, getDefaultLookupSubstring, getDefaultSelectionFilter, getDefaultSortDirection, getDefaultSorting, getDefaultSortLevel, getDescription, getDiscriminator, getExport, getExport, getExports, getExports, getFolderName, getFQName, getFTSBoost, getGDPRPolicy, getGuiTip, getGuiTip, getGuiTipAsInt, getGuiTipAsInt, getIndexedForFTS, getLinkOnly, getModulePackages, getOrCreateCustomClassInModulesOrProjectSet, getOrCreateModulePackagesSet, getPackage, getPackageAsPath, getPersistenceAspectClass, getRelationObjects, getReportFontSizeBig, getReportFontSizeNormal, getReportOrientation, getReportTitle, getValue, getValueAsString, hasGuiTip, hasGuiTip, hasRelationObject, isForbidDirectChanges, isLinkOnly, isLoadImmediate, isNoStreamResourceHistory, isPersistent, isStreamResource, isUserAbstract, newInstance, parametersToString, realEntity, removeRelationObject, setValue, setValueAsString, setValueAsString, 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

Method Detail

of

public static VirtualEntity of(InstrumentingSchemaI schema,
                               InstrumentingEntity extendsEntity,
                               java.lang.String name)

getBaseEntity

public InstrumentingEntity getBaseEntity()

Specified by:

getBaseEntity in interface StructuredEntityI

Overrides:

getBaseEntity in class InstrumentingEntity

Returns:

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

getName

public java.lang.String getName()

Description copied from interface: BasicEntityI

Returns the name of this BasicEntityI instance. Can also be used for querying objects of that kind in OQL queries.

Specified by:

getName in interface BasicEntityI

Overrides:

getName in class EntityWrapper

Returns:

the name of this BasicEntityI instance.

getPlural

public java.lang.String getPlural()

Specified by:

getPlural in interface BasicEntityI

Overrides:

getPlural in class EntityWrapper

Returns:

the plural name of this BasicEntityI instance.

getL10nNameKey

public java.lang.String getL10nNameKey()

Description copied from interface: EntityI

Returns the localization key for the singular name of this entity. The key is typically constructed by prepending EntityI.PREFIX_L10N_KEY to a canonicalized version of the entity's name (obtained via L10n.stringToKey(getName())).

Specified by:

getL10nNameKey in interface EntityI

Overrides:

getL10nNameKey in class EntityWrapper

Returns:

The localization key for the entity's singular name.

getL10nNameVar

public java.lang.String getL10nNameVar()

Description copied from interface: EntityI

Returns a localizable String variable reference for the singular name of this entity. This reference is typically formatted as "$R{'KEY'}", where 'KEY' is the value obtained from EntityI.getL10nNameKey(). This format is typically used in UI or template systems to dynamically load localized strings.

Specified by:

getL10nNameVar in interface EntityI

Overrides:

getL10nNameVar in class EntityWrapper

Returns:

The localizable String variable reference for the entity's singular name.

getL10nName

public java.lang.String getL10nName()

Description copied from interface: EntityI

Returns the localized singular name of this entity. If no localization is found, the localization key itself is returned as a fallback. This method is a convenience wrapper for EntityI.getL10nName(boolean) with fallback enabled.

Specified by:

getL10nName in interface EntityI

Overrides:

getL10nName in class EntityWrapper

Returns:

The localized singular name of this entity.

getL10nName

public java.lang.String getL10nName(boolean returnKeyWhenNotFound)

Description copied from interface: EntityI

Returns the localized singular name of this entity, with configurable fallback behavior. This method typically uses L10n.msg(String, Object[], Object[], boolean, String) to retrieve the translation, passing this entity as a participant in the lookup path.

Specified by:

getL10nName in interface EntityI

Overrides:

getL10nName in class EntityWrapper

Parameters:

returnKeyWhenNotFound - If true, the localization key will be returned if no matching translation is found. If false, null is returned in that case.

Returns:

The localized singular name of this entity.

getL10nPluralKey

public java.lang.String getL10nPluralKey()

Description copied from interface: EntityI

Returns the localization key for the plural name of this entity. The key is typically constructed by combining EntityI.PREFIX_L10N_KEY, a canonicalized version of the entity's name, and EntityI.SUFFIX_L10N_PLURAL_KEY.

Specified by:

getL10nPluralKey in interface EntityI

Overrides:

getL10nPluralKey in class EntityWrapper

Returns:

The localization key for the entity's plural name.

getL10nPluralVar

public java.lang.String getL10nPluralVar()

Description copied from interface: EntityI

Returns a localizable String variable reference for the plural name of this entity. This reference is typically formatted as "$R{'KEY'}", where 'KEY' is the value obtained from EntityI.getL10nPluralKey(). This format is typically used in UI or template systems to dynamically load localized plural strings.

Specified by:

getL10nPluralVar in interface EntityI

Overrides:

getL10nPluralVar in class EntityWrapper

Returns:

The localizable String variable reference for the entity's plural name.

getL10nPlural

public java.lang.String getL10nPlural()

Description copied from interface: EntityI

Returns the localized plural name of this entity. If no localization is found, the localization key itself is returned as a fallback. This method is a convenience wrapper for EntityI.getL10nPlural(boolean) with fallback enabled.

Specified by:

getL10nPlural in interface EntityI

Overrides:

getL10nPlural in class EntityWrapper

Returns:

The localized plural name of this entity.

getL10nPlural

public java.lang.String getL10nPlural(boolean returnKeyWhenNotFound)

Description copied from interface: EntityI

Returns the localized plural name of this entity, with configurable fallback behavior. This method constructs the plural localization key dynamically (typically by combining EntityI.PREFIX_L10N_KEY, getName(), and EntityI.SUFFIX_L10N_PLURAL_KEY) and typically uses L10n.msg(String, Object[], Object[], boolean, String) to retrieve the translation, passing this entity as a participant in the lookup path.

Specified by:

getL10nPlural in interface EntityI

Overrides:

getL10nPlural in class EntityWrapper

Parameters:

returnKeyWhenNotFound - If true, the constructed localization key will be returned if no matching translation is found. If false, null is returned in that case.

Returns:

The localized plural name of this entity.

getAttributeList

public java.util.List<AttributeI> 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 InstrumentingEntity

Returns:

a list of ScriptedAttribute

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 InstrumentingEntity

Parameters:

possibleSuperEntity - the EntityI to check

Returns:

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

getSubEntityList

public java.util.List<EntityI> 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 InstrumentingEntity

hasSubEntities

public boolean hasSubEntities()

Specified by:

hasSubEntities in interface StructuredEntityI

Overrides:

hasSubEntities in class InstrumentingEntity

Returns:

true if this EntityI has sub entities

isCustom

public boolean isCustom()

Specified by:

isCustom in interface BasicEntityI

Overrides:

isCustom in class EntityWrapper

Returns:

false, because virtual entities by definition have no custom implementation class

getDependentClasses

public java.util.List<java.lang.String> getDependentClasses()

Specified by:

getDependentClasses in interface EntityI

Overrides:

getDependentClasses in class EntityWrapper

Returns:

a List containing all simple class names (file names excluding the filetype) of classes being dependent on this EntityI

setDiscriminator

public void setDiscriminator(java.lang.Long id)

Description copied from interface: EntityI

Sets the Discriminator (i.e. the BOT Id) for this EntityI

Specified by:

setDiscriminator in interface EntityI

Overrides:

setDiscriminator in class EntityWrapper

Parameters:

id - the id to set as discriminator

toString

public java.lang.String toString()

Specified by:

toString in interface EntityI

Overrides:

toString in class EntityWrapper

Returns:

a String containing all information about the current EntityI