AttributeWrapper (MyTISM API Documentation)

java.lang.Object
- de.ipcon.schema.AttributeWrapper

All Implemented Interfaces:

AttributeI, AttributeWithUIConfigurationI, BasicAttributeI, GraphEdgeI, java.lang.Comparable<java.lang.Object>

Direct Known Subclasses:

InstrumentingAttribute
```
public class AttributeWrapper
extends java.lang.Object
implements AttributeI
```

Field Summary
- Fields inherited from interface de.ipcon.schema.AttributeI
  ALLOWED_RELATION_TYPES, ATT_NAME_BACKNAME, ATT_NAME_CUSTOM_ITERATOR, ATT_NAME_CUSTOM_ITERATOR_NOT_CACHING, ATT_NAME_DB_COPY_POLICY, ATT_NAME_DB_INDEX_TYPE, ATT_NAME_DB_INDEXED, ATT_NAME_DB_RELATION_DISCRIMINATOR, ATT_NAME_DB_UNIQUE, ATT_NAME_DEFAULT, ATT_NAME_DEPENDENT, ATT_NAME_DISPLAY_FORMAT, ATT_NAME_EXPORT_DEPENDENT_PRIMARY_KEY, ATT_NAME_EXPORT_FOR, ATT_NAME_EXPORT_IGNORE_FOR, ATT_NAME_EXPORT_SEPARATE_FILE_IN, ATT_NAME_FULLTEXT_ANALYZED, ATT_NAME_FULLTEXT_ANALYZER, ATT_NAME_FULLTEXT_BOOST, ATT_NAME_FULLTEXT_INDEXED, ATT_NAME_IGNORE_BACK_RELATION, ATT_NAME_ITEM_PROPERTY, ATT_NAME_LAZY, ATT_NAME_LOOKUP_CASE_SENSITIVE, ATT_NAME_LOOKUP_PROPERTY, ATT_NAME_LOOKUP_STARTING_WITH, ATT_NAME_LOOKUP_SUBSTRING, ATT_NAME_NAME, ATT_NAME_NP_CALCULATION_AUTHORITY, ATT_NAME_OMIT_ON_COPY, ATT_NAME_READONLY, ATT_NAME_RELATION, ATT_NAME_REPORT_ALIAS, ATT_NAME_REPORT_MANY_SORT, ATT_NAME_REPORT_POSITION, ATT_NAME_REPORT_RELATIVE_WIDTH, ATT_NAME_REPORT_SORT, ATT_NAME_REPORT_VISIBLE, ATT_NAME_SHARED, ATT_NAME_SINGULAR, ATT_NAME_TYPE, ATT_NAME_UI_AUTO_TRIM, ATT_NAME_UI_CREATE_IN_DETAILVIEW, ATT_NAME_UI_EDIT_MODE, ATT_NAME_UI_EDITABLE, ATT_NAME_UI_EXPECTED_WIDTH, ATT_NAME_UI_MANDATORY, ATT_NAME_UI_SELECTION_FILTER, ATT_NAME_UI_TIPS, ATT_NAME_UI_TIPS_TRISTATE, ATT_NAME_UI_VISIBLE, ATT_NAME_VIRTUAL_AGGREGATE, ATT_NAME_VIRTUAL_AGGREGATE_IGNORE_DELETED, ATT_NAME_VIRTUAL_CACHE_MODE, ATT_NAME_VIRTUAL_INITIALDATA, ATT_NAME_VIRTUAL_PRECACHING_HOOK, CACHEMODE_NONE, CACHEMODE_SIMPLE, CACHEMODE_STRING_SIMPLE, CACHEMODE_STRING_VERSIONED, CACHEMODE_VERSIONED, CALCULATION_AUTHORITY_CLIENT, CALCULATION_AUTHORITY_NONE, CALCULATION_AUTHORITY_SERVER, CALCULATION_AUTHORITY_STRING_CLIENT, CALCULATION_AUTHORITY_STRING_SERVER, COPY_POLICY_COPY, COPY_POLICY_NONE, COPY_POLICY_STRING_COPY, COPY_POLICY_STRING_UPDATE_REL, COPY_POLICY_UPDATEREL, DEFAULT_EXPECTED_WIDTH, EDITMODE_LINKONLY, EDITMODE_UNDEFINED, EDITMODE_VIEWONLY, EL_NAME_BACK_RELATION, EL_NAME_COMMENT, EL_NAME_DB, EL_NAME_EXPORT, EL_NAME_FULLTEXT, EL_NAME_LOOKUP, EL_NAME_NP, EL_NAME_REPORT, EL_NAME_UI, EL_NAME_VIRTUAL, EMPTY_ARRAY, EXPORT_IGNORE_FOR_ALL, MAX_RELATION_DISCRIMINATOR, MIN_RELATION_DISCRIMINATOR, NO_RELATION_DISCRIMINATOR, READONLY_NO, READONLY_SERVERONLY, READONLY_UNDEFINED, READONLY_WRITENEW, READONLY_WRITENEW_STR, READONLY_YES, REPORT_SORT_ASC, REPORT_SORT_DESC, RESERVED_KEYWORDS, RESERVED_TABLE_NAMES, SUFFIX_L10N_PLURAL_KEY, TYPE_NAME_DEFAULT

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object value)`
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`int`	`compareTo(java.lang.Object _obj)`
`java.lang.Boolean`	`getAnalyzedForFTS()`
`AttributeI`	`getBackAttribute()`
`int`	`getCalculationAuthority()` Returns the calculation authority of this `AttributeI` if it is non-persistent.
`java.lang.Class`	`getClazz()` Returns the `Class` object representing the type of this attribute or the related entity.
`java.lang.String`	`getComment()`
`java.lang.String`	`getContainingElementPackage()`
`int`	`getCopyPolicy()`
`int`	`getEditmode()`
`java.lang.String`	`getEntityName()` Returns the name of the entity to which this attribute belongs.
`int`	`getExpectedWidth()`
`java.lang.String`	`getExportDependentPrimaryKey()` Returns the attribute name of the primary key when exporting this AttributeI as a dependent relation, if any.
`OnlyToDirectedGraphNodeI`	`getFromNode()` Retrieves the source node from which this directed edge originates.
`java.lang.String`	`getFTSAnalyzer()`
`java.lang.Float`	`getFTSBoost()`
`java.lang.String`	`getGuiTip(java.lang.String tip)`
`int`	`getGuiTipAsInt(java.lang.String tip)`
`java.util.Map`	`getGuiTips()`
`java.lang.Boolean`	`getIndexedForFTS()`
`java.lang.String`	`getItemProperty()`
`java.lang.String`	`getL10nEntityName()` Returns the localized name of the entity to which this attribute belongs.
`java.lang.String`	`getL10nName()` Returns the localized name of this `AttributeI`.
`java.lang.String`	`getL10nNameKey()` Returns the localization name key for this `AttributeI`.
`java.lang.String`	`getL10nNameVar()` Returns a localizable String variable reference for the name of this `AttributeI`.
`java.lang.String`	`getL10nSingular()` Returns the localized singular form of this `AttributeI`.
`java.lang.String`	`getL10nSingularKey()` Returns the singular key of this `AttributeI`, used for localization.
`java.lang.String`	`getL10nSingularVar()` Returns a localizable `String` for the singular key of this `AttributeI` (i.e.
`java.lang.Boolean`	`getLookupCaseSensitive()`
`java.lang.String`	`getLookupProperty()`
`java.lang.Boolean`	`getLookupStartingWith()`
`java.lang.Boolean`	`getLookupSubstring()`
`java.util.Collection<java.lang.String>`	`getModulePackages()` Returns the names of the module packages this `AttributeI` is appearing in.
`java.lang.String`	`getName()`
`java.util.Collection<java.lang.String>`	`getOrCreateModulePackagesSet()`
`EntityI`	`getRelationEntity()`
`java.util.Iterator`	`getRelationIterator(java.lang.Object bo)`
`java.util.Map`	`getRelationObjects(java.lang.Object bo)`
`java.lang.String`	`getRelationType()`
`java.lang.String`	`getReportAlias()` If a report alias is given, this is the sign for us to generate a group in the report and show the data of this many-relation.
`java.lang.String`	`getReportManySort()`
`java.lang.Integer`	`getReportPosition()` Returns the expected position of the attribute in the automatic reports.
`int`	`getReportRelativeWidth()` Return the relative width of the attribute in the automatic reports, defaults to 1.
`java.lang.String`	`getReportSort()`
`SchemaI`	`getSchema()` Returns the schema associated with this attribute.
`java.lang.String`	`getSelectionFilter()` Returns a filter-clause that acts as a non-interactive filter within a query.
`java.lang.String`	`getSingular()`
`java.lang.String`	`getTimeZoneProperty()`
`OnlyToDirectedGraphNodeI`	`getToNode()` Retrieves the target node to which this directed edge points.
`CBOAttributeTypeI`	`getType()`
`java.lang.String`	`getTypeName()` Returns the type information of this attribute.
`java.lang.Object`	`getValue(java.lang.Object bo)`
`java.lang.String`	`getValueAsString(java.lang.Object bo)`
`java.lang.Object`	`getValueLazy(java.lang.Object bo)`
`boolean`	`hasCustomIterator()` Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally.
`boolean`	`hasGuiTip(java.lang.String tip)`
`boolean`	`hasRelationObject(java.lang.Object bo, java.lang.Object value)`
`boolean`	`isArray()`
`boolean`	`isAutotrim()`
`boolean`	`isCached()`
`boolean`	`isCreateInDetailView()`
`boolean`	`isCustomIteratorNotCaching()` Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally and the relation shall be refreshed, i.e. the iterator shall run again to fill and refresh the relation.
`boolean`	`isDepend()`
`boolean`	`isEditable()` Returns if the `AttributeI` is editable in the UI.
`boolean`	`isEditable(BOI bo)` Returns if the `AttributeI` is editable in the UI for the specified `BOI`.
`boolean`	`isForExport(java.lang.String exportName)` Returns true if the vattr was marked as to export for the export with the passed name.
`boolean`	`isIgnoreBackRelation()`
`boolean`	`isIgnoredForExport(java.lang.String exportName)` Returns true if the attr was marked as to ignore during export for the export with the passed name.
`boolean`	`isIndexed()`
`boolean`	`isInitialdata()`
`boolean`	`isLazy()`
`boolean`	`isLinkOnly()`
`boolean`	`isMandatory()` Returns whether this `AttributeI` instance is a mandatory attribute.
`boolean`	`isMandatory(BOI bo)` Returns whether this `AttributeI` instance is a mandatory attribute for the specified `BOI`.
`boolean`	`isManyRelation()`
`boolean`	`isOmitOnCopy()`
`boolean`	`isPersistent()`
`boolean`	`isPolymorphicRelation()`
`boolean`	`isReadonly()` Returns whether this `AttributeI` instance is strictly read-only.
`boolean`	`isReadonly(BOI bo)` Returns whether this `AttributeI` instance is read-only for the specified `BOI`.
`boolean`	`isRelation()`
`boolean`	`isReportVisible()`
`boolean`	`isSeparateFileForExport(java.lang.String exportName)` Returns true if the attr was marked as to export to a separate file for the export with the passed name.
`boolean`	`isSerialized()`
`boolean`	`isShared()`
`boolean`	`isViewOnly()`
`boolean`	`isVirtual()`
`boolean`	`isVisible()` Returns whether this `AttributeI` instance is visible in the UI.
`boolean`	`isVisible(BOI bo)` Returns whether this `AttributeI` instance is visible in the UI for the specified `BOI`.
`java.lang.Object`	`pgetValue(java.lang.Object bo)`
`void`	`psetValue(java.lang.Object bo, java.lang.Object value)`
`AttributeI`	`realAttribute()`
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object value)`
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`void`	`setAutotrim(boolean b)`
`void`	`setCreateInDetailView(boolean b)`
`void`	`setEditable(boolean b)`
`void`	`setEditmode(int i)`
`void`	`setExpectedWidth(int i)`
`void`	`setGuiTips(java.util.Map m)`
`void`	`setItemProperty(java.lang.String s)`
`void`	`setMandatory(boolean b)`
`void`	`setSelectionFilter(java.lang.String s)`
`void`	`setTimeZoneProperty(java.lang.String s)`
`void`	`setValue(java.lang.Object bo, java.lang.Object value)`
`void`	`setValue(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value)`
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value, boolean checkConstraints)`
`void`	`setVisible(boolean b)`

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

Methods inherited from interface de.ipcon.schema.AttributeI
getContainingElementName, getEntity, getQName, getQName, getTypedQName, getTypedQName, isCoreNative, isModuleNative, isPartOfModule, isProjectNative, isServerCalculated, toAttributePath, toNiceString

- Method Detail
  - realAttribute
```
public AttributeI realAttribute()
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface BasicAttributeI
  - getSchema
