CBOEntity (MyTISM API Documentation)

java.lang.Object
- de.ipcon.schema.EntityDefinition
- - de.ipcon.schema.CBOEntity

All Implemented Interfaces:

BasicEntityI, EntityI, StructuredEntityI, DirectedGraphNodeI, OnlyToDirectedGraphNodeI, java.io.Serializable, java.lang.Comparable
```
public class CBOEntity
extends EntityDefinition
implements java.io.Serializable, java.lang.Comparable, EntityI
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface de.ipcon.schema.EntityI
  EntityI.EntityMatcher, EntityI.NonPersistentEdgeFilter

Field Summary
- 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_IGNORE_REVERSE_RELATIONS, 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_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_DB, EL_NAME_EXPORT, EL_NAME_FULLTEXT, 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, RESERVED_TABLE_NAMES

Constructor Summary

Constructors
Constructor and Description
`CBOEntity(CBOSchema _schema, electric.xml.Element _el)` Constructor for the CBOEntity class with scope SCOPE_LOCAL.
`CBOEntity(CBOSchema _schema, electric.xml.Element _el, int _scope)` Constructor for the CBOEntity class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDependents(java.lang.String s)` Adds the classes, given as comma separated `String`, to the dependent classes
`void`	`addRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object addMe)` Adds the given value to the relation specified via its attribute name in the given bo
`void`	`buildPass2()` 2nd pass of building - namely backrelation definition
`void`	`buildPass2ForAttribute(CBOAttribute cboatt)` make sures there are no clashes between scalars and many relations singular definitions
`void`	`checkAbstractHasConcreteSubs(java.util.Map all)` Checks if all abstract subentities of this `CBOEntity` has concrete subentities
`void`	`checkAmbiguousRelations()` Checks the relations of this `CBOEntity` for ambiguos problems
`void`	`checkAndInitHeritage(java.util.Map allEntityMap)` Sets the heritage for this `CBOEntity` (and its base entities).
`void`	`checkAttributeNaming()` Checks the attributes of the given `Map` for collisions of their name or singular with the attributes of this entity and its possible sub-entities.
`void`	`checkAttributeNaming(java.util.Map existingAttsArg)` Checks the attributes of the given `Map` for collisions of their name or singular with the attributes of this entity and its possible sub-entities.
`void`	`checkBackRelations()` Checks the back relations for this `CBOEntity`
`void`	`checkClass()` Entity classes must have a no-args constructor and may not be abstract.
`void`	`checkItemProperties()` Iterates over the attributes and checks if their ItemProperty actually points to an existing Attribute.
`EntityI`	`checkLoadImmediate(java.lang.Boolean _b)` Checks if loadImmediate of this `CBOEntity` (or its base entity) equals the given value
`void`	`checkRelations(java.util.Map all, int pass)` Checks the relations for this `CBOEntity` against the given `Map`
`void`	`checkSingularAbsenceForNTo1()` Checks if any n-1 relation has an explicit singular set in the schema-file and signals an AttributeDefinitionException in that case.
`int`	`compareTo(java.lang.Object o)` Comparable interface Compares this object with the specified object for order.
`void`	`config(electric.xml.Element elEntity, boolean fromConstructor)` Configures the current entity.
`CBOAttribute`	`declareAttribute(electric.xml.Element _el, boolean merge)` Creates a new `CBOAttribute` for the given `Element` and add it to this `CBOEntity`, if there isnt already defined an attribute with the same key
`java.util.List`	`getActionList()`
`java.util.Map`	`getActionMap()`
`java.util.List<java.lang.Class>`	`getClassesUpToPreviousEntity()`
`java.lang.Boolean`	`getDefaultLookupCaseSensitive()`
`java.lang.String`	`getDefaultLookupProperty()`
`java.lang.Boolean`	`getDefaultLookupStartingWith()`
`java.lang.Boolean`	`getDefaultLookupSubstring()`
`java.lang.String`	`getDefaultSortDirection(java.lang.String path)` Returns the default sorting direction of the `DefaultSortDefinitionEntry` found under the given path in the defaultSorting for the current EntityI, null otherwise.
`java.util.Map<java.lang.String,DefaultSortDefinitionEntry>`	`getDefaultSorting()` Returns the defaultSorting for the current EntityI, recursivly checking the base EntityI-s, too, until a defaultSorting is found.
`java.lang.Integer`	`getDefaultSortLevel(java.lang.String path)` Returns the default sorting level of the `DefaultSortDefinitionEntry` found under the given path in the defaultSorting for the current EntityI, null otherwise.
`java.util.List<java.lang.String>`	`getDependentClasses()`
`java.lang.Long`	`getDiscriminator()`
`ExportDefinitionEntry`	`getExport(java.lang.String name)` Returns the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise.
`ExportDefinitionEntry`	`getExport(java.lang.String name, boolean includeSuper)` Returns the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise.
`java.util.List<ExportDefinitionEntry>`	`getExports()` Returns a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities.
`java.util.List<ExportDefinitionEntry>`	`getExports(boolean includeSuper)` Returns a list of all ExportDefinitionEntry-s for this EntityI.
`java.lang.Float`	`getFTSBoost()`
`java.lang.String`	`getGenerateAs()`
`java.lang.String`	`getGenerateAsFQName()` Returns the full qualified name of this `CBOEntity`
`java.lang.String`	`getGenerateAsName()` Returns the name, which this `CBOEntity` was generated as
`java.lang.String`	`getGenerateAsPackage()` Returns the package, which this `CBOEntity` was generated
`java.lang.String`	`getGuiTip(java.lang.String tip)` Returns the gui tip for the given key from the current EntityI or one of its super EntityI-s.
`java.lang.String`	`getGuiTip(java.lang.String tip, boolean inherited)` Returns the gui tip for the given key from the current EntityI.
`int`	`getGuiTipAsInt(java.lang.String tip)` Returns the gui tip for the given key from the current entity or one of its super EntityI-s as int.
`int`	`getGuiTipAsInt(java.lang.String tip, boolean inherited)` Returns the gui tip for the given key from the current entity as int.
`java.util.Map`	`getGuiTips()`
`java.lang.Boolean`	`getIndexedForFTS()`
`java.util.Collection<Initialdata>`	`getInitialdata()`
`java.lang.String`	`getL10nName()` Returns the translated name for the current EntityI using L10nBundles
`java.lang.String`	`getL10nName(boolean _returnKeyWhenNotFound)` Returns the translated name for the current EntityI using L10nBundles
`java.lang.String`	`getL10nNameKey()` Returns an L10n message key for the name of the current EntityI without spaces and not permitted characters.
`java.lang.String`	`getL10nNameVar()` Returns the L10n variable for the name of the current EntityI
`java.lang.String`	`getL10nPlural()` Returns the translated name for the current EntityI as plural using L10nBundles
`java.lang.String`	`getL10nPlural(boolean _returnKeyWhenNotFound)` Returns the translated singular name for the current EntityI as plural using L10nBundles
`java.lang.String`	`getL10nPluralKey()` Returns an L10n message key for the name of the current EntityI as plural without spaces and not permitted characters
`java.lang.String`	`getL10nPluralVar()` Returns the L10n variable for the name of the current EntityI as plural
`java.lang.Boolean`	`getLinkOnly()` Checks if the linkOnly-flag is set for this `EntityI` or one of its base EntityI-s.
`java.lang.Class`	`getPersistenceAspectClass()` Returns the generateAs-class for the current EntityI
`java.util.HashSet`	`getRefs()`
`java.util.Map`	`getRelationObjects(java.lang.Object bo, java.lang.String attr)` Returns a map containing the relation for a single attribute of a bo of this `EntityI`
`java.lang.Integer`	`getReportFontSizeBig()`
`java.lang.Integer`	`getReportFontSizeNormal()`
`java.lang.String`	`getReportOrientation()`
`java.lang.String`	`getReportTitle()`
`int`	`getScope()`
`java.lang.String`	`getSerializationRelevantDescription()` Returns the serialization relevant description for this `CBOEntity` The description will be calculated by concatinating relevant informations of this `CBOEntity`, means the full qualified name, the base entity, the attributes,...
`java.lang.String`	`getSerializationRelevantDiff(EntityI another)` Returns the serialization relevant difference between a given `EntityI` and this `CBOEntity`, while the given `EntityI` will be taken as the "newer" schema
`long`	`getSerialVersionUID()` Returns the serial version unique ID for this `CBOEntity` by using only the first 8 digits from a SHA-message digest of the serialization relevant description of this `CBOEntity`
`EntityToStringWrapper`	`getToStringWrapper()` Returns the `EntityToStringWrapper` for this `CBOEntity`
`java.lang.Object`	`getValue(java.lang.Object o, AttributeI[] attchain)` Deprecated.
`java.lang.Object`	`getValue(java.lang.Object bo, java.lang.String attr)` Returns the value contained in the given BO and reached via the given attPath.
`java.lang.String`	`getValueAsString(java.lang.Object o, AttributeI[] attchain)` Deprecated.
`java.lang.String`	`getValueAsString(java.lang.Object bo, java.lang.String attr)` Returns the value contained in the given BO and reached via the given attPath as String.
`java.lang.String`	`getVersionRelevantDescription()` Returns the version relevant description for this `CBOEntity` by concatinating relevant informations of this `CBOEntity` as `String`
`boolean`	`hasGuiTip(java.lang.String tip)` Checks if the current EntityI or one of its super EntityI-s has a gui tip with the given key.
`boolean`	`hasGuiTip(java.lang.String tip, boolean inherited)` Checks if the current EntityI has a gui tip with the given key.
`boolean`	`hasRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object hasMe)` Returns `true` if the given object is part of the relation specified via its attribute name in the given bo
`void`	`info(electric.xml.Element _el, java.lang.String _msg)` Convenience method for logging an info with element prefix (log info messages)
`void`	`info(java.lang.String _msg)` Convenience method for info(_el=Element,_msg=String) with the el of this `CBOEntity` as parameter
`boolean`	`isForbidDirectChanges()`
`boolean`	`isGenerate()`
`boolean`	`isIgnoreReverseRelations()` Returns if the flag for ignoring reverse relations is set to this `CBOEntity` (or his base entity)
`boolean`	`isLinkOnly()` Checks if the linkOnly-flag is set for this `EntityI` or one of its base EntityI-s.
`boolean`	`isLoadImmediate()`
`boolean`	`isLocal()` Checks if the scope for this `CBOEntity` is set to local scope
`boolean`	`isLowInstanceCount()` Returns the boolean value of lowInstanceCount if set, if lowInstanceCount isnt set it will look for lowInstanceCount of the baseEntity too.
`boolean`	`isMapping()`
`boolean`	`isNoAbstractWarning()`
`boolean`	`isNoStreamResourceHistory()`
`boolean`	`isRegenerated()`
`boolean`	`isStreamResource()`
`void`	`releaseDefinitionSource()` Cleans the xml definition from all attributes of the current Entity
`void`	`removeRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object removeMe)` Removes the given object from the relation specified via its attribute name in the given bo
`void`	`setActionList(java.util.List $67)`
`void`	`setActionMap(java.util.Map $66)`
`void`	`setDependentClasses(java.util.List<java.lang.String> $70)`
`void`	`setDiscriminator(java.lang.Long id)` Sets the Discriminator (i.e. the BOT Id) for this `EntityI`
`void`	`setFTSBoost(java.lang.Float $79)`
`void`	`setGenerate(boolean $63)`
`void`	`setGenerateAs(java.lang.String $69)`
`void`	`setGuiTips(java.util.Map $71)`
`void`	`setIndexedForFTS(java.lang.Boolean $78)`
`void`	`setLinkOnly(java.lang.Boolean _linkOnly)` Sets the linkOnly flag for this `CBOEntity` to the given value.
`void`	`setMapping(boolean $65)`
`void`	`setNoAbstractWarning(boolean $64)`
`void`	`setNoStreamResourceHistory(boolean $73)`
`void`	`setRefs(java.util.HashSet $68)`
`void`	`setRegenerated(boolean $61)`
`void`	`setReportFontSizeBig(java.lang.Integer $77)`
`void`	`setReportFontSizeNormal(java.lang.Integer $76)`
`void`	`setReportOrientation(java.lang.String $75)`
`void`	`setReportTitle(java.lang.String $74)`
`void`	`setScope(int $62)`
`void`	`setStreamResource(boolean $72)`
`void`	`setValue(java.lang.Object bo, java.lang.String attr, java.lang.Object value)` Sets the given value in the given bo using the given attPath.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String attr, java.lang.String value)` Sets the given value as `String` to the given bo using the given attPath.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String attr, java.lang.String value, boolean _checkConstraints)` Sets the given value as `String` in the given bo using the given attPath.
`java.lang.String`	`toString()`
`void`	`warn(electric.xml.Element _el, java.lang.String _msg)` Convenience method for logging an warning with element prefix (log debug messages)
`void`	`warn(java.lang.String _msg)` Convenience method for warn(_el=Element,_msg=String) with the el of this `CBOEntity` as parameter

