CBOAttribute (MyTISM API Documentation)

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

All Implemented Interfaces:

AttributeI, AttributeWithUIConfigurationI, BasicAttributeI, CBOAttributeI, GraphEdgeI, java.io.Serializable, java.lang.Comparable<java.lang.Object>
```
public final class CBOAttribute
extends java.lang.Object
implements CBOAttributeI, java.io.Serializable
```
See Also:

Serialized Form

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_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, TYPE_NAME_DEFAULT

Constructor Summary

Constructors
Constructor and Description
`CBOAttribute(EntityI _entity, AttributeTemplate template)` Constructor for `CBOAttribute`
`CBOAttribute(EntityI _entity, electric.xml.Element _el)` Constructor for this `CBOAttribute`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object newObject)` Adds the given `Object` as a relational `Object` to the provided business object (bo).
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object newObject, WriteConstraintsOverriderI overrider)` Adds the given `Object` as a relational `Object` to the provided business object (bo).
`void`	`buildPass2()` Does some second pass parsing of entity and attribute definitions, including consistency / sanity checks.
`void`	`checkItemProperty()` Processes a possible existing itemProperty definition if this is a manyrelation and checks if it is a valid attribute (chain) on the relationEntity.
`boolean`	`checkMandatoryValid(boolean mandatoryToCheck)` Performs a check and tells if the mandatory setting on this `CBOAttribute` makes sense.
`boolean`	`checkMandatoryValid(boolean mandatoryToCheck, BOI bo)`
`void`	`checkRelationDiscriminatorConsistency()` Checks and ensures the consistency of relationDiscriminator in this and back attribute.
`void`	`checkSingularAbsenceForNTo1()` This method will signal an AttributeDefinitionException if we are an n-1 relation with an explicit singular set in the schema-file.
`void`	`checkValidName()` Validates the name of this attribute.
`void`	`clearRelation(java.lang.Object bo)` Removes all relational `Object`s from the given bo
`int`	`compareTo(java.lang.Object o)` Comparable interface, Compares this object with the specified object for order.
`static void`	`copyTo(electric.xml.Element src, electric.xml.Element dest)` Copys the AttributeObjects and `Element`s from `Element` "src" to `Element` "dest", works recursivly over the copied `Element`s too, so copied `Element`s will have their AttributeObjects and `Element`s copied too (and so on)
`java.lang.String`	`errorMessageWithLine()` Returns a nice formated error message with the line number the error occurred
`void`	`forgetXMLDefinition()` Resets the local Element in el to null.
`java.lang.String`	`getAggregateFunction()`
`java.lang.String`	`getAggregateOf()`
`java.lang.String`	`getAggregateParameters()`
`java.lang.Boolean`	`getAnalyzedForFTS()`
`AttributeI`	`getBackAttribute()`
`java.lang.String`	`getBackName()`
`electric.xml.Element`	`getBackRelationDef()`
`int`	`getCacheMode()` Returns the cache mode of this `CBOAttribute`
`int`	`getCalculationAuthority()` Returns the calculation authority of this `AttributeI` if it is non-persistent.
`java.lang.String`	`getComment()`
`java.lang.String`	`getContainingElementPackage()`
`int`	`getCopyPolicy()` Returns the copy policy of this `CBOAttribute`
`java.lang.String`	`getCustomIndexDefinition()`
`int`	`getCustomIndexVersion()`
`java.lang.String`	`getDef()` Returns the Java code for building a default for this CBOAttribute as given in the attribute definition with fallback to the one given in the type.
`java.lang.String`	`getDisplayFormat()`
`int`	`getEditmode()` Returns the edit mode for this `CBOAttribute` if the edit mode is undefined, and a relation entity of this `CBOAttribute` exists and is link only and this `CBOAttribute` is not depending, the editmode will be set to link only Before getting returned
`electric.xml.Element`	`getEl()`
`EntityI`	`getEntity()`
`java.lang.String`	`getEntityName()` Returns the name of the entity as `String`
`int`	`getExpectedWidth()`
`java.lang.String`	`getExplicitSingular()`
`java.lang.String`	`getExportDependentPrimaryKey()` Returns the attribute name of the primary key when exporting this AttributeI as a dependent relation, if any.
`javax.swing.text.DocumentFilter`	`getFilter(java.util.ArrayList inputFormats)` Returns the filter from this CBOAttribute types by the given inputformats
`OnlyToDirectedGraphNodeI`	`getFromNode()`
`AttributeTemplate`	`getFromTemplate()`
`java.lang.String`	`getFTSAnalyzer()`
`java.lang.Float`	`getFTSBoost()`
`java.lang.String`	`getGuiTip()` Returns the Gui Tips for this `CBOAttribute` as a key:value-paired `String` If the value is null or empty only the key will be used instead of the pairing IMPORTANT: for backwards compatibility with old guiTip-String, esp. for Equinox
`java.lang.String`	`getGuiTip(java.lang.String tip)` Returns the gui tip for the given tip key, returns `null` if guiTips is null
`int`	`getGuiTipAsInt(java.lang.String tip)` Returns the gui tip for the given tip key as `int`
`java.util.Map<java.lang.String,java.lang.String>`	`getGuiTips()`
`java.lang.Boolean`	`getIndexedForFTS()`
`int`	`getIndexType()` Returns the index type of this `CBOAttribute` if type is INDEX_TYPE_AUTO the index type will be resolved by checking the lowinstancecount of a relation if exists
`java.lang.String`	`getItemProperty()`
`java.lang.String`	`getL10nEntityName()`
`java.lang.String`	`getL10nName()` Returns the localizated name of this CBOAttribute by his name key
`java.lang.String`	`getL10nNameKey()` Returns the name key of this `CBOAttribute` if its no manyrelation or readonly, elseway it returns the singular + '-s'
`java.lang.String`	`getL10nNameVar()` Returns a localizable `String` for the name of this `CBOAttribute` (i.e.
`java.lang.String`	`getL10nSingular()` Returns the localizated singular of this `CBOAttribute`
`java.lang.String`	`getL10nSingularKey()` Returns the singular key of this `CBOAttribute` for localisation
`java.lang.String`	`getL10nSingularVar()` Returns a localizable `String` for the singular key of this `CBOAttribute` (i.e.
`java.lang.Boolean`	`getLookupCaseSensitive()`
`java.lang.String`	`getLookupProperty()` Returns a comma-separated list of attributes/attribute chains to be searched during "fast input"; if the result is unique, the system automatically selects it upon entering a "fast input".
`java.lang.Boolean`	`getLookupStartingWith()`
`java.lang.Boolean`	`getLookupSubstring()`
`java.lang.Boolean`	`getMandatory()` Tells if this `CBOAttribute` is mandatory
`java.lang.String`	`getName()`
`java.lang.String`	`getPreCachingHook()` Returns the preCachingHook for this `CBOAttribute` I.e. the name of a method to apply to a cached scalar value before it is cached.
`int`	`getRelationDiscriminator()`
`EntityI`	`getRelationEntity()`
`java.util.Iterator`	`getRelationIterator(java.lang.Object bo)` Returns the iterator containing the relational objects from the given BO
`java.util.Map`	`getRelationObjects(java.lang.Object bo)` Returns the relational objects from the given bo as `TreeMap`
`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()`
`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`	`getSqlManyTable()` Returns the name for the sqltable
`java.lang.String`	`getSqlName()` Returns the sqlname of this `CBOAttribute`, if the sqlname is empty the singular of this `CBOAttribute` will be returned in lowercase
`java.lang.String`	`getTimeZoneProperty()`
`OnlyToDirectedGraphNodeI`	`getToNode()`
`CBOAttributeTypeI`	`getType()`
`java.lang.String`	`getTypedQName()` Returns a nicely formatted `String` containing the entity name, the name of the attribute, and its type or relation information.
`java.lang.String`	`getTypedQName(BOI bo)` Returns a nicely formatted `String` containing the entity name or a concise description of the given BOI, the name of the attribute, and its type or relation information.
`java.lang.String`	`getTypeName()` Returns the type information of this attribute.
`java.lang.Object`	`getValue(java.lang.Object bo)` Returns the value from the given bo by the AttributeAccessor
`java.lang.String`	`getValueAsString(java.lang.Object bo)` Returns the value from the given bo depending on the relation type of the given bo
`java.lang.Object`	`getValueLazy(java.lang.Object bo)` Returns the value from the given bo by the AttributeAccessor, but lazy
`java.lang.String`	`getVar()` Returns the name of this `CBOAttribute` with the first character converted to lowercase
`java.lang.String`	`getVarname()`
`java.lang.String`	`getVersionRelevantDescription()` Returns a Description for this `CBOAttribute` containing the name and the relationtype, will contains relevant details like: dependent, linkOnly, viewOnly, virtual, ... too
`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)` Checks if this `CBOAttribute` has a gui tip for the given tip key, returns `false` if guiTips is null
`boolean`	`hasRelationObject(java.lang.Object bo, java.lang.Object hasMe)` Checks if the given bo contains a relation to the given `Object` hasme
`static void`	`includeTypeDefinition(CBOAttributeTypeI t, electric.xml.Element into)` Copys the `Element`s, definated in the given `CBOAttributeTypeI`, into the given `Element`, by using the copyto-method.
`void`	`info(electric.xml.Element e, java.lang.String msg)` Logs the given `String` msg as information with the messageprefix for the given `Element` _el
`void`	`info(java.lang.String msg)` Logs the given `String` msg as information with the messageprefix for this `CBOAttribute`s `Element` el Convenience method info(e = Element, msg = String)
`boolean`	`isAggregate()` Returns if the `CBOAttribute` has a aggregate function
`boolean`	`isAutotrim()`
`boolean`	`isCached()` Checks if the cache mode of this `CBOAttribute` is not AttributeI.CACHEMODE_NONE
`boolean`	`isCreateInDetailView()`
`boolean`	`isCustomIterator()`
`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()` Returns true if this `CBOAttribute` ignores the back relation.
`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`	`isImplicitedBackRelation()`
`boolean`	`isIndexed()` Returns if this `CBOAttribute` has an index type which isnt CBOAttributeTypeI.INDEX_TYPE_NONE
`boolean`	`isInitialdata()`
`boolean`	`isLazy()`
`boolean`	`isLazyExp()`
`boolean`	`isLinkOnly()` Returns if the edit mode of this `CBOAttribute` is link only (or view only, because AttributeI.EDITMODE_VIEWONLY implements AttributeI.EDITMODE_LINKONLY)
`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()` Returns true if the `CBOAttribute` is persistent.
`boolean`	`isPolymorphicRelation()` Checks if this `CBOAttribute` is polymorphic
`boolean`	`isPrimary()` Returns true if this `CBOAttribute` represents the primary key.
`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`	`isRelationBack()`
`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()` Returns if the `CBOAttribute` shall be serialized
`boolean`	`isShared()`
`boolean`	`isUnique()` Returns true if this `CBOAttribute` is unique.
`boolean`	`isViewOnly()` Returns if the edit mode of this `CBOAttribute` is view only
`boolean`	`isVirtual()` Tells if this `CBOAttribute` is virtual.
`boolean`	`isVisible()` Returns whether this `CBOAttribute` instance is visible in the UI.
`boolean`	`isVisible(BOI bo)` Returns whether this `AttributeI` instance is visible in the UI for the specified `BOI`.
`void`	`parseElementComment(electric.xml.Element e)`
`java.lang.Object`	`pgetValue(java.lang.Object bo)` Returns the value from the given bo by the AttributeAccessor
`void`	`processBackRelationDef1(electric.xml.Element e)` Sets the backrelationdefinition to the given Element in the first pass, so it can be accessed in the second pass.
`void`	`processBackRelationDef2()` Defines the backrelation for this `CBOAttribute`.
`void`	`psetValue(java.lang.Object bo, java.lang.Object value)` Sets the given value to the provided business object (bo) using this `CBOAttribute`'s AttributeAccessor.
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object removeIt)` Removes the given `Object` as a relational `Object` from the provided business object (bo).
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object removeIt, WriteConstraintsOverriderI overrider)` Removes the given `Object` as a relational `Object` from the provided business object (bo).
`void`	`replaceRelationObject(java.lang.Object bo, java.lang.Object newObject)`
`void`	`setAggregateFunction(java.lang.String $89)`
`void`	`setAggregateOf(java.lang.String $91)`
`void`	`setAggregateParameters(java.lang.String $90)`
`void`	`setAnalyzedForFTS(java.lang.Boolean $96)`
`void`	`setAutotrim(boolean $81)`
`void`	`setBackAttribute(AttributeI $73)`
`void`	`setBackName(java.lang.String $52)`
`void`	`setBackRelationDef(electric.xml.Element $74)`
`void`	`setComment(java.lang.String $94)`
`void`	`setCopyPolicy(int newCopyPolicy)` Sets the copy policy for this `CBOAttribute`
`void`	`setCreateInDetailView(boolean $76)`
`void`	`setCustomIterator(boolean $64)`
`void`	`setCustomIteratorNotCaching(boolean $65)`
`void`	`setDef(java.lang.String $57)`
`void`	`setDepend(boolean $66)`
`void`	`setDisplayFormat(java.lang.String $55)`
`void`	`setEditable(boolean b)`
`void`	`setEditmode(int newEditmode)` Sets the edit mode for this `CBOAttribute`
`void`	`setEl(electric.xml.Element $50)`
`void`	`setEntity(EntityI $51)`
`void`	`setExpectedWidth(int $79)`
`void`	`setExplicitSingular(java.lang.String $53)`
`void`	`setFTSAnalyzer(java.lang.String $97)`
`void`	`setFTSBoost(java.lang.Float $98)`
`void`	`setGuiTips(java.util.Map<java.lang.String,java.lang.String> $78)`
`void`	`setIgnoreBackRelation(boolean $71)`
`void`	`setImplicitedBackRelation(boolean $75)`
`void`	`setIndexedForFTS(java.lang.Boolean $95)`
`void`	`setIndexType(int v)` Sets the index type for this `CBOAttribute`
`void`	`setIndexType(java.lang.String v)` sets index type from `CBOAttributeTypeI` for the given type `String`
`void`	`setInitialdata(boolean $92)`
`void`	`setItemProperty(java.lang.String $77)`
`void`	`setLazy(boolean $62)`
`void`	`setLazyExp(boolean $63)`
`void`	`setMandatory(boolean newMandatory)` Sets the mandatory of the `CBOAttribute`
`void`	`setManyRelation(boolean $68)`
`void`	`setName(java.lang.String s)`
`void`	`setOmitOnCopy(boolean $58)`
`void`	`setReadonly(int newReadonly)`
`void`	`setRelation(boolean $67)`
`void`	`setRelationBack(boolean $72)`
`void`	`setRelationDiscriminator(int $93)`
`void`	`setRelationEntity(EntityI $70)`
`void`	`setRelationType(java.lang.String $69)`
`void`	`setReportAlias(java.lang.String $88)`
`void`	`setReportManySort(java.lang.String $87)`
`void`	`setReportPosition(java.lang.Integer $85)`
`void`	`setReportRelativeWidth(int $84)`
`void`	`setReportSort(java.lang.String $86)`
`void`	`setReportVisible(boolean $83)`
`void`	`setSelectionFilter(java.lang.String $80)`
`void`	`setShared(boolean $56)`
`void`	`setSingular(java.lang.String $54)`
`void`	`setSqlName(java.lang.String s)`
`void`	`setTimeZoneProperty(java.lang.String $82)`
`void`	`setType(CBOAttributeTypeI $60)`
`void`	`setTypeName(java.lang.String $59)`
`void`	`setValue(java.lang.Object bo, java.lang.Object value)` Sets the given value to the provided business object (bo) using this `CBOAttribute`'s AttributeAccessor.
`void`	`setValue(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)` Sets the given value to the provided business object (bo) using this `CBOAttribute`'s AttributeAccessor.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value)` Sets the given value as a `String` in this attribute of the provided business object.
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value, boolean checkConstraints)` Sets the given value as a `String` in this attribute of the provided business object.
`void`	`setVarname(java.lang.String $61)`
`void`	`setVisible(boolean b)`
`java.lang.String`	`toString()` Returns a `String` with a key-value-pairing of the private and indirect properties of the `CBOAttribute` i.e.: ['name=value''backName=value''singular=value']
`static java.lang.String`	`var2name(java.lang.String v)` Static method for converting a variable name back to an attribute name
`void`	`warn(electric.xml.Element e, java.lang.String msg)` Logs the given `String` msg as warning with the messageprefix for the given `Element` _el
`void`	`warn(java.lang.String msg)` Logs the given `String` msg as warning with the messageprefix for this `CBOAttribute`s `Element` el Convenience method warn(e = Element, msg = String)

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

Methods inherited from interface de.ipcon.schema.AttributeI
getContainingElementName, getQName, getQName, isServerCalculated, toAttributePath, toNiceString

Methods inherited from interface de.ipcon.schema.BasicAttributeI
getClazz, isArray

- Constructor Detail
  - CBOAttribute
```
public CBOAttribute(EntityI _entity,
                    AttributeTemplate template)
