com.vp.plugin.model

Interface ITable

All Superinterfaces:

IHasChildrenBaseModelElement, IModelElement, IModelElementParent

public interface ITable
extends IHasChildrenBaseModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ANALYSIS_ITEM_DIAGRAM_IDS
static java.lang.String	PROP_ANALYSIS_ITEM_MODELS
static java.lang.String	PROP_CONSTRAINTS
static java.lang.String	PROP_FOREIGN_KEYS
static java.lang.String	PROP_PRIMARY_KEY_CONSTRAINT_NAME
static java.lang.String	PROP_QUALITY_REASON
static java.lang.String	PROP_QUALITY_SCORE
static java.lang.String	PROP_REFERENCED_TABLES
static java.lang.String	PROP_STEREOTYPES
static java.lang.String	PROP_SYNC_MAPPING_MODELS
static java.lang.String	PROP_TAGGED_VALUES
static java.lang.String	PROP_VIEW

Fields inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

PROP_BACKLOG_ACTIVITY_ID, PROP_COMMENTS, PROP_DOCUMENTATION, PROP_GENERIC_VALUES, PROP_PM_AUTHOR, PROP_PM_CREATE_DATE_TIME, PROP_PM_DIFFICULTY, PROP_PM_DISCIPLINE, PROP_PM_ITERATION, PROP_PM_LAST_MODIFIED, PROP_PM_PHASE, PROP_PM_PRIORITY, PROP_PM_STATUS, PROP_PM_VERSION, PROP_REFERENCED_BY_DIAGRAM_IDS, PROP_REFERENCED_BY_MODEL_ADDRESSES, PROP_REFERENCES, PROP_TRANSIT_FROM, PROP_TRANSIT_TO, PROP_USER_ID, PROP_USER_ID_LAST_NUMERIC_VALUE, PROP_USER_ID_PARENT, PROP_VOICES

Fields inherited from interface com.vp.plugin.model.IModelElement