Methods inherited from class de.ipcon.schema.EntityDefinition
addAttribute, asXMLElement, checkDescription, checkValidSqlName, equals, getAllAttributeMap, getAttributeAllMap, getAttributeDefinitions, getAttributeList, getAttributeMap, getBase, getBaseEntity, getClazz, getDescription, getEl, getFolderName, getFQName, getFrappingAttributes, getName, getNonPersistentAttributes, getPackage, getPlural, getSchema, getSingleAttribute, getSqlName, getSqlName, getSubEntityList, hashCode, hasSubEntities, initCaches, isCustom, isPersistent, isUserAbstract, of, of, of, of, of, setAllAttributeMap, setAttributeAllMap, setAttributeDefinitions, setAttributeList, setAttributeMap, setBase, setBaseEntity, setClazz, setCustom, setDescription, setEl, setFolderName, setName, setPersistent, setPlural, setSchema, setSqlName, setSqlName, setSubEntityList, setUserAbstract, writeSchemaDefinition

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.schema.EntityI
findReachableAttrsWithType, findReachableAttrsWithType, getFQName, getFromNodes, getIncomingEdges, getOutgoingEdges, getPackage, getToNodes, getToolTipTextForAttribute, parametersToString, toEntities

Methods inherited from interface de.ipcon.schema.BasicEntityI
getAttributeList, getAttributeListByType, getAttributeListByType, getClazz, getDescription, getFolderName, getName, getPlural, getRelations, getSchema, getSingleAttribute, isCustom, isPersistent, isUserAbstract, newInstance