```
    Constructor for CBOAttribute
    
    Parameters:
    
    _enity - the entity for which this attribute is built. Uses the entity schema and sets a reference for later use.
    
    template - the template from which this CBOAttribute should be created. The template supports a subset of the XML nodes and attributes the CBOAttribute supports, so we can use this as a basis.
  - CBOAttribute
```
public CBOAttribute(EntityI _entity,
                    electric.xml.Element _el)
```
    Constructor for this CBOAttribute
    
    Parameters:
    
    _entity - the Entity to get the Schema for getting the AttributeTypes for
    
    _el - the Element to copy Attributes and Elements from
- Method Detail
  - var2name
```
public static java.lang.String var2name(java.lang.String v)
```
    Static method for converting a variable name back to an attribute name
    
    Parameters:
    
    v - the variable name to convert back to an attribute name
    
    Returns:
    
    the attribute name that was converted back from the passed variable name
    
    See Also:
    
    getVar()
  - forgetXMLDefinition
```
public void forgetXMLDefinition()
```
    Resets the local Element in el to null.
  - includeTypeDefinition
```
public static void includeTypeDefinition(CBOAttributeTypeI t,
                                         electric.xml.Element into)
```
    Copys the Elements, definated in the given CBOAttributeTypeI, into the given Element, by using the copyto-method. works recursivly on the base of the CBOAttributeTypeI as long as such one exist, so Elements definated in the base will be copied to
    
    Parameters:
    
    t - the CBOAttributeTypeI to copy the definated Elements from
    
    into - the Element to copy the definated Elements from t to
  - copyTo
```
public static void copyTo(electric.xml.Element src,
                          electric.xml.Element dest)