MODEL_QUALITY_SCORE_IGNORE, MODEL_QUALITY_SCORE_RECALCULATE, PROP_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnalysisItemModel(IModelElement analysisItemModel)
void	addColumn(IColumn child)
void	addConstraint(IUniqueConstraint constraint)
void	addForeignKey(IForeignKey foreignKey)
void	addIndex(IIndex child)
void	addReferencedTable(ITable referencedTable)
void	addStereotype(IStereotype stereotype) Add a stereotype IStereotype into this model element.
void	addStereotype(java.lang.String name) Add a stereotype into this model element.
void	addStereotypes(java.lang.String name) Deprecated. Replaced by addStereotype
void	addSyncMappingModel(IModelElement syncMappingModel)
int	analysisItemModelCount()
java.util.Iterator	analysisItemModelIterator() Returns an iterator over the model elements IModelElement.
int	columnCount()
java.util.Iterator	columnIterator()
int	constraintCount()
java.util.Iterator	constraintIterator() Returns an iterator over the model elements IUniqueConstraint.
IColumn	createColumn()
IIndex	createIndex()
int	foreignKeyCount()
java.util.Iterator	foreignKeyIterator() Returns an iterator over the model elements IForeignKey.
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(int index)
IColumn	getColumnByIndex(int index)
IColumn	getColumnByName(java.lang.String name)
IUniqueConstraint	getConstraintByIndex(int index)
IForeignKey	getForeignKeyByIndex(int index)
IIndex	getIndexByIndex(int index)
IIndex	getIndexByName(java.lang.String name)
java.lang.String	getPrimaryKeyConstraintName()
java.lang.String	getQualityReason() Quality reason, it is non-readable value for human
int	getQualityScore() Quality score, it is non-readable value for human
ITable	getReferencedTableByIndex(int index)
IModelElement	getSyncMappingModelByIndex(int index)
ITaggedValueContainer	getTaggedValues()
boolean	hasStereotype(java.lang.String name)
boolean	hasStereotypes(java.lang.String name) Deprecated. Replaced by hasStereotype
int	indexCount()
java.util.Iterator	indexIterator()
boolean	isView()
int	referencedTableCount()
java.util.Iterator	referencedTableIterator() Returns an iterator over the model elements ITable.
void	removeAnalysisItemModel(IModelElement analysisItemModel)
void	removeAnalysisItemModelByIndex(int index)
void	removeColumn(IColumn child)
void	removeColumnByIndex(int index)
void	removeConstraint(IUniqueConstraint constraint)
void	removeConstraintByIndex(int index)
void	removeForeignKey(IForeignKey foreignKey)
void	removeForeignKeyByIndex(int index)
void	removeIndex(IIndex child)
void	removeIndexByIndex(int index)
void	removeReferencedTable(ITable referencedTable)
void	removeReferencedTableByIndex(int index)
void	removeStereotype(IStereotype stereotype) Remove a stereotype IStereotype from this model element.
void	removeStereotype(java.lang.String name) Remove a stereotype from this model element.
void	removeStereotypes(java.lang.String name) Deprecated. Replaced by removeStereotype
void	removeSyncMappingModel(IModelElement syncMappingModel)
void	removeSyncMappingModelByIndex(int index)
void	reorderColumn(IColumn[] childs)
void	reorderIndex(IIndex[] childs)
void	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
void	setPrimaryKeyConstraintName(java.lang.String primaryKeyConstraintName)
void	setQualityReason(java.lang.String qualityReason)
void	setQualityScore(int qualityScore)
void	setTaggedValues(ITaggedValueContainer taggedValues)
void	setView(boolean view)
int	stereotypeCount()
java.util.Iterator	stereotypeIterator() Returns an iterator over the names of the stereotypes.
java.util.Iterator	stereotypeModelIterator() Returns an iterator over the model elements IStereotype.
int	stereotypesCount() Deprecated. Replaced by stereotypeCount
java.util.Iterator	stereotypesIterator() Deprecated. Replaced by stereotypeIterator
java.util.Iterator	stereotypesModelIterator() Deprecated. Replaced by stereotypeModelIterator
int	syncMappingModelCount()
java.util.Iterator	syncMappingModelIterator() Returns an iterator over the model elements IModelElement.
IModelElement[]	toAnalysisItemModelArray()
IColumn[]	toColumnArray()
IUniqueConstraint[]	toConstraintArray()
IForeignKey[]	toForeignKeyArray()
IIndex[]	toIndexArray()
ITable[]	toReferencedTableArray()
java.lang.String[]	toStereotypeArray()
IStereotype[]	toStereotypeModelArray()
java.lang.String[]	toStereotypesArray() Deprecated. Replaced by toStereotypeArray
IStereotype[]	toStereotypesModelArray() Deprecated. Replaced by toStereotypeModelArray
IModelElement[]	toSyncMappingModelArray()

Methods inherited from interface com.vp.plugin.model.IHasChildrenBaseModelElement

addComment, addGenericValue, addReference, addVoice, commentCount, commentIterator, genericValueCount, genericValueIterator, getBacklogActivityId, getCommentByIndex, getDescription, getGenericValueByIndex, getHTMLDescription, getHTMLDescription, getPmAuthor, getPmCreateDateTime, getPmDifficulty, getPmDiscipline, getPmIteration, getPmLastModified, getPmPhase, getPmPriority, getPmStatus, getPmVersion, getReferenceByIndex, getReferencedByDiagramIds, getReferencedByModelAddresses, getTransitFrom, getTransitTo, getUserID, getUserIDLastNumericValue, getUserIDParent, getVoiceByIndex, referenceCount, referenceIterator, removeComment, removeCommentByIndex, removeGenericValue, removeGenericValueByIndex, removeReference, removeReferenceByIndex, removeVoice, removeVoiceByIndex, setBacklogActivityId, setDescription, setHTMLDescription, setPmAuthor, setPmCreateDateTime, setPmDifficulty, setPmDiscipline, setPmIteration, setPmLastModified, setPmPhase, setPmPriority, setPmStatus, setPmVersion, setReferencedByDiagramIds, setReferencedByModelAddresses, setTransitFrom, setTransitTo, setUserID, setUserIDLastNumericValue, setUserIDParent, toCommentArray, toGenericValueArray, toReferenceArray, toVoiceArray, voiceCount, voiceIterator

