Interface DBTableColumn

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, DBColumn, DBSQLObject, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELFeature, ELMultiplicityAble, ELMultiplicityAbleTypedElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELProperty, ELRedefAble, ELStructFeature, ELTypedElement, ELUUIDAble, ELValueContainerAble, ELViewNavigAble, IMFeature, IMProperty, IMStructuralFeature, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface DBTableColumn
extends DBColumn

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DBTableColumn.VAttr

Method Summary

Modifier and Type	Method	Description
List<DBForeignKey>	getDBForeignKey(K_CONTROL_OPTION... behaviourFlags)	List of foreign keys that use this column.
List<DBIndex>	getDBIndex(K_CONTROL_OPTION... behaviourFlags)	List of indices that use this column.
List<DBIndex>	getDBIndex(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getDBIndex and filters its return values according to the given stereotype value.
List<DBTableColumn>	getDBKeyRelationshipColumn()	List of foreign key columns, referencing this unique key column.
List<DBTableColumn>	getDBKeyRelationshipColumnRecursive(DBTable refObj)	List of foreign key columns, referencing this unique key column indirectly.
IMSemanticDataType	getDBTypingSemanticDataType()	The semantic data type that types this DBTableColumn.
List<DBUniqueKey>	getDBUniqueKey(K_CONTROL_OPTION... behaviourFlags)	List of unique keys (primary, candidate or unique) that use this column.
<T extends DBColumn> List<T>	getDBUniqueKeyColumn(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of unique key columns, referenced by this foreign key column.
<T extends DBColumn> List<T>	getDBUniqueKeyColumnOrigin(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Gets the origin columns of this foreign key column.
DBTableColumn	getFirstValidTypeColumn()	Gets the DBTableColumn which is valid to evaluate the IMDataType of this column.
List<DBMergedInstance>	getMergedInstance()	List of all instances using this DBTableColumn.
List<DBCheckConstraint>	getOwnedDBCheckConstraint(K_CONTROL_OPTION... behaviourFlags)	List of check constraints owned by this DBTableColumn.
DBTable	getOwningTable()	Reference to the table of the column.
DBView	getOwningUdf()	Reference to the User Defined Function of this parameter.
void	setDBIndex(List<? extends DBIndex> values)	Set the value of View DBIndex.
void	setPrimary(boolean setPrimary)	Sets the DBTableColumn to primary or not primary.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface DBColumn

getOwnedSQLGeneric, getOwnedTypeTable, getPropagationViews, getPropagationViews, getUsingDBViewElement, getUsingViewColumnByRef, getUsingViewColumnByRef

Methods inherited from interface DBSQLObject

getPrivilege, getReferencedSQLObject, getReferencingSQLObject, setPrivilege, setReferencedSQLObject, setReferencingSQLObject

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELFeature

getEntryInGroupAble, getEntryInGroupAble, getUsingViewElement, isStatic, setStatic

Methods inherited from interface ELMultiplicityAble

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELProperty

getAggregation, getAssociation, getClassifierOfAssociationEnd, getDefaultValue, getOppositeAssociationEnd, getSelfAndSubsettedTransitive, getSelfAndSubsettedTransitive, getSelfAndSubsettingTransitive, getSelfAndSubsettingTransitive, getSubsettedProperty, getSubsettedTransitive, getSubsettedTransitive, getSubsettingProperty, getSubsettingTransitive, getSubsettingTransitive, isAssocOwner, isComposite, isDerived, isDerivedUnion, isNavigable, isNavigableAssocEnd, isSubsetted, isSubsetting, reconnectAssociation, setAggregation, setAssocOwner, setDefaultValue, setDerived, setDerivedUnion, setNavigableAssocEnd, setSubsettedProperty

Methods inherited from interface ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELStructFeature

getSlot, getStructuralFeatureAction, isReadOnly, setReadOnly

Methods inherited from interface ELTypedElement

getModifyTypedElementDeclaration, getType, getTypedElementCnstr, getTypeKind, getValSpecOfTypedElement, getValSpecOfTypedElementWithPattern, getValSpecOfTypedElementWithPattern, isBitmapAble, isColorAble, modifyTypedElementDeclaration, setType

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELViewNavigAble

getViewNavigAbleGroup

Methods inherited from interface IMFeature

getIndex, getIndex, getIndexedFeature, getKey, getKey, getKeyFeature, getKeyRelationshipProperty, getKeyRelationshipProperty, getKeyRelationshipPropertyRecursive, getKeyRelationshipPropertyRecursive, getOwningClassifier

Methods inherited from interface IMProperty

getConcreteFirstMasterParameter, getConcreteSecondMasterParameter, getDefaultSetting, getDerivedDataTypeDefinition, getDerivedImplementation, getDerivedImplementationFormatted, getDerivedIMType, getDerivedSemanticDataType, getDerivedTypingTSOrDTType, getFirstValidDerivingTypeProperty, getFirstValidTypeProperty, getKeyRelationship, getKeyRelationship, getOriginProperty, getOwnedTypeDefinition, getTypeClassName, getTypingDataType, getTypingDataTypeDefinition, getTypingSemanticDataType, getUniqueKey, getUniqueKey, getUniqueKeyProperty, getUniqueKeyProperty, getUniqueKeyPropertyOrigin, getUniqueKeyPropertyOrigin, isArray, isLocal, isNotNull, merge, setArray, setArrayAndMaintain, setConcreteFirstMasterParameter, setConcreteSecondMasterParameter, setDataTypeByString, setDataTypeDefinitionByString, setDefaultSetting, setDerivedImplementation, setDerivedIMType, setDerivedSemanticDataType, setDerivedTypingTSOrDTType, setNull, split, typeMapping

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAble

getMEOwnedMember, getMEPackageImport

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

getDBIndex

List<DBIndex> getDBIndex(K_CONTROL_OPTION... behaviourFlags)
                  throws InoNetException,
SrvErrorException

List of indices that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

The result may be sorted according to the index order in the table.

getDBIndex

List<DBIndex> getDBIndex(MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                  throws InoNetException,
SrvErrorException

The method calls getDBIndex and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setDBIndex

void setDBIndex(List<? extends DBIndex> values)
         throws InoNetException,
SrvErrorException

Set the value of View DBIndex.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

setPrimary

void setPrimary(boolean setPrimary)
         throws InoNetException,
SrvErrorException

Sets the DBTableColumn to primary or not primary.

Parameters:

setPrimary -

Throws:

InoNetException

SrvErrorException

getDBForeignKey

List<DBForeignKey> getDBForeignKey(K_CONTROL_OPTION... behaviourFlags)
                            throws InoNetException,
SrvErrorException

List of foreign keys that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted according to the key order in the table.

getDBKeyRelationshipColumn

List<DBTableColumn> getDBKeyRelationshipColumn()
                                        throws InoNetException,
SrvErrorException

List of foreign key columns, referencing this unique key column.

Throws:

InoNetException

SrvErrorException

getDBKeyRelationshipColumnRecursive

List<DBTableColumn> getDBKeyRelationshipColumnRecursive(DBTable refObj)
                                                 throws InoNetException,
SrvErrorException

List of foreign key columns, referencing this unique key column indirectly. This means that if a direct foreign key column is part of an unique key referenced by a following foreign key, the column of the following foreign key will be returned in this list.
Note: the direct foreign columns are not part of this list!
The result can be restricted to columns of the given argument refObj.

Parameters:

refObj - A further instance of type DBTable which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getDBUniqueKey

List<DBUniqueKey> getDBUniqueKey(K_CONTROL_OPTION... behaviourFlags)
                          throws InoNetException,
SrvErrorException

List of unique keys (primary, candidate or unique) that use this column.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted according to the key order in the table.

getDBUniqueKeyColumn

<T extends DBColumn> List<T> getDBUniqueKeyColumn(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

List of unique key columns, referenced by this foreign key column.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getDBUniqueKeyColumnOrigin

<T extends DBColumn> List<T> getDBUniqueKeyColumnOrigin(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
SrvErrorException

Gets the origin columns of this foreign key column. An origin column is a pure unique key column at the beginning of a foreign/primary key chain. If a foreign key column references more than one unique key column the result may contain more than one column.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getFirstValidTypeColumn

DBTableColumn getFirstValidTypeColumn()
                               throws InoNetException,
SrvErrorException

Gets the DBTableColumn which is valid to evaluate the IMDataType of this column. The result column is normally this column itself, unless this column is part of a foreign key. In the second case, the type is normally derived from a unique key column which will be returned.

Throws:

InoNetException

SrvErrorException

getOwnedDBCheckConstraint

List<DBCheckConstraint> getOwnedDBCheckConstraint(K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

List of check constraints owned by this DBTableColumn.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the list is sorted according to appropriate constraint order in the column.

getMergedInstance

List<DBMergedInstance> getMergedInstance()
                                  throws InoNetException,
SrvErrorException

List of all instances using this DBTableColumn.

Throws:

InoNetException

SrvErrorException

getDBTypingSemanticDataType

IMSemanticDataType getDBTypingSemanticDataType()
                                        throws InoNetException,
SrvErrorException

The semantic data type that types this DBTableColumn.

Throws:

InoNetException

SrvErrorException

getOwningTable

DBTable getOwningTable()
                throws InoNetException,
SrvErrorException

Reference to the table of the column.

Throws:

InoNetException

SrvErrorException

getOwningUdf

DBView getOwningUdf()
             throws InoNetException,
SrvErrorException

Reference to the User Defined Function of this parameter.

Throws:

InoNetException

SrvErrorException