```
    Copys the AttributeObjects and Elements from Element "src" to Element "dest", works recursivly over the copied Elements too, so copied Elements will have their AttributeObjects and Elements copied too (and so on)
    
    Parameters:
    
    src - the source Element to copy from
    
    dest - the destination Element to copy from
  - processBackRelationDef1
```
public void processBackRelationDef1(electric.xml.Element e)
```
    Sets the backrelationdefinition to the given Element in the first pass, so it can be accessed in the second pass.
    
    Parameters:
    
    e - the Element to set as backRelation
    
    Throws:
    
    java.lang.IllegalArgumentException - if no relationType is set for this CBOAttribute
  - parseElementComment
```
public void parseElementComment(electric.xml.Element e)
```
  - checkValidName
```
public void checkValidName()
                    throws AttributeDefinitionException
```
    Validates the name of this attribute.
    This method performs two types of checks:
    - Basic syntactic validation as defined in SchemaI.checkSyntacticallyValid(Element, String, String).
    - Checks for potential name clashes with internally reserved names.
    Throws:
    
    AttributeDefinitionException - If the attribute name fails any of the validation checks.
  - getVar
```
public java.lang.String getVar()
```
    Returns the name of this CBOAttribute with the first character converted to lowercase
    
    Specified by:
    
    getVar in interface CBOAttributeI
    
    Returns:
    
    the name of this CBOAttribute with the first character converted to lowercase
  - setSqlName
```
public void setSqlName(java.lang.String s)
```
  - getSqlName
```
public java.lang.String getSqlName()
```
    Returns the sqlname of this CBOAttribute, if the sqlname is empty the singular of this CBOAttribute will be returned in lowercase
    
    Returns:
    
    the sqlName or the singular in lowercase of this CBOAttribute
  - getSqlManyTable
```
public java.lang.String getSqlManyTable()
```
    Returns the name for the sqltable
    
    Returns:
    
    the name for the sqltable
    
    Throws:
    
    java.lang.IllegalArgumentException - if this CBOAttribute has no relation or the relationtype is not 'n-m'
  - getEntityName
```
public java.lang.String getEntityName()
```
    Returns the name of the entity as String
    
    Specified by:
    
    getEntityName in interface AttributeI
    
    Returns:
    
    the name of the entity
  - getL10nEntityName
```
public java.lang.String getL10nEntityName()
```
    Specified by:
    
    getL10nEntityName in interface AttributeI
  - getContainingElementPackage
```
public java.lang.String getContainingElementPackage()
```
    Specified by:
    
    getContainingElementPackage in interface BasicAttributeI
  - getL10nSingularKey
```
public java.lang.String getL10nSingularKey()
```
    Returns the singular key of this CBOAttribute for localisation
    
    Specified by:
    
    getL10nSingularKey in interface AttributeI
    
    Returns:
    
    the singular key of this CBOAttribute
  - getL10nSingularVar
```
public java.lang.String getL10nSingularVar()
```
    Returns a localizable String for the singular key of this CBOAttribute (i.e. $R{'KEY'})
    
    Specified by:
    
    getL10nSingularVar in interface AttributeI
    
    Returns:
    
    the localizable String for the singular key of this CBOAttribute
  - getL10nSingular
```
public java.lang.String getL10nSingular()
```
    Returns the localizated singular of this CBOAttribute
    
    Specified by:
    
    getL10nSingular in interface AttributeI
    
    Returns:
    
    the localizated singular of this CBOAttribute
  - getL10nNameKey
```
public java.lang.String getL10nNameKey()
```
    Returns the name key of this CBOAttribute if its no manyrelation or readonly, elseway it returns the singular + '-s'
    
    Specified by:
    
    getL10nNameKey in interface AttributeI
    
    Returns:
    
    the name key of this CBOAttribute, depending on his relation and/or readonly
  - getL10nNameVar
```
public java.lang.String getL10nNameVar()
```
    Returns a localizable String for the name of this CBOAttribute (i.e. $R{'NAME-s'})
    
    Specified by:
    
    getL10nNameVar in interface AttributeI
    
    Returns:
    
    the localizable String for the name of this CBOAttribute
  - getL10nName
```
public java.lang.String getL10nName()
```
    Returns the localizated name of this CBOAttribute by his name key
    
    Specified by:
    
    getL10nName in interface AttributeI
    
    Returns:
    
    the localizated name of this CBOAttribute
  - setName
```
public void setName(java.lang.String s)
```
  - getFilter
```
public javax.swing.text.DocumentFilter getFilter(java.util.ArrayList inputFormats)
```
    Returns the filter from this CBOAttribute types by the given inputformats
    
    Parameters:
    
    inputFormats - the input formats for the DocumentFilter
    
    Returns:
    
    the DocumentFilter from this CBOAttribute type for the given inputformats
  - getDef
```
public java.lang.String getDef()
```
    Returns the Java code for building a default for this CBOAttribute as given in the attribute definition with fallback to the one given in the type.
  - isIgnoreBackRelation
```
public boolean isIgnoreBackRelation()
```
    Returns true if this CBOAttribute ignores the back relation.
    
    Specified by:
    
    isIgnoreBackRelation in interface AttributeI
    
    Returns:
    
    true if this CBOAttribute explicitly ignores the back relation or if relationEntity and entity are not null and isPersistent() of relationEntity and entity are different, false otherwise.
  - setReadonly
```
public void setReadonly(int newReadonly)
```
  - 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.
  - isVirtual
```
public boolean isVirtual()
```
    Tells if this CBOAttribute is virtual.
    
    Specified by:
    
    isVirtual in interface BasicAttributeI
    
    Returns:
    
    true if this CBOAttribute is a virtual attribute, else false, if not an aggregate.
  - isSerialized
```
public boolean isSerialized()
```
    Returns if the CBOAttribute shall be serialized
    
    Specified by:
    
    isSerialized in interface AttributeI
    
    Returns:
    
    true if this CBOAttribute shall be serialized
  - isPersistent
```
public boolean isPersistent()
```
    Returns true if the CBOAttribute is persistent. If the entity of this CBOAttribute is non-persistent but has a subentity which is persistent, the attribute is actually persistent and true is returned as well. If the attribute is a relation and the relation entity is non-persistent and has no subentity which is persistent, the attribute is non-persistent and false will be returned.
    
    Specified by:
    
    isPersistent in interface AttributeI
    
    Returns:
    
    true if this CBOAttribute is persistent
  - isLinkOnly
```
public boolean isLinkOnly()
```
    Returns if the edit mode of this CBOAttribute is link only (or view only, because AttributeI.EDITMODE_VIEWONLY implements AttributeI.EDITMODE_LINKONLY)
    
    Specified by:
    
    isLinkOnly in interface AttributeI
    
    Returns:
    
    true if the edit mode of this CBOAttribute is link only
  - isViewOnly
```
public boolean isViewOnly()
```
    Returns if the edit mode of this CBOAttribute is view only
    
    Specified by:
    
    isViewOnly in interface AttributeI
    
    Returns:
    
    true if the edit mode of this CBOAttribute is view only
  - getEditmode
```
public int getEditmode()
```
    Returns the edit mode for this CBOAttribute if the edit mode is undefined, and a relation entity of this CBOAttribute exists and is link only and this CBOAttribute is not depending, the editmode will be set to link only Before getting returned
    
    Specified by:
    
    getEditmode in interface AttributeWithUIConfigurationI
    
    Returns:
    
    the edit mode for this CBOAttribute
  - setEditmode
```
public void setEditmode(int newEditmode)
```
    Sets the edit mode for this CBOAttribute
    
    Specified by:
    
    setEditmode in interface AttributeWithUIConfigurationI
    
    Parameters:
    
    newEditmode - the edit mode to set
  - getMandatory
```
public java.lang.Boolean getMandatory()
```
    Tells if this CBOAttribute is mandatory
    
    Returns:
    
    true if this CBOAttribute is mandatory
  - 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.
  - checkMandatoryValid
```
public boolean checkMandatoryValid(boolean mandatoryToCheck)
```
    Performs a check and tells if the mandatory setting on this CBOAttribute makes sense. I.e.: if the attribute is null and set to readonly or not editable, mandatory makes no sense. Or: Not visible in GUI - mandatory is meaningless!
    
    Returns:
    
    true if this CBOAttribute is mandatory.
  - checkMandatoryValid
```
public boolean checkMandatoryValid(boolean mandatoryToCheck,
                                   BOI bo)