```
public SchemaI getSchema()
```
    Description copied from interface: AttributeI
    
    Returns the schema associated with this attribute.
    
    Specified by:
    
    getSchema in interface AttributeI
    
    Returns:
    
    The SchemaI instance that defines this attribute.
  - getEntityName
```
public java.lang.String getEntityName()
```
    Description copied from interface: AttributeI
    
    Returns the name of the entity to which this attribute belongs.
    Note: This method returns the *name* of the entity, not the entity object itself. This is intentional to prevent direct coupling to the entity object.
    
    Specified by:
    
    getEntityName in interface AttributeI
    
    Returns:
    
    The name (String) of the owning entity.
  - getContainingElementPackage
```
public java.lang.String getContainingElementPackage()
```
    Specified by:
    
    getContainingElementPackage in interface BasicAttributeI
  - isSerialized
```
public boolean isSerialized()
```
    Specified by:
    
    isSerialized in interface AttributeI
  - isPersistent
```
public boolean isPersistent()
```
    Specified by:
    
    isPersistent in interface AttributeI
  - isIgnoreBackRelation
```
public boolean isIgnoreBackRelation()
```
    Specified by:
    
    isIgnoreBackRelation in interface AttributeI
  - getCalculationAuthority
```
public int getCalculationAuthority()
```
    Description copied from interface: AttributeI
    
    Returns the calculation authority of this AttributeI if it is non-persistent.
    If this AttributeI is persistent, AttributeI.CALCULATION_AUTHORITY_NONE will always be returned.
    
    Specified by:
    
    getCalculationAuthority in interface AttributeI
    
    Returns:
    
    the calculation authority of this AttributeI
  - isVirtual