- Constructor Detail
  - CBOEntity
```
public CBOEntity(CBOSchema _schema,
                 electric.xml.Element _el)
```
    Constructor for the CBOEntity class with scope SCOPE_LOCAL.
    
    Parameters:
    
    _schema - The schema for this entity.
    
    _el - The Element for this entity.
  - CBOEntity
```
public CBOEntity(CBOSchema _schema,
                 electric.xml.Element _el,
                 int _scope)
```
    Constructor for the CBOEntity class.
    
    Parameters:
    
    _schema - The schema for this entity.
    
    _el - The Element for this entity.
    
    _scope - The scope for this entity.
- Method Detail
  - getInitialdata
```
public java.util.Collection<Initialdata> getInitialdata()
```
  - getIndexedForFTS
```
public java.lang.Boolean getIndexedForFTS()
```
    Specified by:
    
    getIndexedForFTS in interface EntityI
    
    Returns:
    
    Boolean.TRUE if this EntityI or any of its super-EntityI-s is indexed for fulltext search.
  - isForbidDirectChanges
```
public boolean isForbidDirectChanges()
```
    Specified by:
    
    isForbidDirectChanges in interface EntityI
    
    Returns:
    
    true if direct changes to objects with this EntityI are forbidden
  releaseDefinitionSource public void releaseDefinitionSource() Cleans the xml definition from all attributes of the current Entity getL10nNameKey public java.lang.String getL10nNameKey() Description copied from interface: EntityI Returns an L10n message key for the name of the current EntityI without spaces and not permitted characters. Specified by: getL10nNameKey in interface EntityI Returns: L10n message key for the name of the current EntityI getL10nNameVar public java.lang.String getL10nNameVar() Description copied from interface: EntityI Returns the L10n variable for the name of the current EntityI Specified by: getL10nNameVar in interface EntityI Returns: L10n variable for the name of the current EntityI getL10nName public java.lang.String getL10nName() Description copied from interface: EntityI Returns the translated name for the current EntityI using L10nBundles Specified by: getL10nName in interface EntityI Returns: the translated name for the current EntityI getL10nName public java.lang.String getL10nName(boolean _returnKeyWhenNotFound) Description copied from interface: EntityI Returns the translated name for the current EntityI using L10nBundles Specified by: getL10nName in interface EntityI Parameters: _returnKeyWhenNotFound - if true the key will be returned if key couldnt be translated Returns: the translated name for the current EntityI getL10nPluralKey public java.lang.String getL10nPluralKey() Description copied from interface: EntityI Returns an L10n message key for the name of the current EntityI as plural without spaces and not permitted characters Specified by: getL10nPluralKey in interface EntityI Returns: plural L10n message key for the current entity as plural getL10nPluralVar public java.lang.String getL10nPluralVar() Description copied from interface: EntityI Returns the L10n variable for the name of the current EntityI as plural Specified by: getL10nPluralVar in interface EntityI Returns: L10n variable for the name of the current EntityI as plural getL10nPlural public java.lang.String getL10nPlural() Description copied from interface: EntityI Returns the translated name for the current EntityI as plural using L10nBundles Specified by: getL10nPlural in interface EntityI Returns: the translated name for the current EntityI as plural getL10nPlural public java.lang.String getL10nPlural(boolean _returnKeyWhenNotFound) Description copied from interface: EntityI Returns the translated singular name for the current EntityI as plural using L10nBundles Specified by: getL10nPlural in interface EntityI Parameters: _returnKeyWhenNotFound - if true the key will be returned if key couldnt be translated Returns: the translated name for the current EntityI as plural getPersistenceAspectClass public java.lang.Class getPersistenceAspectClass() Description copied from interface: EntityI Returns the generateAs-class for the current EntityI Specified by: getPersistenceAspectClass in interface EntityI Returns: the generateAs-class for the current EntityI toString public java.lang.String toString() Specified by: toString in interface EntityI Overrides: toString in class java.lang.Object Returns: a String containing all information about the current EntityI config public void config(electric.xml.Element elEntity, boolean fromConstructor) Configures the current entity. Parameters: elEntity - The Element for this entity. fromConstructor - Indicates whether this method is called by the constructor. declareAttribute public CBOAttribute declareAttribute(electric.xml.Element _el, boolean merge) Creates a new CBOAttribute for the given Element and add it to this CBOEntity, if there isnt already defined an attribute with the same key Parameters: _el - the Element to declare CBOAttribute for merge - seems to be unused here Returns: the declared (and added!) CBOAttribute Throws: EntityDefinitionException - if an Attribute with the same key then the Element is already defined addDependents public void addDependents(java.lang.String s) Adds the classes, given as comma separated String, to the dependent classes Parameters: s - the classes to add as comma separated String isLocal public boolean isLocal() Checks if the scope for this CBOEntity is set to local scope Returns: true if the scope is set to local scope getClassesUpToPreviousEntity public java.util.List<java.lang.Class> getClassesUpToPreviousEntity() Specified by: getClassesUpToPreviousEntity in interface EntityI Returns: a list of all classes that exist between this Entity and its base EntityI isIgnoreReverseRelations public boolean isIgnoreReverseRelations() Returns if the flag for ignoring reverse relations is set to this CBOEntity (or his base entity) Returns: true if the flag is set to this CBOEntity (or his base entity) 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 Parameters: id - the id to set as discriminator getSerialVersionUID public long getSerialVersionUID() Returns the serial version unique ID for this CBOEntity by using only the first 8 digits from a SHA-message digest of the serialization relevant description of this CBOEntity Returns: the serial version unique ID for this CBOEntity isLoadImmediate public boolean isLoadImmediate() Specified by: isLoadImmediate in interface EntityI Returns: the boolean value of loadImmediate for this EntityI, or false if loadImmediate wasn't set and couldn't be retrieved from a base entity getLinkOnly public java.lang.Boolean getLinkOnly() Description copied from interface: EntityI Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s. If the linkOnly-flag is set for a base EntityI, as a side-effect it will be set for this EntityI too! Specified by: getLinkOnly in interface EntityI Returns: Boolean.TRUE if the linkOnly-flag is set isLinkOnly public boolean isLinkOnly() Description copied from interface: EntityI Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s. If the linkOnly-flag is set for a base EntityI, as a side-effect it will be set for this EntityI too! Specified by: isLinkOnly in interface EntityI Returns: true if the linkOnly-flag is set setLinkOnly public void setLinkOnly(java.lang.Boolean _linkOnly) Sets the linkOnly flag for this CBOEntity to the given value. Parameters: _linkOnly - The value to set for the linkOnly flag. getGuiTip public java.lang.String getGuiTip(java.lang.String tip) Description copied from interface: EntityI Returns the gui tip for the given key from the current EntityI or one of its super EntityI-s. Specified by: getGuiTip in interface EntityI Parameters: tip - the key for the tip to return Returns: the gui tip for the given key getGuiTip public java.lang.String getGuiTip(java.lang.String tip, boolean inherited) Description copied from interface: EntityI Returns the gui tip for the given key from the current EntityI. If parameter inherited is passed as true the super EntityI-s are checked recursively, too. Specified by: getGuiTip in interface EntityI Parameters: tip - the key for the tip to return inherited - a boolean indicating whether to check for inherited tips too Returns: the gui tip for the given key getGuiTipAsInt public int getGuiTipAsInt(java.lang.String tip) Description copied from interface: EntityI Returns the gui tip for the given key from the current entity or one of its super EntityI-s as int. Specified by: getGuiTipAsInt in interface EntityI Parameters: tip - the key for the tip to return Returns: the gui tip as int for the given key getGuiTipAsInt public int getGuiTipAsInt(java.lang.String tip, boolean inherited) Description copied from interface: EntityI Returns the gui tip for the given key from the current entity as int. If parameter inherited is passed as true the super EntityI-s are checked recursively, too. Specified by: getGuiTipAsInt in interface EntityI Parameters: tip - the key for the tip to return inherited - a boolean indicating whether to check for inherited tips too Returns: the gui tip as int for the given key hasGuiTip public boolean hasGuiTip(java.lang.String tip) Description copied from interface: EntityI Checks if the current EntityI or one of its super EntityI-s has a gui tip with the given key. Specified by: hasGuiTip in interface EntityI Parameters: tip - the key to check Returns: true if a tip with the given key exists hasGuiTip public boolean hasGuiTip(java.lang.String tip, boolean inherited) Description copied from interface: EntityI Checks if the current EntityI has a gui tip with the given key. If parameter inherited is passed as true the super EntityI-s are checked recursively, too. Specified by: hasGuiTip in interface EntityI Parameters: tip - the key to check inherited - a boolean indicating whether to check for inherited tips too Returns: true if a tip with the given key exists getDefaultSorting public java.util.Map<java.lang.String,DefaultSortDefinitionEntry> getDefaultSorting() Description copied from interface: EntityI Returns the defaultSorting for the current EntityI, recursivly checking the base EntityI-s, too, until a defaultSorting is found. Specified by: getDefaultSorting in interface EntityI Returns: the defaultSorting for the current EntityI as Map getDefaultSortDirection public java.lang.String getDefaultSortDirection(java.lang.String path) Description copied from interface: EntityI Returns the default sorting direction of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise. Specified by: getDefaultSortDirection in interface EntityI Parameters: path - the path of the DefaultSortDefinitionEntry in defaultSorting Returns: the default sorting direction of the DefaultSortDefinitionEntry with the given path as String getDefaultSortLevel public java.lang.Integer getDefaultSortLevel(java.lang.String path) Description copied from interface: EntityI Returns the default sorting level of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise. Specified by: getDefaultSortLevel in interface EntityI Parameters: path - the path of the DefaultSortDefinitionEntry in defaultSorting Returns: the default sorting level of the DefaultSortDefinitionEntry with the given path as Integer getDefaultLookupProperty public java.lang.String getDefaultLookupProperty() Specified by: getDefaultLookupProperty in interface EntityI Returns: the defaultLookupProperty of the current EntityI or the first one of its base Entity-s. getDefaultLookupSubstring public java.lang.Boolean getDefaultLookupSubstring() Specified by: getDefaultLookupSubstring in interface EntityI Returns: Boolean.TRUE if this EntityI or one of its base EntityI-s has a default lookup String getDefaultLookupStartingWith public java.lang.Boolean getDefaultLookupStartingWith() Specified by: getDefaultLookupStartingWith in interface EntityI Returns: Boolean.TRUE if this EntityI or one of its base EntityI-s only allows lookup for prefixes by default getDefaultLookupCaseSensitive public java.lang.Boolean getDefaultLookupCaseSensitive() Specified by: getDefaultLookupCaseSensitive in interface EntityI Returns: Boolean.TRUE if this EntityI or one of its base EntityI-s performs lookups case-insensitive by default getGenerateAsName public java.lang.String getGenerateAsName() Returns the name, which this CBOEntity was generated as Returns: the name, which this CBOEntity was generated as getGenerateAsPackage public java.lang.String getGenerateAsPackage() Returns the package, which this CBOEntity was generated Returns: the package, which this CBOEntity was generated getGenerateAsFQName public java.lang.String getGenerateAsFQName() Returns the full qualified name of this CBOEntity Returns: the full qualified name of this CBOEntity isStreamResource public boolean isStreamResource() Specified by: isStreamResource in interface EntityI Returns: true if the current EntityI or one of its base EntityIs is a stream ressource isNoStreamResourceHistory public boolean isNoStreamResourceHistory() Specified by: isNoStreamResourceHistory in interface EntityI Returns: true if the current EntityI or one of its base EntityIs was told to keep no history of its stream ressource when a stream resource is replaced by a different one isLowInstanceCount public boolean isLowInstanceCount() Returns the boolean value of lowInstanceCount if set, if lowInstanceCount isnt set it will look for lowInstanceCount of the baseEntity too. Returns: the boolean value of lowInstanceCount, or false if lowInstanceCount wasnt set and couldn't be retrieved from the base entity getReportTitle public java.lang.String getReportTitle() Specified by: getReportTitle in interface EntityI Returns: the report title, or null if report title wasn't set and couldn't be retrieved from a base entity getReportOrientation public java.lang.String getReportOrientation() Specified by: getReportOrientation in interface EntityI Returns: the report orientation, or null if report orientation wasn't set and couldn't be retrieved from a base entity getReportFontSizeNormal public java.lang.Integer getReportFontSizeNormal() Specified by: getReportFontSizeNormal in interface EntityI Returns: the report's normal font size, or null if the report's normal font size wasn't set and couldn't be retrieved from a base entity getReportFontSizeBig public java.lang.Integer getReportFontSizeBig() Specified by: getReportFontSizeBig in interface EntityI Returns: the report's big font size, or null if the report's big font size wasn't set and couldn't be retrieved from a base entity getExports public java.util.List<ExportDefinitionEntry> getExports() Description copied from interface: EntityI Returns a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities. Specified by: getExports in interface EntityI Returns: a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities. getExports public java.util.List<ExportDefinitionEntry> getExports(boolean includeSuper) Description copied from interface: EntityI Returns a list of all ExportDefinitionEntry-s for this EntityI. Specified by: getExports in interface EntityI Parameters: includeSuper - a boolean which denotes if also exports from all super-entities shall be included. Returns: a list of all ExportDefinitionEntry-s for this EntityI. getExport public ExportDefinitionEntry getExport(java.lang.String name) Description copied from interface: EntityI Returns the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise. Specified by: getExport in interface EntityI Parameters: name - the name of the ExportDefinitionEntry to return Returns: the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise. getExport public ExportDefinitionEntry getExport(java.lang.String name, boolean includeSuper) Description copied from interface: EntityI Returns the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise. Specified by: getExport in interface EntityI Parameters: name - the name of the ExportDefinitionEntry to return includeSuper - a boolean which denotes if also exports from all super-entities shall be searched. Returns: the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise. getValue public java.lang.Object getValue(java.lang.Object bo, java.lang.String attr) Description copied from interface: EntityI Returns the value contained in the given BO and reached via the given attPath. If the attribute is transient the value will be fetched from the transient properties of the BO. Specified by: getValue in interface EntityI Parameters: bo - the bo to get the value from attr - the path to the attribute to get the value from Returns: the attribue value getValueAsString public java.lang.String getValueAsString(java.lang.Object bo, java.lang.String attr) Description copied from interface: EntityI Returns the value contained in the given BO and reached via the given attPath as String. If the attribute is transient the value will be fetched from the transient properties of the BO. Specified by: getValueAsString in interface EntityI Parameters: bo - the bo to get the value from attr - the path to the attribute to get the value from Returns: the attribue value as String setValue public void setValue(java.lang.Object bo, java.lang.String attr, java.lang.Object value) Description copied from interface: EntityI Sets the given value in the given bo using the given attPath. Specified by: setValue in interface EntityI Parameters: bo - the bo to set the given value in attr - the path to the attribute to set value - the value to set setValueAsString public void setValueAsString(java.lang.Object bo, java.lang.String attr, java.lang.String value) Description copied from interface: EntityI Sets the given value as String to the given bo using the given attPath. Does check for constraints before setting the value. Specified by: setValueAsString in interface EntityI Parameters: bo - the bo to set the given value in attr - the path to the attribute to set value - the value to set as String setValueAsString public void setValueAsString(java.lang.Object bo, java.lang.String attr, java.lang.String value, boolean _checkConstraints) Description copied from interface: EntityI Sets the given value as String in the given bo using the given attPath. Specified by: setValueAsString in interface EntityI Parameters: bo - the bo to set the given value in attr - the path to the attribute to set value - the value to set as String _checkConstraints - do check for constraints before setting value getRelationObjects public java.util.Map getRelationObjects(java.lang.Object bo, java.lang.String attr) Description copied from interface: EntityI Returns a map containing the relation for a single attribute of a bo of this EntityI Specified by: getRelationObjects in interface EntityI Parameters: bo - the bo to get relations for attr - the attribute to get relations for Returns: the relations map for the attribute hasRelationObject public boolean hasRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object hasMe) Description copied from interface: EntityI Returns true if the given object is part of the relation specified via its attribute name in the given bo Specified by: hasRelationObject in interface EntityI Parameters: bo - the bo to check the relational object on the attribute attr - the name of the attribute to check the relational object on hasMe - the relational object to check addRelationObject public void addRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object addMe) Description copied from interface: EntityI Adds the given value to the relation specified via its attribute name in the given bo Specified by: addRelationObject in interface EntityI Parameters: bo - the bo to add the relational object to the attribute attr - the name of the attribute to add the relational object to addMe - the relational object to add to the attribute on the bo removeRelationObject public void removeRelationObject(java.lang.Object bo, java.lang.String attr, java.lang.Object removeMe) Description copied from interface: EntityI Removes the given object from the relation specified via its attribute name in the given bo Specified by: removeRelationObject in interface EntityI Parameters: bo - the bo to remove the relational object from the attribute attr - the name of the attribute to remove the relational object from removeMe - the relational object to remove getValue public java.lang.Object getValue(java.lang.Object o, AttributeI[] attchain) Deprecated. Returns the value of a given attribute in a given attribute chain Parameters: o - the attribute to get the value for attchain - the attribute chain to get the value for the given attribute from Returns: the value of the given attribute in the given attribute chain getValueAsString public java.lang.String getValueAsString(java.lang.Object o, AttributeI[] attchain) Deprecated. Returns the value of a given attribute in a given attribute chain as String Parameters: o - the attribute to get the value for attchain - the attribute chain to get the value for the given attribute from Returns: the value of the given attribute in the given attribute chain as String buildPass2 public void buildPass2() 2nd pass of building - namely backrelation definition buildPass2ForAttribute public void buildPass2ForAttribute(CBOAttribute cboatt) make sures there are no clashes between scalars and many relations singular definitions Parameters: cboatt - the CBOAttribute to check clashes for Throws: AttributeDefinitionException - if the given CBOAttribute was already defined for this CBOEntity as attribute or singular of attribute checkClass public void checkClass() Entity classes must have a no-args constructor and may not be abstract. This is a restriction due to the deserialization method in Castor, which needs to instantiate super classes. This method is called in CBOSchema#verify() during building and warns early. checkRelations public void checkRelations(java.util.Map all, int pass) Checks the relations for this CBOEntity against the given Map Parameters: all - the Map to check relations against pass - the passing of this check Throws: AttributeDefinitionException - if an Entity was unknown or if an virtual or non-persistent attribute was defined n-m (only n-1 or 1-n allowed) if the backrelation of an attribute has not the same persistence or readonly setting if the relationtypes dont match each other if backrelation isn''t available checkBackRelations public void checkBackRelations() Checks the back relations for this CBOEntity Throws: AttributeDefinitionException - if an attribute has no backrelation checkAmbiguousRelations public void checkAmbiguousRelations() Checks the relations of this CBOEntity for ambiguos problems Throws: IRuntimeException - if relations and backrelations of an attribute dont match each other checkAndInitHeritage public void checkAndInitHeritage(java.util.Map allEntityMap) Sets the heritage for this CBOEntity (and its base entities). Parameters: allEntityMap - A Map to look for the base classes. Throws: EntityDefinitionException - If a base entity couldn't be found in the given Map. checkAbstractHasConcreteSubs public void checkAbstractHasConcreteSubs(java.util.Map all) Checks if all abstract subentities of this CBOEntity has concrete subentities Parameters: all - seems to be unused here checkAttributeNaming public void checkAttributeNaming() Checks the attributes of the given Map for collisions of their name or singular with the attributes of this entity and its possible sub-entities. If the name of an attribute matches the name of another attribute (possibly in a sub-entity), this will be a problem as the entity (or at least the sub-entity) would have two attributes with the same name. This is not possible as the column names in the database would be the same, which is not allowed. Also, the generated set and get methods would bear the same name, which is not possible. If the singular of an attribute (which should be a many relation then, though this is not checked here) matches the singular of another attribute (possibly in a sub-entity), this will cause problems because the generated add and remove methods would then bear the same name. While technically this might not be a problem in all cases (as it might still be possible to distinguish them by their argument types), to avoid confusion, this is also not allowed. Additionally to name vs. name and singular vs. singular checks, this method also checks the names vs. the singulars. (Note: TT 2021-11-16: I could not think of a reason for this. What clash could occur in this case?) Throws: AttributeDefinitionException - If the name or singular of a given attribute matches one of the name or singular (might also be a "name = singular" collision!) of an attribute of this entity. checkAttributeNaming public void checkAttributeNaming(java.util.Map existingAttsArg) Checks the attributes of the given Map for collisions of their name or singular with the attributes of this entity and its possible sub-entities. If the name of an attribute matches the name of another attribute (possibly in a sub-entity), this will be a problem as the entity (or at least the sub-entity) would have two attributes with the same name. This is not possible as the column names in the database would be the same, which is not allowed. Also, the generated set and get methods would bear the same name, which is not possible. If the singular of an attribute (which should be a many relation then, though this is not checked here) matches the singular of another attribute (possibly in a sub-entity), this will cause problems because the generated add and remove methods would then bear the same name. While technically this might not be a problem in all cases (as it might still be possible to distinguish them by their argument types), to avoid confusion, this is also not allowed. Additionally to name vs. name and singular vs. singular checks, this method also checks the names vs. the singulars. (Note: TT 2021-11-16: I could not think of a reason for this. What clash could occur in this case?) Parameters: existingAttsArg - A Map with already existing attributes to check. Throws: AttributeDefinitionException - If the name or singular of a given attribute matches one of the name or singular (might also be a "name = singular" collision!) of an attribute of this entity. checkSingularAbsenceForNTo1 public void checkSingularAbsenceForNTo1() throws AttributeDefinitionException Checks if any n-1 relation has an explicit singular set in the schema-file and signals an AttributeDefinitionException in that case. Throws: AttributeDefinitionException - if relationType is 'n-1' and explicitSingular is not '' checkLoadImmediate public EntityI checkLoadImmediate(java.lang.Boolean _b) Checks if loadImmediate of this CBOEntity (or its base entity) equals the given value Parameters: _b - the value to check equality for Returns: this CBOEntity if both values are equal, else returns null checkItemProperties public void checkItemProperties() Iterates over the attributes and checks if their ItemProperty actually points to an existing Attribute. Otherwise, the calling code will throw an AttributeDefinitionException. compareTo public int compareTo(java.lang.Object o) Comparable interface Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Specified by: compareTo in interface java.lang.Comparable Parameters: o - the Object to compare this CBOEntity Returns: a negative integer, zero, or a positive integer bases on the result of the comparison getSerializationRelevantDescription public java.lang.String getSerializationRelevantDescription() Returns the serialization relevant description for this CBOEntity The description will be calculated by concatinating relevant informations of this CBOEntity, means the full qualified name, the base entity, the attributes,... Returns: the serialization relevant description for this CBOEntity getSerializationRelevantDiff public java.lang.String getSerializationRelevantDiff(EntityI another) Returns the serialization relevant difference between a given EntityI and this CBOEntity, while the given EntityI will be taken as the "newer" schema Parameters: another - the EntityI to get the serialization relevant difference Returns: the serialization relevant difference of the given EntityI and this CBOEntity getVersionRelevantDescription public java.lang.String getVersionRelevantDescription() Returns the version relevant description for this CBOEntity by concatinating relevant informations of this CBOEntity as String Returns: the version relevant description for this CBOEntity getToStringWrapper public EntityToStringWrapper getToStringWrapper() Returns the EntityToStringWrapper for this CBOEntity Returns: the EntityToStringWrapper for this CBOEntity info public void info(java.lang.String _msg) Convenience method for info(_el=Element,_msg=String) with the el of this CBOEntity as parameter Parameters: _msg - the message to log info public void info(electric.xml.Element _el, java.lang.String _msg) Convenience method for logging an info with element prefix (log info messages) Parameters: _el - the element to get a messageprefix for _msg - the message to log warn public void warn(java.lang.String _msg) Convenience method for warn(_el=Element,_msg=String) with the el of this CBOEntity as parameter Parameters: _msg - the message to log warn public void warn(electric.xml.Element _el, java.lang.String _msg) Convenience method for logging an warning with element prefix (log debug messages) Parameters: _el - the element to get a messageprefix for _msg - the message to log isRegenerated public boolean isRegenerated() setRegenerated public void setRegenerated(boolean $61) getScope public int getScope() setScope public void setScope(int $62) isGenerate public boolean isGenerate() setGenerate public void setGenerate(boolean $63) getDiscriminator public java.lang.Long getDiscriminator() Specified by: getDiscriminator in interface EntityI Returns: the discriminator (i.e. the BOT Id) for this EntityI isNoAbstractWarning public boolean isNoAbstractWarning() setNoAbstractWarning public void setNoAbstractWarning(boolean $64) isMapping public boolean isMapping() setMapping public void setMapping(boolean $65) getActionMap public java.util.Map getActionMap() setActionMap public void setActionMap(java.util.Map $66) getActionList public java.util.List getActionList() Specified by: getActionList in interface EntityI Returns: a List containing all possible CBOAction-s of this EntityI setActionList public void setActionList(java.util.List $67) getRefs public java.util.HashSet getRefs() setRefs public void setRefs(java.util.HashSet $68) getGenerateAs public java.lang.String getGenerateAs() setGenerateAs public void setGenerateAs(java.lang.String $69) getDependentClasses public java.util.List<java.lang.String> getDependentClasses() Specified by: getDependentClasses in interface EntityI Returns: a List containing all simple class names (file names excluding the filetype) of classes being dependent on this EntityI setDependentClasses public void setDependentClasses(java.util.List<java.lang.String> $70) getGuiTips public java.util.Map getGuiTips() setGuiTips public void setGuiTips(java.util.Map $71) setStreamResource public void setStreamResource(boolean $72) setNoStreamResourceHistory public void setNoStreamResourceHistory(boolean $73) setReportTitle public void setReportTitle(java.lang.String $74) setReportOrientation public void setReportOrientation(java.lang.String $75) setReportFontSizeNormal public void setReportFontSizeNormal(java.lang.Integer $76) setReportFontSizeBig public void setReportFontSizeBig(java.lang.Integer $77) setIndexedForFTS public void setIndexedForFTS(java.lang.Boolean $78) getFTSBoost public java.lang.Float getFTSBoost() Specified by: getFTSBoost in interface EntityI Returns: a Float indicating the fulltext search boost parameter for this EntityI setFTSBoost public void setFTSBoost(java.lang.Float $79)