```
  - setMandatory
```
public void setMandatory(boolean newMandatory)
```
    Sets the mandatory of the CBOAttribute
    
    Specified by:
    
    setMandatory in interface AttributeWithUIConfigurationI
    
    Parameters:
    
    newMandatory - the mandatory to set on the CBOAttribute
  - getGuiTip
```
public java.lang.String getGuiTip()
```
    Returns the Gui Tips for this CBOAttribute as a key:value-paired String If the value is null or empty only the key will be used instead of the pairing IMPORTANT: for backwards compatibility with old guiTip-String, esp. for Equinox
    
    Returns:
    
    the Gui Tips for this CBOAttribute as a key:value-paired String
  - hasGuiTip
```
public boolean hasGuiTip(java.lang.String tip)
```
    Checks if this CBOAttribute has a gui tip for the given tip key, returns false if guiTips is null
    
    Specified by:
    
    hasGuiTip in interface AttributeI
    
    Parameters:
    
    tip - the key to check
    
    Returns:
    
    true if a gui tip with the given key exist
  - getGuiTip
```
public java.lang.String getGuiTip(java.lang.String tip)
```
    Returns the gui tip for the given tip key, returns null if guiTips is null
    
    Specified by:
    
    getGuiTip in interface AttributeI
    
    Parameters:
    
    tip - the key to get gui tip for
    
    Returns:
    
    the gui tip as String
  - getGuiTipAsInt
```
public int getGuiTipAsInt(java.lang.String tip)
```
    Returns the gui tip for the given tip key as int
    
    Specified by:
    
    getGuiTipAsInt in interface AttributeI
    
    Parameters:
    
    tip - the key to get gui tip for
    
    Returns:
    
    the gui tip as int
    
    Throws:
    
    IRuntimeException - if the tip couldnt be returned as int
  - getFromTemplate
```
public AttributeTemplate getFromTemplate()
```
  - setVisible
```
public void setVisible(boolean b)
```
    Specified by:
    
    setVisible in interface AttributeWithUIConfigurationI
  - isVisible
```
public boolean isVisible()
```
    Returns whether this CBOAttribute instance is visible in the UI. Defaults to true if no explicit value is set.
    
    Specified by:
    
    isVisible in interface AttributeI
    
    Specified by:
    
    isVisible in interface AttributeWithUIConfigurationI
    
    Returns:
    
    true if this CBOAttribute instance is visible in the UI or no explicit value is set.
  - 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.
  - 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.
  - 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
  - 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
  - getLookupProperty
```
public java.lang.String getLookupProperty()
```
    Returns a comma-separated list of attributes/attribute chains to be searched during "fast input"; if the result is unique, the system automatically selects it upon entering a "fast input".
    
    Specified by:
    
    getLookupProperty in interface AttributeI
    
    Returns:
    
    the lookup property for this CBOAttribute
  - getLookupSubstring
```
public java.lang.Boolean getLookupSubstring()
```
    Specified by:
    
    getLookupSubstring in interface AttributeI
    
    Returns:
    
    true if the CBOAttribute is also treating a substring only match for the lookup property as a match
  - getLookupStartingWith
```
public java.lang.Boolean getLookupStartingWith()
```
    Specified by:
    
    getLookupStartingWith in interface AttributeI
    
    Returns:
    
    true if the CBOAttribute requires the lookup property to start with the entered "fast input"
  - getLookupCaseSensitive
```
public java.lang.Boolean getLookupCaseSensitive()
```
    Specified by:
    
    getLookupCaseSensitive in interface AttributeI
    
    Returns:
    
    true if the CBOAttribute compares the lookup property case-sensitive with the entered "fast input"
  - 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
  - isAggregate
```
public boolean isAggregate()
```
    Returns if the CBOAttribute has a aggregate function
    
    Returns:
    
    true if this CBOAttribute has a aggregate function
  - getCacheMode
```
public int getCacheMode()
```
    Returns the cache mode of this CBOAttribute
    
    Returns:
    
    the cache mode of this CBOAttribute
  - isCached
```
public boolean isCached()
```
    Checks if the cache mode of this CBOAttribute is not AttributeI.CACHEMODE_NONE
    
    Specified by:
    
    isCached in interface AttributeI
    
    Returns:
    
    true if the cache mode of this CBOAttribute is not AttributeI.CACHEMODE_NONE
  - getPreCachingHook
```
public java.lang.String getPreCachingHook()
```
    Returns the preCachingHook for this CBOAttribute I.e. the name of a method to apply to a cached scalar value before it is cached. That method is typically implemented in the class of the entity that defines this vattr (alternatively, relatively far "up" if it is to be used several times in the schema, e.g. in the TBO class). The method signature of that method must accept two parameters: first the attribute name and second the value to be cached in the correct schema-defined type. The method must also return that type. That way, to be cached values can be prepared, e.g. slim, convert a BigDecimal to a CompactBigDecimal, etc.
    
    Returns:
    
    the preCachingHook for this CBOAttribute as String
  - 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
  - getIndexType
```
public int getIndexType()
```
    Returns the index type of this CBOAttribute if type is INDEX_TYPE_AUTO the index type will be resolved by checking the lowinstancecount of a relation if exists
    
    Returns:
    
    the index type of this CBOAttribute
  - setIndexType
```
public void setIndexType(java.lang.String v)
```
    sets index type from CBOAttributeTypeI for the given type String
    
    Parameters:
    
    v - the index type to get from CBOAttributeTypeI
    
    Throws:
    
    java.lang.IllegalArgumentException - if the index type coulndt be resolved from CBOAttributeTypeI
  - setIndexType
```
public void setIndexType(int v)
```
    Sets the index type for this CBOAttribute
    
    Parameters:
    
    v - the index type to set
  - isIndexed
```
public boolean isIndexed()
```
    Returns if this CBOAttribute has an index type which isnt CBOAttributeTypeI.INDEX_TYPE_NONE
    
    Specified by:
    
    isIndexed in interface AttributeI
    
    Returns:
    
    true if the index type of this CBOAttribute isnt CBOAttributeTypeI.INDEX_TYPE_NONE
  - isPrimary
```
public boolean isPrimary()
```
    Returns true if this CBOAttribute represents the primary key.
    
    Returns:
    
    true if this CBOAttribute represents the primary key
  - getCustomIndexVersion
```
public int getCustomIndexVersion()
```
  - getCustomIndexDefinition
```
public java.lang.String getCustomIndexDefinition()
```
  - isUnique
```
public boolean isUnique()
```
    Returns true if this CBOAttribute is unique. If unique is not set, this method looks on the unique flag of the type of this CBOAttribute.
    
    Returns:
    
    true if CBOAttribute or his type is unique
  - getCopyPolicy
```
public int getCopyPolicy()
```
    Returns the copy policy of this CBOAttribute
    
    Specified by:
    
    getCopyPolicy in interface AttributeI
    
    Returns:
    
    the copy policy of this CBOAttribute
  - setCopyPolicy
```
public void setCopyPolicy(int newCopyPolicy)
```
    Sets the copy policy for this CBOAttribute
    
    Parameters:
    
    newCopyPolicy - the policy to set
  - isPolymorphicRelation
```
public boolean isPolymorphicRelation()
```
    Checks if this CBOAttribute is polymorphic
    
    Specified by:
    
    isPolymorphicRelation in interface AttributeI
    
    Returns:
    
    true if this CBOAttribute has an relation and the relationEntity has subentities
  - getValue
```
public final java.lang.Object getValue(java.lang.Object bo)
```
    Returns the value from the given bo by the AttributeAccessor
    
    Specified by:
    
    getValue in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the value from
    
    Returns:
    
    the value from the given bo as Object
    
    Throws:
    
    IRuntimeException - when getting value from the bo fails
  - getValueLazy
```
public final java.lang.Object getValueLazy(java.lang.Object bo)
```
    Returns the value from the given bo by the AttributeAccessor, but lazy
    
    Specified by:
    
    getValueLazy in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the value from
    
    Returns:
    
    the value from the given bo as Object
    
    Throws:
    
    IRuntimeException - when getting value from the bo fails
  - pgetValue
```
public final java.lang.Object pgetValue(java.lang.Object bo)
```
    Returns the value from the given bo by the AttributeAccessor
    
    Specified by:
    
    pgetValue in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the value from
    
    Returns:
    
    the value from the given bo as Object
    
    Throws:
    
    IRuntimeException - when getting value from the bo fails
  - getValueAsString
```
public java.lang.String getValueAsString(java.lang.Object bo)
```
    Returns the value from the given bo depending on the relation type of the given bo
    
    Specified by:
    
    getValueAsString in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the value from
    
    Returns:
    
    the value as String
    
    Throws:
    
    IRuntimeException - if: bo is a many relation but not a Map the describe() method for the given bo couldnt be found
  - setValue
```
public final void setValue(java.lang.Object bo,
                           java.lang.Object value)