```
public boolean isVirtual()
```
    Specified by:
    
    isVirtual in interface BasicAttributeI
  - getClazz
```
public java.lang.Class getClazz()
```
    Description copied from interface: BasicAttributeI
    
    Returns the Class object representing the type of this attribute or the related entity.
    If this attribute is a relation to another entity, the method returns the Class object of the related entity. Otherwise, it returns the Class object of the attribute's declared type.
    
    Specified by:
    
    getClazz in interface BasicAttributeI
    
    Returns:
    
    The Class object representing the type of this attribute or the related entity.
  - isCached
```
public boolean isCached()
```
    Specified by:
    
    isCached in interface AttributeI
  - isIndexed
```
public boolean isIndexed()
```
    Specified by:
    
    isIndexed in interface AttributeI
  - getComment
```
public java.lang.String getComment()
```
    Specified by:
    
    getComment in interface BasicAttributeI
  - isInitialdata
```
public boolean isInitialdata()
```
    Specified by:
    
    isInitialdata in interface AttributeI
  - getModulePackages
```
public java.util.Collection<java.lang.String> getModulePackages()
```
    Description copied from interface: AttributeI
    
    Returns the names of the module packages this AttributeI is appearing in.
    
    Specified by:
    
    getModulePackages in interface AttributeI
    
    Returns:
    
    The names of the module packages this AttributeI is appearing in.
  - getOrCreateModulePackagesSet
