de.ipcon.schema

Interface CBOAttributeI

All Superinterfaces:

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

All Known Implementing Classes:

CBOAttribute

public interface CBOAttributeI
extends AttributeI

Special interface exposing extended information for AttributeI for internal use.

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

Modifier and Type	Method and Description
int	getCopyPolicy() Returns the copy policy of this CBOAttributeI
java.lang.String	getCustomIndexDefinition()
int	getCustomIndexVersion()
int	getIndexType() Returns the index type of this CBOAttributeI if type is INDEX_TYPE_AUTO the index type will be resolved by checking the lowinstancecount of a relation if exists
java.lang.String	getSqlManyTable() Returns the name of the associated SQL table
java.lang.String	getSqlName() Returns the SQL column name of this CBOAttributeI.
java.lang.String	getVar() Returns the name of this CBOAttributeI with the first character converted to lowercase
boolean	isIndexed() Returns if this CBOAttributeI has an index type which isnt AttributeTypeI.INDEX_TYPE_NONE
boolean	isPrimary() Returns true if this CBOAttributeI represents the primary key.
boolean	isUnique() Returns true if this CBOAttributeI is unique.
void	setCopyPolicy(int newCopyPolicy) Sets the copy policy for this CBOAttributeI
void	setIndexType(int v) Sets the index type for this CBOAttributeI
void	setIndexType(java.lang.String v) sets index type from AttributeTypeI for the given type String

Methods inherited from interface de.ipcon.schema.AttributeI

addRelationObject, addRelationObject, getAnalyzedForFTS, getBackAttribute, getCalculationAuthority, getContainingElementName, getEntity, getEntityName, getExpectedWidth, getExportDependentPrimaryKey, getFromNode, getFTSAnalyzer, getFTSBoost, getGuiTip, getGuiTipAsInt, getGuiTips, getIndexedForFTS, getItemProperty, getL10nEntityName, getL10nName, getL10nNameKey, getL10nNameVar, getL10nSingular, getL10nSingularKey, getL10nSingularVar, getLookupCaseSensitive, getLookupProperty, getLookupStartingWith, getLookupSubstring, getModulePackages, getOrCreateModulePackagesSet, getQName, getQName, getRelationIterator, getRelationObjects, getReportAlias, getReportManySort, getReportPosition, getReportRelativeWidth, getReportSort, getSchema, getSelectionFilter, getTimeZoneProperty, getToNode, getTypedQName, getTypedQName, getValue, getValueAsString, getValueLazy, hasGuiTip, hasRelationObject, isAutotrim, isCached, isCoreNative, isCreateInDetailView, isCustomIteratorNotCaching, isDepend, isEditable, isEditable, isForExport, isIgnoreBackRelation, isIgnoredForExport, isInitialdata, isLazy, isLinkOnly, isMandatory, isMandatory, isModuleNative, isOmitOnCopy, isPartOfModule, isPersistent, isPolymorphicRelation, isProjectNative, isReadonly, isReportVisible, isSeparateFileForExport, isSerialized, isServerCalculated, isShared, isViewOnly, isVisible, isVisible, pgetValue, psetValue, removeRelationObject, removeRelationObject, setValue, setValue, setValueAsString, setValueAsString, toAttributePath, toNiceString

Methods inherited from interface de.ipcon.schema.AttributeWithUIConfigurationI

getEditmode, setAutotrim, setCreateInDetailView, setEditable, setEditmode, setExpectedWidth, setGuiTips, setItemProperty, setMandatory, setSelectionFilter, setTimeZoneProperty, setVisible

Methods inherited from interface de.ipcon.schema.BasicAttributeI

getClazz, getComment, getContainingElementPackage, getName, getRelationEntity, getRelationType, getSingular, getType, getTypeName, hasCustomIterator, isArray, isManyRelation, isReadonly, isRelation, isVirtual

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getVar

java.lang.String getVar()

Returns the name of this CBOAttributeI with the first character converted to lowercase

Returns:

the name of this CBOAttributeI with the first character converted to lowercase

getIndexType

int getIndexType()

Returns the index type of this CBOAttributeI 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 CBOAttributeI

setIndexType

void setIndexType(java.lang.String v)

sets index type from AttributeTypeI for the given type String

Parameters:

v - the index type to get from AttributeTypeI

Throws:

java.lang.IllegalArgumentException - if the index type coulndt be resolved from AttributeTypeI

setIndexType

void setIndexType(int v)

Sets the index type for this CBOAttributeI

Parameters:

v - the index type to set

isIndexed

boolean isIndexed()

Returns if this CBOAttributeI has an index type which isnt AttributeTypeI.INDEX_TYPE_NONE

Specified by:

isIndexed in interface AttributeI

Returns:

true if the index type of this CBOAttributeI isnt AttributeTypeI.INDEX_TYPE_NONE

isPrimary

boolean isPrimary()

Returns true if this CBOAttributeI represents the primary key.

Returns:

true if this CBOAttributeI represents the primary key

getCustomIndexVersion

int getCustomIndexVersion()

getCustomIndexDefinition

java.lang.String getCustomIndexDefinition()

isUnique

boolean isUnique()

Returns true if this CBOAttributeI is unique. If unique is not set, this method looks on the unique flag of the type of this CBOAttributeI.

Returns:

true if CBOAttributeI or his type is unique

getCopyPolicy

int getCopyPolicy()

Returns the copy policy of this CBOAttributeI

Specified by:

getCopyPolicy in interface AttributeI

Returns:

the copy policy of this CBOAttributeI

setCopyPolicy

void setCopyPolicy(int newCopyPolicy)

Sets the copy policy for this CBOAttributeI

Parameters:

newCopyPolicy - the policy to set

getSqlName

java.lang.String getSqlName()

Returns the SQL column name of this CBOAttributeI. If the SQL column name is empty the singular of this CBOAttributeI will be returned in lower case.

Returns:

the SQL column name or the singular in lower case of this CBOAttributeI

getSqlManyTable

java.lang.String getSqlManyTable()

Returns the name of the associated SQL table

Returns:

the name of the associated SQL table

Throws:

java.lang.IllegalArgumentException - if this CBOAttributeI has no relation or the relation type is not 'n-m'