```
    Sets the given value to the provided business object (bo) using this CBOAttribute's AttributeAccessor.
    
    Specified by:
    
    setValue in interface AttributeI
    
    Parameters:
    
    bo - The business object to set the value for.
    
    value - The value to set for the given business object.
    
    Throws:
    
    IRuntimeException - If the business object is read-only or if the value couldn't be set for the business object.
  - setValue
```
public final void setValue(java.lang.Object bo,
                           java.lang.Object value,
                           WriteConstraintsOverriderI overrider)
```
    Sets the given value to the provided business object (bo) using this CBOAttribute's AttributeAccessor.
    
    Specified by:
    
    setValue in interface AttributeI
    
    Parameters:
    
    bo - The business object to set the value for.
    
    value - The value to set for the given business object.
    
    overrider - If non-null, the passed WriteConstraintsOverriderI will be asked if the change shall be applied regardless of constraints.
    
    Throws:
    
    IRuntimeException - If the business object is read-only and constraints need to be checked, or if the value couldn't be set for the business object.
  - psetValue
```
public final void psetValue(java.lang.Object bo,
                            java.lang.Object value)
```
    Sets the given value to the provided business object (bo) using this CBOAttribute's AttributeAccessor. This method performs no checks for read-only state or casting the value to the destination type.
    
    Specified by:
    
    psetValue in interface AttributeI
    
    Parameters:
    
    bo - The business object to set the value for.
    
    value - The value to set for the given business object.
    
    Throws:
    
    IRuntimeException - If the value couldn't be set for the business object.
  - setValueAsString
```
public void setValueAsString(java.lang.Object bo,
                             java.lang.String value)