Methods inherited from interface com.vp.plugin.model.IModelElement

addChild, addPropertyChangeListener, addSubDiagram, canModify, childCount, childCount, childCount, childIterator, childIterator, childIterator, constraintsIterator, createChild, delete, disposeTransientModel, duplicate, fromChartRelationshipCount, fromChartRelationshipIterator, fromRelationshipCount, fromRelationshipEndCount, fromRelationshipEndIterator, fromRelationshipIterator, getAddress, getChildById, getChildByIndex, getChildByIndex, getChildByName, getChildByName, getDescriptionWithReferenceModels, getDiagramElements, getDisplayQualityScore, getDocumentation, getDocumentationWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDescriptionWithReferenceModels, getHTMLDocumentation, getHTMLDocumentation, getHTMLDocumentationWithReferenceModels, getHTMLDocumentationWithReferenceModels, getId, getMasterView, getMirrorSource, getModelPropertyByName, getModelQualityDetails, getModelType, getName, getNickDescription, getNickDescriptionWithReferenceModels, getNickDocumentation, getNickDocumentationWithReferenceModels, getNickHTMLDescription, getNickHTMLDescription, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDescriptionWithReferenceModels, getNickHTMLDocumentation, getNickHTMLDocumentation, getNickHTMLDocumentationWithReferenceModels, getNickHTMLDocumentationWithReferenceModels, getNickname, getNickPropertyValue, getParent, getProject, getReferencedBys, getReferencingModels, getSubDiagramAt, indexOfSubDiagram, isMirrorModelElement, isTransientModel, removeChild, removeChildByIndex, removePropertyChangeListener, removeSubDiagram, setDocumentation, setHTMLDocumentation, setName, setNickDescription, setNickDocumentation, setNickHTMLDescription, setNickHTMLDocumentation, setNickname, subDiagramCount, subDiagramIterator, toChartRelationshipCount, toChartRelationshipIterator, toChildArray, toChildArray, toChildArray, toFromChartRelationshipArray, toFromRelationshipArray, toFromRelationshipEndArray, toModelPropertyArray, toPropertiesString, toRelationshipCount, toRelationshipEndCount, toRelationshipEndIterator, toRelationshipIterator, toSubDiagramArray, toToChartRelationshipArray, toToRelationshipArray, toToRelationshipEndArray

Field Detail

PROP_STEREOTYPES

static final java.lang.String PROP_STEREOTYPES

See Also:

Constant Field Values

PROP_TAGGED_VALUES

static final java.lang.String PROP_TAGGED_VALUES

See Also:

Constant Field Values

PROP_SYNC_MAPPING_MODELS

static final java.lang.String PROP_SYNC_MAPPING_MODELS

See Also:

Constant Field Values

PROP_ANALYSIS_ITEM_MODELS

static final java.lang.String PROP_ANALYSIS_ITEM_MODELS

See Also:

Constant Field Values

PROP_ANALYSIS_ITEM_DIAGRAM_IDS

static final java.lang.String PROP_ANALYSIS_ITEM_DIAGRAM_IDS

See Also:

Constant Field Values

PROP_QUALITY_SCORE

static final java.lang.String PROP_QUALITY_SCORE

See Also:

Constant Field Values

PROP_QUALITY_REASON

static final java.lang.String PROP_QUALITY_REASON

See Also:

Constant Field Values

PROP_CONSTRAINTS

static final java.lang.String PROP_CONSTRAINTS

See Also:

Constant Field Values

PROP_PRIMARY_KEY_CONSTRAINT_NAME

static final java.lang.String PROP_PRIMARY_KEY_CONSTRAINT_NAME

See Also:

Constant Field Values

PROP_VIEW

static final java.lang.String PROP_VIEW

See Also:

Constant Field Values

PROP_REFERENCED_TABLES

static final java.lang.String PROP_REFERENCED_TABLES

See Also:

Constant Field Values