```
public java.util.Collection<java.lang.String> getOrCreateModulePackagesSet()
```
    Specified by:
    
    getOrCreateModulePackagesSet in interface AttributeI
  - getL10nNameKey
```
public java.lang.String getL10nNameKey()
```
    Description copied from interface: AttributeI
    Returns the localization name key for this AttributeI. The key determines which localized string is retrieved for the attribute's name, varying based on its relation type and read-only status.
    - If the attribute is not a "many-relation" (i.e., it's a single-valued attribute), this method returns the attribute's primary name key.
    - If the attribute is a "many-relation":
      
      And it is read-only, this method returns the attribute's primary name key, as there is only the plural, which is the name of the attribute.
      
      And it is not read-only, it returns the singular form of the attribute's localized name, appended with AttributeI.SUFFIX_L10N_PLURAL_KEY (typically "-s"), to represent a plural or collection name key.
    Specified by:
    
    getL10nNameKey in interface AttributeI
    
    Returns:
    
    The appropriate localization name key (String) for this AttributeI, adapted based on its many-relation and read-only properties.
  - getL10nNameVar
```
public java.lang.String getL10nNameVar()
```
    Description copied from interface: AttributeI
    
    Returns a localizable String variable reference for the name of this AttributeI.
    This method constructs a string that serves as a reference to a localized resource. The format is typically `$R{'KEY'}`, where 'KEY' is determined by AttributeI.getL10nNameKey(). This allows the UI or report generation to fetch the appropriate localized name dynamically.
    
    Specified by:
    
    getL10nNameVar in interface AttributeI
    
    Returns:
    
    The localizable String variable reference for the name of this AttributeI (e.g. "$R{Position}").
  - getL10nName
```
public java.lang.String getL10nName()
```
    Description copied from interface: AttributeI
    
    Returns the localized name of this AttributeI.
    This method retrieves the appropriate localized string for the attribute's name by using its determined localization name key (from AttributeI.getL10nNameKey()). It delegates to the L10n.msg(String, Object[], Object[], boolean) method to perform the actual localization lookup. If no translation is found, the original name key is returned as a fallback.
    
    Specified by:
    
    getL10nName in interface AttributeI
    
    Returns:
    
    The localized name of this AttributeI as a String.
  - getL10nSingularKey
```
public java.lang.String getL10nSingularKey()
```
    Description copied from interface: AttributeI
    
    Returns the singular key of this AttributeI, used for localization.
    This key uniquely identifies the singular form of the attribute's name within the localization (L10n) bundles. It is typically derived from the attribute's base name.
    
    Specified by:
    
    getL10nSingularKey in interface AttributeI
    
    Returns:
    
    The singular key (String) of this AttributeI for localization purposes.
  - getL10nSingularVar
```
public java.lang.String getL10nSingularVar()
```
    Description copied from interface: AttributeI
    
    Returns a localizable String for the singular key of this AttributeI (i.e. $R{'KEY'}).
    
    Specified by:
    
    getL10nSingularVar in interface AttributeI
    
    Returns:
    
    the localizable String for the singular key of this AttributeI
  - getL10nSingular
```
public java.lang.String getL10nSingular()
```
    Description copied from interface: AttributeI
    
    Returns the localized singular form of this AttributeI.
    This method retrieves the appropriate singular translation of the attribute's name from the localization resources (L10n bundles) based on the current locale. Falls back to returning the key if no translation was found.
    
    Specified by:
    
    getL10nSingular in interface AttributeI
    
    Returns:
    
    The localized singular String of this AttributeI.
  - getL10nEntityName
```
public java.lang.String getL10nEntityName()
```
    Description copied from interface: AttributeI
    
    Returns the localized name of the entity to which this attribute belongs.
    This method typically retrieves the localized name by first obtaining the associated entity (via an internal mechanism of the attribute) and then calling that entity's getL10nName() method. It makes sure the attribute is properly linked to an entity before trying to retrieve its name.
    
    Specified by:
    
    getL10nEntityName in interface AttributeI
    
    Returns:
    
    The localized name (String) of the owning entity.
  - getType
```
public CBOAttributeTypeI getType()
```
    Specified by:
    
    getType in interface BasicAttributeI
  - getTypeName
```
public java.lang.String getTypeName()
```
    Description copied from interface: BasicAttributeI
    
    Returns the type information of this attribute.
    For relations, this is either the simple or qualified name of the referenced entity. For scalars, this is the declared type in the schema.
    
    Specified by:
    
    getTypeName in interface BasicAttributeI
    
    Returns:
    
    The type or relation information of this attribute.
  - isArray
```
public boolean isArray()
```
    Specified by:
    
    isArray in interface BasicAttributeI
    
    Returns:
    
    true if the clazz of this attribute is an array, false otherwise
  - getSingular
```
public java.lang.String getSingular()
```
    Specified by:
    
    getSingular in interface BasicAttributeI
  - isRelation
```
public boolean isRelation()
```
    Specified by:
    
    isRelation in interface BasicAttributeI
  - getRelationType
```
public java.lang.String getRelationType()
```
    Specified by:
    
    getRelationType in interface BasicAttributeI
    
    Returns:
    
    the relation type String, either SchemaI.RELATION_TYPE_N_1, SchemaI.RELATION_TYPE_1_N or SchemaI.RELATION_TYPE_N_M. The empty String (or null?) for scalars.
  - getRelationEntity
```
public EntityI getRelationEntity()
```
    Specified by:
    
    getRelationEntity in interface BasicAttributeI
  - getBackAttribute
```
public AttributeI getBackAttribute()
```
    Specified by:
    
    getBackAttribute in interface AttributeI
  - isLazy
```
public boolean isLazy()
```
    Specified by:
    
    isLazy in interface AttributeI
  - hasCustomIterator
```
public boolean hasCustomIterator()
```
    Description copied from interface: BasicAttributeI
    
    Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally.
    
    Specified by:
    
    hasCustomIterator in interface BasicAttributeI
  - isCustomIteratorNotCaching
```
public boolean isCustomIteratorNotCaching()
```
    Description copied from interface: AttributeI
    
    Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally and the relation shall be refreshed, i.e. the iterator shall run again to fill and refresh the relation.
    The default is false, so the values are cached forever, which is useful as custom iterators are typically used in situations where a long running calculation shall only be done once and for new results, a new instance must be used.
    
    Specified by:
    
    isCustomIteratorNotCaching in interface AttributeI
  - isDepend
```
public boolean isDepend()
```
    Specified by:
    
    isDepend in interface AttributeI
  - isManyRelation
```
public boolean isManyRelation()
```
    Specified by:
    
    isManyRelation in interface BasicAttributeI
  - isPolymorphicRelation
```
public boolean isPolymorphicRelation()
```
    Specified by:
    
    isPolymorphicRelation in interface AttributeI
  - setSelectionFilter
```
public void setSelectionFilter(java.lang.String s)
```
    Specified by:
    
    setSelectionFilter in interface AttributeWithUIConfigurationI
  - getSelectionFilter
```
public java.lang.String getSelectionFilter()
```
    Description copied from interface: AttributeI
    
    Returns a filter-clause that acts as a non-interactive filter within a query. If this AttributeI is used as a property, this filter is automatically active and restricts the selection.
    
    Specified by:
    
    getSelectionFilter in interface AttributeI
    
    Specified by:
    
    getSelectionFilter in interface AttributeWithUIConfigurationI
    
    Returns:
    
    the filter-clause for this AttributeI
  - isForExport
```
public boolean isForExport(java.lang.String exportName)
```
    Description copied from interface: AttributeI
    
    Returns true if the vattr was marked as to export for the export with the passed name.
    
    Specified by:
    
    isForExport in interface AttributeI
  - isIgnoredForExport
```
public boolean isIgnoredForExport(java.lang.String exportName)
```
    Description copied from interface: AttributeI
    
    Returns true if the attr was marked as to ignore during export for the export with the passed name.
    
    Specified by:
    
    isIgnoredForExport in interface AttributeI
  - isSeparateFileForExport
```
public boolean isSeparateFileForExport(java.lang.String exportName)
```
    Description copied from interface: AttributeI
    
    Returns true if the attr was marked as to export to a separate file for the export with the passed name.
    
    Specified by:
    
    isSeparateFileForExport in interface AttributeI
  - getExportDependentPrimaryKey
```
public java.lang.String getExportDependentPrimaryKey()
```
    Description copied from interface: AttributeI
    
    Returns the attribute name of the primary key when exporting this AttributeI as a dependent relation, if any.
    
    Specified by:
    
    getExportDependentPrimaryKey in interface AttributeI
  - setItemProperty
```
public void setItemProperty(java.lang.String s)
```
    Specified by:
    
    setItemProperty in interface AttributeWithUIConfigurationI
  - getItemProperty
```
public java.lang.String getItemProperty()
```
    Specified by:
    
    getItemProperty in interface AttributeI
    
    Specified by:
    
    getItemProperty in interface AttributeWithUIConfigurationI
  - setTimeZoneProperty
```
public void setTimeZoneProperty(java.lang.String s)
```
    Specified by:
    
    setTimeZoneProperty in interface AttributeWithUIConfigurationI
  - getTimeZoneProperty
```
public java.lang.String getTimeZoneProperty()
```
    Specified by:
    
    getTimeZoneProperty in interface AttributeI
    
    Specified by:
    
    getTimeZoneProperty in interface AttributeWithUIConfigurationI
  - setCreateInDetailView
```
public void setCreateInDetailView(boolean b)
```
    Specified by:
    
    setCreateInDetailView in interface AttributeWithUIConfigurationI
  - isCreateInDetailView
```
public boolean isCreateInDetailView()
```
    Specified by:
    
    isCreateInDetailView in interface AttributeI
    
    Specified by:
    
    isCreateInDetailView in interface AttributeWithUIConfigurationI
  - setExpectedWidth
```
public void setExpectedWidth(int i)
```
    Specified by:
    
    setExpectedWidth in interface AttributeWithUIConfigurationI
  - getExpectedWidth
```
public int getExpectedWidth()
```
    Specified by:
    
    getExpectedWidth in interface AttributeI
    
    Specified by:
    
    getExpectedWidth in interface AttributeWithUIConfigurationI
  - isShared
```
public boolean isShared()
```
    Specified by:
    
    isShared in interface AttributeI
  - isLinkOnly
```
public boolean isLinkOnly()
```
    Specified by:
    
    isLinkOnly in interface AttributeI
  - isViewOnly
```
public boolean isViewOnly()
```
    Specified by:
    
    isViewOnly in interface AttributeI
  - isOmitOnCopy
```
public boolean isOmitOnCopy()
```
    Specified by:
    
    isOmitOnCopy in interface AttributeI
  - setAutotrim
```
public void setAutotrim(boolean b)
```
    Specified by:
    
    setAutotrim in interface AttributeWithUIConfigurationI
  - isAutotrim
```
public boolean isAutotrim()
```
    Specified by:
    
    isAutotrim in interface AttributeI
    
    Specified by:
    
    isAutotrim in interface AttributeWithUIConfigurationI
  - setEditmode
```
public void setEditmode(int i)
```
    Specified by:
    
    setEditmode in interface AttributeWithUIConfigurationI
  - getEditmode
```
public int getEditmode()
```
    Specified by:
    
    getEditmode in interface AttributeWithUIConfigurationI
  - hasGuiTip
```
public boolean hasGuiTip(java.lang.String tip)
```
    Specified by:
    
    hasGuiTip in interface AttributeI
  - getGuiTip
```
public java.lang.String getGuiTip(java.lang.String tip)
```
    Specified by:
    
    getGuiTip in interface AttributeI
  - getGuiTipAsInt
```
public int getGuiTipAsInt(java.lang.String tip)
```
    Specified by:
    
    getGuiTipAsInt in interface AttributeI
  - setGuiTips
```
public void setGuiTips(java.util.Map m)
```
    Specified by:
    
    setGuiTips in interface AttributeWithUIConfigurationI
  - getGuiTips
```
public java.util.Map getGuiTips()
```
    Specified by:
    
    getGuiTips in interface AttributeI
    
    Specified by:
    
    getGuiTips in interface AttributeWithUIConfigurationI
  - setMandatory
```
public void setMandatory(boolean b)
```
    Specified by:
    
    setMandatory in interface AttributeWithUIConfigurationI
  - isMandatory
```
public boolean isMandatory()
```
    Description copied from interface: AttributeI
    
    Returns whether this AttributeI instance is a mandatory attribute.
    
    Specified by:
    
    isMandatory in interface AttributeI
    
    Specified by:
    
    isMandatory in interface AttributeWithUIConfigurationI
    
    Returns:
    
    true if this AttributeI instance is a mandatory attribute.
  - isMandatory
```
public boolean isMandatory(BOI bo)
```
    Description copied from interface: AttributeI
    
    Returns whether this AttributeI instance is a mandatory attribute for the specified BOI.
    
    Specified by:
    
    isMandatory in interface AttributeI
    
    Returns:
    
    true if this AttributeI instance is a mandatory attribute for the specified BOI.
  - isReadonly
```
public boolean isReadonly()
```
    Description copied from interface: BasicAttributeI
    
    Returns whether this AttributeI instance is strictly read-only. An attribute that is strictly read-only cannot be modified under any circumstances. If this method returns true, any attempt to modify the attribute will result in an exception being thrown.
    
    Specified by:
    
    isReadonly in interface BasicAttributeI
    
    Returns:
    
    true if this AttributeI is strictly read-only, false otherwise.
  - isReadonly
```
public boolean isReadonly(BOI bo)
```
    Description copied from interface: AttributeI
    
    Returns whether this AttributeI instance is read-only for the specified BOI. An attribute that is read-only for a particular BOI cannot be modified for that BOI only. If this method returns true, any attempt to modify the attribute for the specified BOI will result in an exception being thrown.
    
    Specified by:
    
    isReadonly in interface AttributeI
    
    Parameters:
    
    bo - the BOI for which to check the read-only status of this attribute.
    
    Returns:
    
    true if this AttributeI is read-only for the specified BOI, false otherwise.
  - setEditable
```
public void setEditable(boolean b)
```
    Specified by:
    
    setEditable in interface AttributeWithUIConfigurationI
  - isEditable
```
public boolean isEditable()
```
    Description copied from interface: AttributeI
    
    Returns if the AttributeI is editable in the UI.
    
    Specified by:
    
    isEditable in interface AttributeI
    
    Returns:
    
    true if this AttributeI is editable in the UI.
  - isEditable
```
public boolean isEditable(BOI bo)
```
    Description copied from interface: AttributeI
    
    Returns if the AttributeI is editable in the UI for the specified BOI.
    
    Specified by:
    
    isEditable in interface AttributeI
    
    Returns:
    
    true if this AttributeI is editable in the UI for the specified BOI.
  - setVisible
```
public void setVisible(boolean b)
```
    Specified by:
    
    setVisible in interface AttributeWithUIConfigurationI
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: AttributeI
    
    Returns whether this AttributeI instance is visible in the UI.
    
    Specified by:
    
    isVisible in interface AttributeI
    
    Specified by:
    
    isVisible in interface AttributeWithUIConfigurationI
    
    Returns:
    
    true if this AttributeI instance is visible in the UI.
  - isVisible
```
public boolean isVisible(BOI bo)
```
    Description copied from interface: AttributeI
    
    Returns whether this AttributeI instance is visible in the UI for the specified BOI.
    
    Specified by:
    
    isVisible in interface AttributeI
    
    Returns:
    
    true if this AttributeI instance is visible in the UI for the specified BOI.
  - getCopyPolicy
```
public int getCopyPolicy()
```
    Specified by:
    
    getCopyPolicy in interface AttributeI
  - getLookupProperty
```
public java.lang.String getLookupProperty()
```
    Specified by:
    
    getLookupProperty in interface AttributeI
  - getLookupSubstring
```
public java.lang.Boolean getLookupSubstring()
```
    Specified by:
    
    getLookupSubstring in interface AttributeI
  - getLookupStartingWith
```
public java.lang.Boolean getLookupStartingWith()
```
    Specified by:
    
    getLookupStartingWith in interface AttributeI
  - getLookupCaseSensitive
```
public java.lang.Boolean getLookupCaseSensitive()
```
    Specified by:
    
    getLookupCaseSensitive in interface AttributeI
  - getValue
```
public java.lang.Object getValue(java.lang.Object bo)
```
    Specified by:
    
    getValue in interface AttributeI
  - getValueLazy
```
public java.lang.Object getValueLazy(java.lang.Object bo)
```
    Specified by:
    
    getValueLazy in interface AttributeI
  - getValueAsString
```
public java.lang.String getValueAsString(java.lang.Object bo)
```
    Specified by:
    
    getValueAsString in interface AttributeI
  - setValue
```
public void setValue(java.lang.Object bo,
                     java.lang.Object value,
                     WriteConstraintsOverriderI overrider)
```
    Specified by:
    
    setValue in interface AttributeI
  - setValue
```
public void setValue(java.lang.Object bo,
                     java.lang.Object value)
```
    Specified by:
    
    setValue in interface AttributeI
  - setValueAsString
```
public void setValueAsString(java.lang.Object bo,
                             java.lang.String value,
                             boolean checkConstraints)
```
    Specified by:
    
    setValueAsString in interface AttributeI
  - setValueAsString
```
public void setValueAsString(java.lang.Object bo,
                             java.lang.String value)
```
    Specified by:
    
    setValueAsString in interface AttributeI
  - getRelationObjects
```
public java.util.Map getRelationObjects(java.lang.Object bo)
```
    Specified by:
    
    getRelationObjects in interface AttributeI
  - getRelationIterator
```
public java.util.Iterator getRelationIterator(java.lang.Object bo)
```
    Specified by:
    
    getRelationIterator in interface AttributeI
  - addRelationObject
```
public void addRelationObject(java.lang.Object bo,
                              java.lang.Object value,
                              WriteConstraintsOverriderI overrider)
```
    Specified by:
    
    addRelationObject in interface AttributeI
  - addRelationObject
```
public void addRelationObject(java.lang.Object bo,
                              java.lang.Object value)
```
    Specified by:
    
    addRelationObject in interface AttributeI
  - removeRelationObject
```
public void removeRelationObject(java.lang.Object bo,
                                 java.lang.Object value,
                                 WriteConstraintsOverriderI overrider)
```
    Specified by:
    
    removeRelationObject in interface AttributeI
  - removeRelationObject
```
public void removeRelationObject(java.lang.Object bo,
                                 java.lang.Object value)
```
    Specified by:
    
    removeRelationObject in interface AttributeI
  - hasRelationObject
```
public boolean hasRelationObject(java.lang.Object bo,
                                 java.lang.Object value)
```
    Specified by:
    
    hasRelationObject in interface AttributeI
  - pgetValue
```
public java.lang.Object pgetValue(java.lang.Object bo)
```
    Specified by:
    
    pgetValue in interface AttributeI
  - psetValue
```
public void psetValue(java.lang.Object bo,
                      java.lang.Object value)
```
    Specified by:
    
    psetValue in interface AttributeI
  - getIndexedForFTS
```
public java.lang.Boolean getIndexedForFTS()
```
    Specified by:
    
    getIndexedForFTS in interface AttributeI
  - getAnalyzedForFTS
```
public java.lang.Boolean getAnalyzedForFTS()
```
    Specified by:
    
    getAnalyzedForFTS in interface AttributeI
  - getFTSAnalyzer
```
public java.lang.String getFTSAnalyzer()
```
    Specified by:
    
    getFTSAnalyzer in interface AttributeI
  - getFTSBoost
```
public java.lang.Float getFTSBoost()
```
    Specified by:
    
    getFTSBoost in interface AttributeI
  - isReportVisible
```
public boolean isReportVisible()
```
    Specified by:
    
    isReportVisible in interface AttributeI
    
    Returns:
    
    true if this AttributeI shall be printed in the automatic reports, defaults to true
  - getReportRelativeWidth
```
public int getReportRelativeWidth()
```
    Description copied from interface: AttributeI
    
    Return the relative width of the attribute in the automatic reports, defaults to 1. If e.g. 3 is given the attribute will take three times as much space as by default.
    This works also for attributes of entities extending other entities and adding attributes with their own relativeWiths.
    
    Specified by:
    
    getReportRelativeWidth in interface AttributeI
    
    Returns:
    
    the relative width of the attribute in the automatic reports, defaults to 1
  - getReportPosition
```
public java.lang.Integer getReportPosition()
```
    Description copied from interface: AttributeI
    
    Returns the expected position of the attribute in the automatic reports.
    Tip: be sure to use 'high' values, so that attributes of extending entities can 'squeeze in' between them if necessary ;-) e.g. 100, 200, 300, ...
    
    Specified by:
    
    getReportPosition in interface AttributeI
    
    Returns:
    
    the expected position of the attribute in the automatic reports
  - getReportSort