```
    Sets the given value as a String in this attribute of the provided business object. This method performs checks if the given value adheres to the constraints of the type of this attribute.
    
    Specified by:
    
    setValueAsString in interface AttributeI
    
    Parameters:
    
    bo - The business object to set the given value in.
    
    value - The value to set as a String.
  - setValueAsString
```
public void setValueAsString(java.lang.Object bo,
                             java.lang.String value,
                             boolean checkConstraints)
```
    Sets the given value as a String in this attribute of the provided business object.
    
    Specified by:
    
    setValueAsString in interface AttributeI
    
    Parameters:
    
    bo - The business object to set the given value in.
    
    value - The value to set as a String.
    
    checkConstraints - If true, we check if the given value adheres to the constraints of the type of this attribute.
  - getRelationObjects
```
public java.util.Map getRelationObjects(java.lang.Object bo)
```
    Returns the relational objects from the given bo as TreeMap
    
    Specified by:
    
    getRelationObjects in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the relational objects from
    
    Returns:
    
    the relational objects as TreeMap
    
    Throws:
    
    IRuntimeException - if the relational objects for the given bo couldnt be retrieved by the AttributeAccessor
  - getRelationIterator
```
public java.util.Iterator getRelationIterator(java.lang.Object bo)
```
    Returns the iterator containing the relational objects from the given BO
    
    Specified by:
    
    getRelationIterator in interface AttributeI
    
    Parameters:
    
    bo - the bo to get the relational iterator from
    
    Returns:
    
    the iterator of this relation
    
    Throws:
    
    IRuntimeException - if the iterator fpr the given bo could not be retrieved by the AttributeAccessor
  - addRelationObject
```
public void addRelationObject(java.lang.Object bo,
                              java.lang.Object newObject)
```
    Adds the given Object as a relational Object to the provided business object (bo).
    
    Specified by:
    
    addRelationObject in interface AttributeI
    
    Parameters:
    
    bo - The business object to add the relational Object to.
    
    newObject - The Object to add as a relational Object.
    
    Throws:
    
    IRuntimeException - If: - This CBOAttribute is not a many relation. - The given business object is read-only. - The given Object couldn't be added by the AttributeAccessor.
  - addRelationObject
```
public void addRelationObject(java.lang.Object bo,
                              java.lang.Object newObject,
                              WriteConstraintsOverriderI overrider)
```
    Adds the given Object as a relational Object to the provided business object (bo).
    
    Specified by:
    
    addRelationObject in interface AttributeI
    
    Parameters:
    
    bo - The business object to add the relational Object to.
    
    newObject - The Object to add as a relational Object.
    
    overrider - If non-null, the passed WriteConstraintsOverriderI will be asked if the change shall be applied regardless of constraints.
    
    Throws:
    
    IRuntimeException - If: - This CBOAttribute is not a many relation. - The given business object is read-only. - The given Object couldn't be added by the AttributeAccessor.
  - replaceRelationObject
```
public void replaceRelationObject(java.lang.Object bo,
                                  java.lang.Object newObject)
```
  - removeRelationObject
```
public void removeRelationObject(java.lang.Object bo,
                                 java.lang.Object removeIt)
```
    Removes the given Object as a relational Object from the provided business object (bo).
    
    Specified by:
    
    removeRelationObject in interface AttributeI
    
    Parameters:
    
    bo - The business object to remove the relational Object from.
    
    removeIt - The Object to remove as a relational Object.
    
    Throws:
    
    IRuntimeException - If: - This CBOAttribute is not a many relation. - The given business object is read-only. - The given Object couldn't be removed by the AttributeAccessor.
  - removeRelationObject
```
public void removeRelationObject(java.lang.Object bo,
                                 java.lang.Object removeIt,
                                 WriteConstraintsOverriderI overrider)
```
    Removes the given Object as a relational Object from the provided business object (bo).
    
    Specified by:
    
    removeRelationObject in interface AttributeI
    
    Parameters:
    
    bo - The business object to remove the relational Object from.
    
    removeIt - The Object to remove as a relational Object.
    
    overrider - If non-null, the passed WriteConstraintsOverriderI will be asked if the change shall be applied regardless of constraints.
    
    Throws:
    
    IRuntimeException - If: - This CBOAttribute is not a many relation. - The given business object is read-only. - The given Object couldn't be removed by the AttributeAccessor.
  - hasRelationObject
```
public boolean hasRelationObject(java.lang.Object bo,
                                 java.lang.Object hasMe)
```
    Checks if the given bo contains a relation to the given Object hasme
    
    Specified by:
    
    hasRelationObject in interface AttributeI
    
    Parameters:
    
    bo - the bo to check if it contains a relation to the given Object hasme
    
    hasMe - the Object to check for existing as relation in the given bo
    
    Returns:
    
    true if the given bo has a relation to the given Object hasme
  - clearRelation
```
public void clearRelation(java.lang.Object bo)
```
    Removes all relational Objects from the given bo
    
    Parameters:
    
    bo - the bo to remove all relational Objects from
    
    Throws:
    
    IRuntimeException - if the attribute is no many relation or is readonly and cancelCheckConstrains() for is false
  - buildPass2
```
public void buildPass2()
```
    Does some second pass parsing of entity and attribute definitions, including consistency / sanity checks. If this is a manyrelation, then the type should refer to an existing entity.
    
    Throws:
    
    AttributeDefinitionException - if theres no entity with the typename of this CBOAttribute in the schema.
  - processBackRelationDef2
```
public void processBackRelationDef2()
```
    Defines the backrelation for this CBOAttribute. Processes the backRelationDef set in the first pass and does some sanity checks. If these checks are successful, then the backrelation-attribute to this entity is constructed. Checks include: - unknown attribute definitions, only name, singular, dependent, itemProperty, omitOnCopy is allowed. - invalid relationtype definition, only one of 1-n, n-1, n-m is allowed. -
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Document to read the backRelationDefinition from could be find/parsed/...
    
    AttributeDefinitionException - if there was unknown attributes or relationtypes in the backrelation, or the typename is unknown in the schema of this CBOAttribute entity
  - checkSingularAbsenceForNTo1
```
public void checkSingularAbsenceForNTo1()
                                 throws AttributeDefinitionException
```
    This method will signal an AttributeDefinitionException if we are an n-1 relation with an explicit singular set in the schema-file.
    
    Throws:
    
    AttributeDefinitionException - if relationType is 'n-1' and explicitSingular is not ''
  - checkItemProperty
```
public void checkItemProperty()
                       throws AttributeDefinitionException