PROP_FOREIGN_KEYS

static final java.lang.String PROP_FOREIGN_KEYS

See Also:

Constant Field Values

Method Detail

addColumn

void addColumn(IColumn child)

removeColumn

void removeColumn(IColumn child)

getColumnByIndex

IColumn getColumnByIndex(int index)

removeColumnByIndex

void removeColumnByIndex(int index)

reorderColumn

void reorderColumn(IColumn[] childs)

columnCount

int columnCount()

columnIterator

java.util.Iterator columnIterator()

toColumnArray

IColumn[] toColumnArray()

createColumn

IColumn createColumn()

getColumnByName

IColumn getColumnByName(java.lang.String name)

addIndex

void addIndex(IIndex child)

removeIndex

void removeIndex(IIndex child)

getIndexByIndex

IIndex getIndexByIndex(int index)

removeIndexByIndex

void removeIndexByIndex(int index)

reorderIndex

void reorderIndex(IIndex[] childs)

indexCount

int indexCount()

indexIterator

java.util.Iterator indexIterator()

toIndexArray

IIndex[] toIndexArray()

createIndex

IIndex createIndex()

getIndexByName

IIndex getIndexByName(java.lang.String name)

addStereotype

void addStereotype(java.lang.String name)

Description copied from interface: IModelElement

Add a stereotype into this model element. If the IStereotype does not existing in current project. It will be auto created.

Specified by:

addStereotype in interface IModelElement

removeStereotype

void removeStereotype(java.lang.String name)

Description copied from interface: IModelElement

Remove a stereotype from this model element.

Specified by:

removeStereotype in interface IModelElement

addStereotype

void addStereotype(IStereotype stereotype)

Add a stereotype IStereotype into this model element. The IStereotype may belong to current project or referenced project(s). Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2378

Specified by:

addStereotype in interface IModelElement

Parameters:

stereotype - the IStereotype will be added into this model element.

The baseType of the IStereotype is required to be matched with modelType of this model element. If they are different, or stereotype is null, will cause an IllegalArgumentException.

Throws:

java.lang.IllegalArgumentException - if the stereotype is null, or its baseType does not match with modelType of this model element.

removeStereotype

void removeStereotype(IStereotype stereotype)

Remove a stereotype IStereotype from this model element. The IStereotype can belong to current project or referenced project(s).

Specified by:

removeStereotype in interface IModelElement

Parameters:

stereotype - the IStereotype will be removed from this model element.

hasStereotype

boolean hasStereotype(java.lang.String name)

Specified by:

hasStereotype in interface IModelElement

stereotypeCount

int stereotypeCount()

Specified by:

stereotypeCount in interface IModelElement

toStereotypeArray

java.lang.String[] toStereotypeArray()

stereotypeIterator

java.util.Iterator stereotypeIterator()

Returns an iterator over the names of the stereotypes.

stereotypeModelIterator

java.util.Iterator stereotypeModelIterator()

Returns an iterator over the model elements IStereotype.

Specified by:

stereotypeModelIterator in interface IModelElement

toStereotypeModelArray

IStereotype[] toStereotypeModelArray()

Specified by:

toStereotypeModelArray in interface IModelElement

addStereotypes

void addStereotypes(java.lang.String name)

Deprecated. Replaced by addStereotype

removeStereotypes

void removeStereotypes(java.lang.String name)

Deprecated. Replaced by removeStereotype

hasStereotypes

boolean hasStereotypes(java.lang.String name)

Deprecated. Replaced by hasStereotype

stereotypesCount

int stereotypesCount()

Deprecated. Replaced by stereotypeCount

toStereotypesArray

java.lang.String[] toStereotypesArray()

Deprecated. Replaced by toStereotypeArray

stereotypesIterator

java.util.Iterator stereotypesIterator()

Deprecated. Replaced by stereotypeIterator

stereotypesModelIterator

java.util.Iterator stereotypesModelIterator()

Deprecated. Replaced by stereotypeModelIterator

toStereotypesModelArray

IStereotype[] toStereotypesModelArray()

