com.vp.plugin.model

Interface IVariable

All Superinterfaces:

IModelElement, IModelElementParent, INoChildrenNoRelationshipBaseModelElement

public interface IVariable
extends INoChildrenNoRelationshipBaseModelElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MULTIPLICITY_MANY
static java.lang.String	MULTIPLICITY_ONE
static java.lang.String	MULTIPLICITY_ONE_TO_MANY
static java.lang.String	MULTIPLICITY_UNSPECIFIED
static java.lang.String	MULTIPLICITY_ZERO
static java.lang.String	MULTIPLICITY_ZERO_TO_MANY
static java.lang.String	MULTIPLICITY_ZERO_TO_ONE
static java.lang.String	PROP_ANALYSIS_ITEM_DIAGRAM_IDS
static java.lang.String	PROP_ANALYSIS_ITEM_MODELS
static java.lang.String	PROP_MULTIPLICITY
static java.lang.String	PROP_MULTIPLICITY_DETAIL
static java.lang.String	PROP_QUALITY_REASON
static java.lang.String	PROP_QUALITY_SCORE
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_TYPE
static java.lang.String	PROP_TYPE_MODIFIER
static java.lang.String	PROP_VISIBILITY
static java.lang.String	TYPE_MODIFIER_AMP
static java.lang.String	TYPE_MODIFIER_ARRAY
static java.lang.String	TYPE_MODIFIER_ASTERISK
static java.lang.String	TYPE_MODIFIER_EMPTY
static java.lang.String	VISIBILITY_INTERNAL
static java.lang.String	VISIBILITY_PACKAGE
static java.lang.String	VISIBILITY_PRIVATE
static java.lang.String	VISIBILITY_PROTECTED
static java.lang.String	VISIBILITY_PROTECTED_INTERNAL
static java.lang.String	VISIBILITY_PUBLIC
static java.lang.String	VISIBILITY_UNSPECIFIED

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

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

Modifier and Type	Method and Description
void	addAnalysisItemModel(IModelElement analysisItemModel)
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.
java.lang.String[]	getAnalysisItemDiagramIds()
IModelElement	getAnalysisItemModelByIndex(int index)
java.lang.String	getMultiplicity()
IMultiplicity	getMultiplicityDetail()
java.lang.String	getQualityReason() Quality reason, it is non-readable value for human
int	getQualityScore() Quality score, it is non-readable value for human
IModelElement	getSyncMappingModelByIndex(int index)
ITaggedValueContainer	getTaggedValues()
java.lang.Object	getType()
IModelElement	getTypeAsElement()
IModelElement	getTypeAsModel()
java.lang.String	getTypeAsString()
java.lang.String	getTypeAsText()
java.lang.String	getTypeModifier()
java.lang.String	getVisibility()
boolean	hasStereotype(java.lang.String name)
boolean	hasStereotypes(java.lang.String name) Deprecated. Replaced by hasStereotype
void	removeAnalysisItemModel(IModelElement analysisItemModel)
void	removeAnalysisItemModelByIndex(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	setAnalysisItemDiagramIds(java.lang.String[] analysisItemDiagramIds)
void	setMultiplicity(java.lang.String multiplicity)
void	setMultiplicityDetail(IMultiplicity multiplicityDetail)
void	setQualityReason(java.lang.String qualityReason)
void	setQualityScore(int qualityScore)
void	setTaggedValues(ITaggedValueContainer taggedValues)
void	setType(IModelElement type)
void	setType(java.lang.String type)
void	setTypeModifier(java.lang.String typeModifier)
void	setVisibility(java.lang.String visibility)
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()
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.INoChildrenNoRelationshipBaseModelElement

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

TYPE_MODIFIER_EMPTY

static final java.lang.String TYPE_MODIFIER_EMPTY

See Also:

Constant Field Values

TYPE_MODIFIER_AMP

static final java.lang.String TYPE_MODIFIER_AMP

See Also:

Constant Field Values

TYPE_MODIFIER_ASTERISK

static final java.lang.String TYPE_MODIFIER_ASTERISK

See Also:

Constant Field Values

TYPE_MODIFIER_ARRAY

static final java.lang.String TYPE_MODIFIER_ARRAY

See Also:

Constant Field Values

VISIBILITY_UNSPECIFIED

static final java.lang.String VISIBILITY_UNSPECIFIED

See Also:

Constant Field Values

VISIBILITY_PRIVATE

static final java.lang.String VISIBILITY_PRIVATE

See Also:

Constant Field Values

VISIBILITY_PROTECTED

static final java.lang.String VISIBILITY_PROTECTED

See Also:

Constant Field Values

VISIBILITY_PACKAGE

static final java.lang.String VISIBILITY_PACKAGE

See Also:

Constant Field Values

VISIBILITY_PROTECTED_INTERNAL

static final java.lang.String VISIBILITY_PROTECTED_INTERNAL

See Also:

Constant Field Values

VISIBILITY_INTERNAL

static final java.lang.String VISIBILITY_INTERNAL

See Also:

Constant Field Values

VISIBILITY_PUBLIC

static final java.lang.String VISIBILITY_PUBLIC

See Also:

Constant Field Values

MULTIPLICITY_UNSPECIFIED

static final java.lang.String MULTIPLICITY_UNSPECIFIED

See Also:

Constant Field Values

MULTIPLICITY_ZERO

static final java.lang.String MULTIPLICITY_ZERO

See Also:

Constant Field Values

MULTIPLICITY_ZERO_TO_ONE

static final java.lang.String MULTIPLICITY_ZERO_TO_ONE

See Also:

Constant Field Values

MULTIPLICITY_ZERO_TO_MANY

static final java.lang.String MULTIPLICITY_ZERO_TO_MANY

See Also:

Constant Field Values

MULTIPLICITY_ONE

static final java.lang.String MULTIPLICITY_ONE

See Also:

Constant Field Values

MULTIPLICITY_ONE_TO_MANY

static final java.lang.String MULTIPLICITY_ONE_TO_MANY

See Also:

Constant Field Values

MULTIPLICITY_MANY

static final java.lang.String MULTIPLICITY_MANY

See Also:

Constant Field Values

PROP_TYPE

static final java.lang.String PROP_TYPE

See Also:

Constant Field Values

PROP_TYPE_MODIFIER

static final java.lang.String PROP_TYPE_MODIFIER

See Also:

Constant Field Values

PROP_VISIBILITY

static final java.lang.String PROP_VISIBILITY

See Also:

Constant Field Values

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_MULTIPLICITY_DETAIL

static final java.lang.String PROP_MULTIPLICITY_DETAIL

See Also:

Constant Field Values

PROP_MULTIPLICITY

static final java.lang.String PROP_MULTIPLICITY

See Also:

Constant Field Values

Method Detail

setType

void setType(java.lang.String type)

getTypeAsString

java.lang.String getTypeAsString()

setType

void setType(IModelElement type)

getTypeAsModel

IModelElement getTypeAsModel()

getTypeAsText

java.lang.String getTypeAsText()

getTypeAsElement

IModelElement getTypeAsElement()

getType

java.lang.Object getType()

setTypeModifier

void setTypeModifier(java.lang.String typeModifier)

getTypeModifier

java.lang.String getTypeModifier()

setVisibility

void setVisibility(java.lang.String visibility)

getVisibility

java.lang.String getVisibility()

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

setMultiplicityDetail

void setMultiplicityDetail(IMultiplicity multiplicityDetail)

getMultiplicityDetail

IMultiplicity getMultiplicityDetail()

setMultiplicity

void setMultiplicity(java.lang.String multiplicity)

getMultiplicity

java.lang.String getMultiplicity()