```
    Processes a possible existing itemProperty definition if this is a manyrelation and checks if it is a valid attribute (chain) on the relationEntity. If no itemProperty is defined, nothing is checked.
    
    Throws:
    
    AttributeDefinitionException - if the itemProperty is an invalid attribute-chain on relationEntity.
  - checkRelationDiscriminatorConsistency
```
public void checkRelationDiscriminatorConsistency()
                                           throws AttributeDefinitionException
```
    Checks and ensures the consistency of relationDiscriminator in this and back attribute.
    
    Throws:
    
    AttributeDefinitionException - if they are explicitly set to different values
  - 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<java.lang.Object>
    
    Parameters:
    
    o - the object to compare
    
    Returns:
    
    a negative integer, zero, or a positive integer
  - toString
```
public java.lang.String toString()
```
    Returns a String with a key-value-pairing of the private and indirect properties of the CBOAttribute i.e.: ['name=value''backName=value''singular=value']
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a key-value-paired String
  - getTypedQName
```
public java.lang.String getTypedQName()
```
    Returns a nicely formatted String containing the entity name, the name of the attribute, and its type or relation information. If the attribute is a relation, the returned String will be concatenated with the relation type; otherwise, it will be concatenated with the type name.
    
    Specified by:
    
    getTypedQName in interface AttributeI
    
    Returns:
    
    A nicely formatted String containing the entity name, the name of the attribute, and its type or relation information.
  - getTypedQName
```
public java.lang.String getTypedQName(BOI bo)
```
    Returns a nicely formatted String containing the entity name or a concise description of the given BOI, the name of the attribute, and its type or relation information. If a concrete BOI instance is given, its concise description will be used as a prefix; otherwise, the entity name will be used as the prefix. If the entity of this attribute is null, the String 'no entity' will be prefixed. If the attribute is a relation, the returned String will be concatenated with the relation type; otherwise, it will be concatenated with the type name.
    
    Specified by:
    
    getTypedQName in interface AttributeI
    
    Parameters:
    
    bo - A concrete BOI instance to be included in the description.
    
    Returns:
    
    A nicely formatted String containing the entity name or a concise description of the given BOI, the name of the attribute, and its type or relation information.
  - getVersionRelevantDescription
```
public java.lang.String getVersionRelevantDescription()
```
    Returns a Description for this CBOAttribute containing the name and the relationtype, will contains relevant details like: dependent, linkOnly, viewOnly, virtual, ... too
    
    Returns:
    
    a description for this CBOAttribute containing relevant informations
  - errorMessageWithLine
```
public java.lang.String errorMessageWithLine()
```
    Returns a nice formated error message with the line number the error occurred
    
    Returns:
    
    error message with line number
  - info
```
public void info(java.lang.String msg)
```
    Logs the given String msg as information with the messageprefix for this CBOAttributes Element el Convenience method info(e = Element, msg = String)
    
    Parameters:
    
    msg - the message to use for logging
  - info
```
public void info(electric.xml.Element e,
                 java.lang.String msg)
```
    Logs the given String msg as information with the messageprefix for the given Element _el
    
    Parameters:
    
    msg - the message to use for logging
  - warn
```
public void warn(java.lang.String msg)
```
    Logs the given String msg as warning with the messageprefix for this CBOAttributes Element el Convenience method warn(e = Element, msg = String)
    
    Parameters:
    
    msg - the message to use for logging
  - warn
```
public void warn(electric.xml.Element e,
                 java.lang.String msg)
```
    Logs the given String msg as warning with the messageprefix for the given Element _el
    
    Parameters:
    
    msg - the message to use for logging
  - getFromNode
```
public OnlyToDirectedGraphNodeI getFromNode()
```
    Specified by:
    
    getFromNode in interface AttributeI
    
    Specified by:
    
    getFromNode in interface GraphEdgeI
  - getToNode
```
public OnlyToDirectedGraphNodeI getToNode()
```
    Specified by:
    
    getToNode in interface AttributeI
    
    Specified by:
    
    getToNode in interface GraphEdgeI
  - getEl
```
public electric.xml.Element getEl()
```
  - setEl
```
public void setEl(electric.xml.Element $50)
```
  - getEntity
```
public EntityI getEntity()
```
  - setEntity
```
public void setEntity(EntityI $51)
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface BasicAttributeI
  - getBackName
```
public java.lang.String getBackName()
```
  - setBackName
```
public void setBackName(java.lang.String $52)
```
  - getExplicitSingular
```
public java.lang.String getExplicitSingular()
```
  - setExplicitSingular
```
public void setExplicitSingular(java.lang.String $53)
```
  - getSingular
```
public java.lang.String getSingular()
```
    Specified by:
    
    getSingular in interface BasicAttributeI
  - setSingular
```
public void setSingular(java.lang.String $54)
```
  - getDisplayFormat
```
public java.lang.String getDisplayFormat()
```
  - setDisplayFormat
```
public void setDisplayFormat(java.lang.String $55)
```
  - isShared
```
public boolean isShared()
```
    Specified by:
    
    isShared in interface AttributeI
  - setShared
```
public void setShared(boolean $56)
```
  - setDef
```
public void setDef(java.lang.String $57)
```
  - isOmitOnCopy
```
public boolean isOmitOnCopy()
```
    Specified by:
    
    isOmitOnCopy in interface AttributeI
  - setOmitOnCopy
```
public void setOmitOnCopy(boolean $58)
```
  - 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.
  - setTypeName
```
public void setTypeName(java.lang.String $59)
```
  - getType
```
public CBOAttributeTypeI getType()
```
    Specified by:
    
    getType in interface BasicAttributeI
  - setType
```
public void setType(CBOAttributeTypeI $60)
```
  - getVarname
```
public java.lang.String getVarname()
```
  - setVarname
```
public void setVarname(java.lang.String $61)
```
  - isLazy
```
public boolean isLazy()
```
    Specified by:
    
    isLazy in interface AttributeI
  - setLazy
```
public void setLazy(boolean $62)
```
  - isLazyExp
```
public boolean isLazyExp()
```
  - setLazyExp
```
public void setLazyExp(boolean $63)
```
  - isCustomIterator
```
public boolean isCustomIterator()
```
  - setCustomIterator
```
public void setCustomIterator(boolean $64)
```
  - 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
  - setCustomIteratorNotCaching
```
public void setCustomIteratorNotCaching(boolean $65)
```
  - isDepend
```
public boolean isDepend()
```
    Specified by:
    
    isDepend in interface AttributeI
  - setDepend
```
public void setDepend(boolean $66)
```
  - isRelation
```
public boolean isRelation()
```
    Specified by:
    
    isRelation in interface BasicAttributeI
  - setRelation
```
public void setRelation(boolean $67)
```
  - isManyRelation
```
public boolean isManyRelation()
```
    Specified by:
    
    isManyRelation in interface BasicAttributeI
  - setManyRelation
```
public void setManyRelation(boolean $68)
```
  - 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.
  - setRelationType
```
public void setRelationType(java.lang.String $69)
```
  - getRelationEntity
```
public EntityI getRelationEntity()
```
    Specified by:
    
    getRelationEntity in interface BasicAttributeI
  - setRelationEntity
```
public void setRelationEntity(EntityI $70)
```
  - setIgnoreBackRelation
```
public void setIgnoreBackRelation(boolean $71)
```
  - isRelationBack
```
public boolean isRelationBack()
```
  - setRelationBack
```
public void setRelationBack(boolean $72)
```
  - getBackAttribute