Class CBOEntity

Nested Class Summary

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

Field Summary

Fields inherited from interface de.ipcon.schema.EntityI

Constructor Summary

Method Summary

Methods inherited from class de.ipcon.schema.EntityDefinition

Methods inherited from class java.lang.Object

Methods inherited from interface de.ipcon.schema.EntityI

Methods inherited from interface de.ipcon.schema.StructuredEntityI

Methods inherited from interface de.ipcon.schema.BasicEntityI

Constructor Detail

CBOEntity

CBOEntity

Method Detail

getInitialdata

getIndexedForFTS

isForbidDirectChanges

releaseDefinitionSource

getL10nNameKey

getL10nNameVar

getL10nName

getL10nName

getL10nPluralKey

getL10nPluralVar

getL10nPlural

getL10nPlural

getPersistenceAspectClass

toString

config

declareAttribute

addDependents

isLocal

getClassesUpToPreviousEntity

isIgnoreReverseRelations

setDiscriminator

getSerialVersionUID

isLoadImmediate

getLinkOnly

isLinkOnly

setLinkOnly

getGuiTip

getGuiTip

getGuiTipAsInt

getGuiTipAsInt

hasGuiTip

hasGuiTip

getDefaultSorting

getDefaultSortDirection

getDefaultSortLevel

getDefaultLookupProperty

getDefaultLookupSubstring

getDefaultLookupStartingWith

getDefaultLookupCaseSensitive

getGenerateAsName

getGenerateAsPackage

getGenerateAsFQName

isStreamResource

isNoStreamResourceHistory

isLowInstanceCount

getReportTitle

getReportOrientation

getReportFontSizeNormal

getReportFontSizeBig

getExports

getExports

getExport

getExport

getValue

getValueAsString

setValue

setValueAsString

setValueAsString

getRelationObjects

hasRelationObject

addRelationObject

removeRelationObject

getValue

getValueAsString