```
public java.lang.String getReportSort()
```
    Specified by:
    
    getReportSort in interface AttributeI
    
    Returns:
    
    the way the report-data shall be sorted "flat", e.g. "asc" or "desc"
  - getReportManySort
```
public java.lang.String getReportManySort()
```
    Specified by:
    
    getReportManySort in interface AttributeI
    
    Returns:
    
    the way the report-data shall be sorted, e.g. "Tid:A, Nummer:D"
  - getReportAlias
```
public java.lang.String getReportAlias()
```
    Description copied from interface: AttributeI
    
    If a report alias is given, this is the sign for us to generate a group in the report and show the data of this many-relation.
    FIXME: support more than one many-relation in automatic reports
    
    Specified by:
    
    getReportAlias in interface AttributeI
    
    Returns:
    
    an alias for the first many-relation or null if non defined in the schema
  - compareTo
```
public int compareTo(java.lang.Object _obj)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.lang.Object>
  - getFromNode
```
public OnlyToDirectedGraphNodeI getFromNode()
```
    Description copied from interface: GraphEdgeI
    
    Retrieves the source node from which this directed edge originates.
    This method is contractually obligated to return a non-null OnlyToDirectedGraphNodeI instance, as every valid edge must have a defined starting point.
    
    Specified by:
    
    getFromNode in interface AttributeI
    
    Specified by:
    
    getFromNode in interface GraphEdgeI
    
    Returns:
    
    The non-null source node (also referred to as the "from-node" or "tail") of this edge.
  - getToNode
```
public OnlyToDirectedGraphNodeI getToNode()
```
    Description copied from interface: GraphEdgeI
    
    Retrieves the target node to which this directed edge points.
    This method is contractually obligated to return a non-null OnlyToDirectedGraphNodeI instance, as every valid edge must have a defined ending point.
    
    Specified by:
    
    getToNode in interface AttributeI
    
    Specified by:
    
    getToNode in interface GraphEdgeI
    
    Returns:
    
    The non-null target node (also referred to as the "to-node" or "head") of this edge.

Class AttributeWrapper

Field Summary

Fields inherited from interface de.ipcon.schema.AttributeI

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.ipcon.schema.AttributeI

Method Detail

realAttribute

getName

getSchema

getEntityName

getContainingElementPackage

isSerialized

isPersistent

isIgnoreBackRelation

getCalculationAuthority

isVirtual

getClazz

isCached

isIndexed

getComment

isInitialdata

getModulePackages

getOrCreateModulePackagesSet

getL10nNameKey

getL10nNameVar

getL10nName

getL10nSingularKey

getL10nSingularVar

getL10nSingular

getL10nEntityName

getType

getTypeName

isArray

getSingular

isRelation

getRelationType

getRelationEntity

getBackAttribute

isLazy

hasCustomIterator

isCustomIteratorNotCaching

isDepend

isManyRelation

isPolymorphicRelation

setSelectionFilter

getSelectionFilter

isForExport

isIgnoredForExport

isSeparateFileForExport

getExportDependentPrimaryKey

setItemProperty

getItemProperty

setTimeZoneProperty

getTimeZoneProperty

setCreateInDetailView

isCreateInDetailView

setExpectedWidth

getExpectedWidth

isShared

isLinkOnly

isViewOnly

isOmitOnCopy

setAutotrim

isAutotrim

setEditmode

getEditmode

hasGuiTip

getGuiTip

getGuiTipAsInt

setGuiTips

getGuiTips

setMandatory

isMandatory

isMandatory

isReadonly

isReadonly

setEditable

isEditable

isEditable