```
public AttributeI getBackAttribute()
```
    Specified by:
    
    getBackAttribute in interface AttributeI
  - setBackAttribute
```
public void setBackAttribute(AttributeI $73)
```
  - getBackRelationDef
```
public electric.xml.Element getBackRelationDef()
```
  - setBackRelationDef
```
public void setBackRelationDef(electric.xml.Element $74)
```
  - isImplicitedBackRelation
```
public boolean isImplicitedBackRelation()
```
  - setImplicitedBackRelation
```
public void setImplicitedBackRelation(boolean $75)
```
  - isCreateInDetailView
```
public boolean isCreateInDetailView()
```
    Specified by:
    
    isCreateInDetailView in interface AttributeI
    
    Specified by:
    
    isCreateInDetailView in interface AttributeWithUIConfigurationI
  - setCreateInDetailView
```
public void setCreateInDetailView(boolean $76)
```
    Specified by:
    
    setCreateInDetailView in interface AttributeWithUIConfigurationI
  - getItemProperty
```
public java.lang.String getItemProperty()
```
    Specified by:
    
    getItemProperty in interface AttributeI
    
    Specified by:
    
    getItemProperty in interface AttributeWithUIConfigurationI
  - setItemProperty
```
public void setItemProperty(java.lang.String $77)
```
    Specified by:
    
    setItemProperty in interface AttributeWithUIConfigurationI
  - getGuiTips
```
public java.util.Map<java.lang.String,java.lang.String> getGuiTips()
```
    Specified by:
    
    getGuiTips in interface AttributeI
    
    Specified by:
    
    getGuiTips in interface AttributeWithUIConfigurationI
  - setGuiTips
```
public void setGuiTips(java.util.Map<java.lang.String,java.lang.String> $78)
```
    Specified by:
    
    setGuiTips in interface AttributeWithUIConfigurationI
  - getExpectedWidth
```
public int getExpectedWidth()
```
    Specified by:
    
    getExpectedWidth in interface AttributeI
    
    Specified by:
    
    getExpectedWidth in interface AttributeWithUIConfigurationI
  - setExpectedWidth
```
public void setExpectedWidth(int $79)
```
    Specified by:
    
    setExpectedWidth in interface AttributeWithUIConfigurationI
  - setSelectionFilter
```
public void setSelectionFilter(java.lang.String $80)
```
    Specified by:
    
    setSelectionFilter in interface AttributeWithUIConfigurationI
  - isAutotrim
```
public boolean isAutotrim()
```
    Specified by:
    
    isAutotrim in interface AttributeI
    
    Specified by:
    
    isAutotrim in interface AttributeWithUIConfigurationI
  - setAutotrim
```
public void setAutotrim(boolean $81)
```
    Specified by:
    
    setAutotrim in interface AttributeWithUIConfigurationI
  - getTimeZoneProperty
```
public java.lang.String getTimeZoneProperty()
```
    Specified by:
    
    getTimeZoneProperty in interface AttributeI
    
    Specified by:
    
    getTimeZoneProperty in interface AttributeWithUIConfigurationI
  - setTimeZoneProperty
```
public void setTimeZoneProperty(java.lang.String $82)
```
    Specified by:
    
    setTimeZoneProperty in interface AttributeWithUIConfigurationI
  - 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
  - setReportVisible
```
public void setReportVisible(boolean $83)
```
  - 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
  - setReportRelativeWidth
```
public void setReportRelativeWidth(int $84)
```
  - 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
  - setReportPosition
```
public void setReportPosition(java.lang.Integer $85)
```
  - 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"
  - setReportSort
```
public void setReportSort(java.lang.String $86)
```
  - 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"
  - setReportManySort
```
public void setReportManySort(java.lang.String $87)
```
  - 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
  - setReportAlias
```
public void setReportAlias(java.lang.String $88)
```
  - getAggregateFunction
```
public java.lang.String getAggregateFunction()
```
  - setAggregateFunction
```
public void setAggregateFunction(java.lang.String $89)
```
  - getAggregateParameters
```
public java.lang.String getAggregateParameters()
```
  - setAggregateParameters
```
public void setAggregateParameters(java.lang.String $90)
```
  - getAggregateOf
```
public java.lang.String getAggregateOf()
```
  - setAggregateOf
```
public void setAggregateOf(java.lang.String $91)
```
  - isInitialdata
```
public boolean isInitialdata()
```
    Specified by:
    
    isInitialdata in interface AttributeI
  - setInitialdata
```
public void setInitialdata(boolean $92)
```
  - getRelationDiscriminator
```
public int getRelationDiscriminator()
```
  - setRelationDiscriminator
```
public void setRelationDiscriminator(int $93)
```
  - getComment
```
public java.lang.String getComment()
```
    Specified by:
    
    getComment in interface BasicAttributeI
  - setComment
```
public void setComment(java.lang.String $94)
```
  - getIndexedForFTS
```
public java.lang.Boolean getIndexedForFTS()
```
    Specified by:
    
    getIndexedForFTS in interface AttributeI
  - setIndexedForFTS
```
public void setIndexedForFTS(java.lang.Boolean $95)
```
  - getAnalyzedForFTS
```
public java.lang.Boolean getAnalyzedForFTS()
```
    Specified by:
    
    getAnalyzedForFTS in interface AttributeI
  - setAnalyzedForFTS
```
public void setAnalyzedForFTS(java.lang.Boolean $96)
```
  - getFTSAnalyzer
```
public java.lang.String getFTSAnalyzer()
```
    Specified by:
    
    getFTSAnalyzer in interface AttributeI
  - setFTSAnalyzer
```
public void setFTSAnalyzer(java.lang.String $97)
```
  - getFTSBoost
```
public java.lang.Float getFTSBoost()
```
    Specified by:
    
    getFTSBoost in interface AttributeI
  - setFTSBoost
```
public void setFTSBoost(java.lang.Float $98)
```

Class CBOAttribute

Field Summary

Fields inherited from interface de.ipcon.schema.AttributeI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.ipcon.schema.AttributeI

Methods inherited from interface de.ipcon.schema.BasicAttributeI

Constructor Detail

CBOAttribute

CBOAttribute

Method Detail

var2name

forgetXMLDefinition

includeTypeDefinition

copyTo

processBackRelationDef1

parseElementComment

checkValidName

getVar

setSqlName

getSqlName

getSqlManyTable

getEntityName

getL10nEntityName

getContainingElementPackage

getL10nSingularKey

getL10nSingularVar

getL10nSingular

getL10nNameKey

getL10nNameVar

getL10nName

setName

getFilter

getDef

isIgnoreBackRelation

setReadonly

isReadonly

isReadonly

isVirtual

isSerialized

isPersistent

isLinkOnly

isViewOnly

getEditmode

setEditmode

getMandatory

isMandatory

isMandatory

checkMandatoryValid

checkMandatoryValid

setMandatory

getGuiTip

hasGuiTip

getGuiTip

getGuiTipAsInt

getFromTemplate

setVisible

isVisible

isVisible

setEditable

isEditable

isEditable

hasCustomIterator

getSelectionFilter

getLookupProperty

getLookupSubstring

getLookupStartingWith

getLookupCaseSensitive

isForExport

isIgnoredForExport

isSeparateFileForExport

getExportDependentPrimaryKey

isAggregate

getCacheMode

isCached

getPreCachingHook

getCalculationAuthority

getIndexType

setIndexType