Deprecated. Replaced by toStereotypeModelArray

setTaggedValues

void setTaggedValues(ITaggedValueContainer taggedValues)

Specified by:

setTaggedValues in interface IModelElement

getTaggedValues

ITaggedValueContainer getTaggedValues()

Specified by:

getTaggedValues in interface IModelElement

addSyncMappingModel

void addSyncMappingModel(IModelElement syncMappingModel)

removeSyncMappingModel

void removeSyncMappingModel(IModelElement syncMappingModel)

getSyncMappingModelByIndex

IModelElement getSyncMappingModelByIndex(int index)

removeSyncMappingModelByIndex

void removeSyncMappingModelByIndex(int index)

syncMappingModelCount

int syncMappingModelCount()

syncMappingModelIterator

java.util.Iterator syncMappingModelIterator()

Returns an iterator over the model elements IModelElement.

toSyncMappingModelArray

IModelElement[] toSyncMappingModelArray()

addAnalysisItemModel

void addAnalysisItemModel(IModelElement analysisItemModel)

removeAnalysisItemModel

void removeAnalysisItemModel(IModelElement analysisItemModel)

getAnalysisItemModelByIndex

IModelElement getAnalysisItemModelByIndex(int index)

removeAnalysisItemModelByIndex

void removeAnalysisItemModelByIndex(int index)

analysisItemModelCount

int analysisItemModelCount()

analysisItemModelIterator

java.util.Iterator analysisItemModelIterator()

Returns an iterator over the model elements IModelElement.

toAnalysisItemModelArray

IModelElement[] toAnalysisItemModelArray()

setAnalysisItemDiagramIds

void setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)

getAnalysisItemDiagramIds

java.lang.String[] getAnalysisItemDiagramIds()

setQualityScore

void setQualityScore(int qualityScore)

getQualityScore

int getQualityScore()

Description copied from interface: IModelElement

Quality score, it is non-readable value for human

Specified by:

getQualityScore in interface IModelElement

setQualityReason

void setQualityReason(java.lang.String qualityReason)

getQualityReason

java.lang.String getQualityReason()

Description copied from interface: IModelElement

Quality reason, it is non-readable value for human

Specified by:

getQualityReason in interface IModelElement

addConstraint

void addConstraint(IUniqueConstraint constraint)

removeConstraint

void removeConstraint(IUniqueConstraint constraint)

getConstraintByIndex

IUniqueConstraint getConstraintByIndex(int index)

removeConstraintByIndex

void removeConstraintByIndex(int index)

constraintCount

int constraintCount()

constraintIterator

java.util.Iterator constraintIterator()

Returns an iterator over the model elements IUniqueConstraint.

toConstraintArray

IUniqueConstraint[] toConstraintArray()

setPrimaryKeyConstraintName

void setPrimaryKeyConstraintName(java.lang.String primaryKeyConstraintName)

getPrimaryKeyConstraintName

java.lang.String getPrimaryKeyConstraintName()

setView

void setView(boolean view)

isView

boolean isView()

addReferencedTable

void addReferencedTable(ITable referencedTable)

removeReferencedTable

void removeReferencedTable(ITable referencedTable)

getReferencedTableByIndex

ITable getReferencedTableByIndex(int index)

removeReferencedTableByIndex

void removeReferencedTableByIndex(int index)

referencedTableCount

int referencedTableCount()

referencedTableIterator

java.util.Iterator referencedTableIterator()

Returns an iterator over the model elements ITable.

toReferencedTableArray

ITable[] toReferencedTableArray()

addForeignKey

void addForeignKey(IForeignKey foreignKey)

removeForeignKey

void removeForeignKey(IForeignKey foreignKey)

getForeignKeyByIndex

IForeignKey getForeignKeyByIndex(int index)

removeForeignKeyByIndex

void removeForeignKeyByIndex(int index)

foreignKeyCount

int foreignKeyCount()

foreignKeyIterator

java.util.Iterator foreignKeyIterator()

Returns an iterator over the model elements IForeignKey.

toForeignKeyArray

IForeignKey[] toForeignKeyArray()