public interface IModelElement extends IModelElementParent
Modifier and Type | Field and Description |
---|---|
static int |
MODEL_QUALITY_SCORE_IGNORE |
static int |
MODEL_QUALITY_SCORE_RECALCULATE |
static java.lang.String |
PROP_DOCUMENTATION |
static java.lang.String |
PROP_NAME |
static java.lang.String |
PROP_QUALITY_REASON |
static java.lang.String |
PROP_QUALITY_SCORE |
Modifier and Type | Method and Description |
---|---|
void |
addChild(IModelElement child) |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener) |
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 |
addSubDiagram(IDiagramUIModel diagram) |
boolean |
canModify()
Check does this model element is from referenced project.
|
int |
childCount() |
int |
childCount(java.lang.String modelType) |
int |
childCount(java.lang.String[] modelTypes) |
java.util.Iterator |
childIterator() |
java.util.Iterator |
childIterator(java.lang.String modelType) |
java.util.Iterator |
childIterator(java.lang.String[] modelTypes) |
java.util.Iterator |
constraintsIterator() |
IModelElement |
createChild(java.lang.String modelType) |
void |
delete() |
void |
disposeTransientModel() |
IModelElement |
duplicate() |
int |
fromChartRelationshipCount() |
java.util.Iterator |
fromChartRelationshipIterator() |
int |
fromRelationshipCount()
Number of
ISimpleRelationship that connect from this model element. |
int |
fromRelationshipEndCount()
Number of
IRelationshipEnd that connect from this model element. |
java.util.Iterator |
fromRelationshipEndIterator()
IRelationshipEnd s that connect from this model element. |
java.util.Iterator |
fromRelationshipIterator()
ISimpleRelationship s that connect from this model element. |
java.lang.String |
getAddress()
Retrieve the address of the model element.
|
IModelElement |
getChildById(java.lang.String id) |
IModelElement |
getChildByIndex(int index) |
IModelElement |
getChildByIndex(java.lang.String modelType,
int index) |
IModelElement |
getChildByName(java.lang.String name) |
IModelElement |
getChildByName(java.lang.String modelType,
java.lang.String name) |
java.lang.String |
getDescription() |
java.lang.String |
getDescriptionWithReferenceModels() |
IDiagramElement[] |
getDiagramElements()
Get the views (diagram elements) of the model element.
|
java.lang.String |
getDisplayQualityScore()
Retrieve human readable text of
getQualityScore() |
java.lang.String |
getDocumentation()
Deprecated.
Replaced by
getDescription() |
java.lang.String |
getDocumentationWithReferenceModels()
Deprecated.
Replaced by
getDescriptionWithReferenceModels() |
java.lang.String |
getHTMLDescription() |
java.lang.String |
getHTMLDescription(boolean aConvertFromPlainText) |
java.lang.String |
getHTMLDescriptionWithReferenceModels() |
java.lang.String |
getHTMLDescriptionWithReferenceModels(boolean aConvertFromPlainText) |
java.lang.String |
getHTMLDocumentation()
Deprecated.
Replaced by
getHTMLDescription() |
java.lang.String |
getHTMLDocumentation(boolean aConvertFromPlainText)
Deprecated.
Replaced by
getHTMLDescription(boolean) |
java.lang.String |
getHTMLDocumentationWithReferenceModels()
Deprecated.
Replaced by
getHTMLDescriptionWithReferenceModels() |
java.lang.String |
getHTMLDocumentationWithReferenceModels(boolean aConvertFromPlainText)
Deprecated.
Replaced by
getHTMLDescriptionWithReferenceModels(boolean) |
java.lang.String |
getId() |
IDiagramElement |
getMasterView()
Get the master view of the model element.
|
IModelElement |
getMirrorSource()
Return the source model element from reference project.
|
IModelProperty |
getModelPropertyByName(java.lang.String propertyName) |
IModelQualityDetail[] |
getModelQualityDetails()
Retrieve 'details' for
getQualityReason() |
java.lang.String |
getModelType() |
java.lang.String |
getName()
Retrieve the name of this
IModelElement . |
java.lang.String |
getNickDescription() |
java.lang.String |
getNickDescriptionWithReferenceModels() |
java.lang.String |
getNickDocumentation()
Deprecated.
Replaced by
getNickDescription() |
java.lang.String |
getNickDocumentationWithReferenceModels()
Deprecated.
Replaced by
getNickDescriptionWithReferenceModels() |
java.lang.String |
getNickHTMLDescription() |
java.lang.String |
getNickHTMLDescription(boolean aConvertFromPlainText) |
java.lang.String |
getNickHTMLDescriptionWithReferenceModels() |
java.lang.String |
getNickHTMLDescriptionWithReferenceModels(boolean aConvertFromPlainText) |
java.lang.String |
getNickHTMLDocumentation()
Deprecated.
Replaced by
getNickHTMLDescription() |
java.lang.String |
getNickHTMLDocumentation(boolean aConvertFromPlainText)
Deprecated.
Replaced by
getNickHTMLDescription(boolean) |
java.lang.String |
getNickHTMLDocumentationWithReferenceModels()
Deprecated.
Replaced by
getNickHTMLDescriptionWithReferenceModels() |
java.lang.String |
getNickHTMLDocumentationWithReferenceModels(boolean aConvertFromPlainText)
Deprecated.
|
java.lang.String |
getNickname()
Retrieve the nickname of this
IModelElement for current nickname of project. |
java.lang.String |
getNickPropertyValue(java.lang.String propertyName) |
IModelElement |
getParent() |
IProject |
getProject() |
java.lang.String |
getQualityReason()
Quality reason, it is non-readable value for human
|
int |
getQualityScore()
Quality score, it is non-readable value for human
|
IReferencedBy[] |
getReferencedBys() |
IModelElement[] |
getReferencingModels(java.lang.String ownerModelType,
java.lang.String propertyName) |
IDiagramUIModel |
getSubDiagramAt(int index) |
ITaggedValueContainer |
getTaggedValues() |
boolean |
hasStereotype(java.lang.String name) |
int |
indexOfSubDiagram(IDiagramUIModel diagram) |
boolean |
isMirrorModelElement()
Check is the model element mirror from reference project.
|
boolean |
isTransientModel()
A read only model.
|
void |
removeChild(IModelElement child) |
void |
removeChildByIndex(int index) |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener) |
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 |
removeSubDiagram(IDiagramUIModel diagram) |
void |
setDescription(java.lang.String description) |
void |
setDocumentation(java.lang.String documentation)
Deprecated.
Replaced by
setDescription(String) |
void |
setHTMLDescription(java.lang.String description) |
void |
setHTMLDocumentation(java.lang.String documentation)
Deprecated.
Replaced by
setHTMLDescription(String) |
void |
setName(java.lang.String name)
Set the name of this
IModelElement . |
void |
setNickDescription(java.lang.String description) |
void |
setNickDocumentation(java.lang.String documentation)
Deprecated.
Replaced by
setNickDescription(String) |
void |
setNickHTMLDescription(java.lang.String description) |
void |
setNickHTMLDocumentation(java.lang.String documentation)
Deprecated.
Replaced by
setNickHTMLDescription(String) |
void |
setNickname(java.lang.String name)
Set the nickname of this
IModelElement for current nickname of project. |
void |
setTaggedValues(ITaggedValueContainer taggedValues) |
int |
stereotypeCount() |
java.util.Iterator |
stereotypeModelIterator()
Returns an iterator over the model elements
IStereotype . |
int |
subDiagramCount() |
java.util.Iterator |
subDiagramIterator() |
int |
toChartRelationshipCount() |
java.util.Iterator |
toChartRelationshipIterator() |
IModelElement[] |
toChildArray() |
IModelElement[] |
toChildArray(java.lang.String modelType) |
IModelElement[] |
toChildArray(java.lang.String[] modelTypes) |
IChartRelationship[] |
toFromChartRelationshipArray() |
ISimpleRelationship[] |
toFromRelationshipArray()
ISimpleRelationship s that connect from this model element. |
IRelationshipEnd[] |
toFromRelationshipEndArray()
IRelationshipEnd s that connect from this model element. |
IModelProperty[] |
toModelPropertyArray() |
java.lang.String |
toPropertiesString() |
int |
toRelationshipCount()
Number of
ISimpleRelationship that connect to this model element. |
int |
toRelationshipEndCount()
Number of
IRelationshipEnd that connect to this model element. |
java.util.Iterator |
toRelationshipEndIterator()
IRelationshipEnd s that connect to this model element. |
java.util.Iterator |
toRelationshipIterator()
ISimpleRelationship s that connect to this model element. |
IStereotype[] |
toStereotypeModelArray() |
IDiagramUIModel[] |
toSubDiagramArray() |
IChartRelationship[] |
toToChartRelationshipArray() |
ISimpleRelationship[] |
toToRelationshipArray()
ISimpleRelationship s that connect to this model element. |
IRelationshipEnd[] |
toToRelationshipEndArray()
IRelationshipEnd s that connect to this model element. |
static final java.lang.String PROP_NAME
static final java.lang.String PROP_DOCUMENTATION
static final java.lang.String PROP_QUALITY_SCORE
static final java.lang.String PROP_QUALITY_REASON
static final int MODEL_QUALITY_SCORE_RECALCULATE
static final int MODEL_QUALITY_SCORE_IGNORE
java.lang.String getId()
java.lang.String getModelType()
java.lang.String getAddress()
IModelElement getParent()
void setName(java.lang.String name)
IModelElement
.aName
- the new nickname of this IModelElement
.java.lang.String getName()
IModelElement
.IModelElement
void setNickname(java.lang.String name)
IModelElement
for current nickname of project.
An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234name
- the new nickname of this IModelElement
.java.lang.String getNickname()
IModelElement
for current nickname of project.
An example on how to create nickname can be found at http://knowhow.visual-paradigm.com/?p=2234IModelElement
.java.lang.String getNickPropertyValue(java.lang.String propertyName)
void addChild(IModelElement child)
addChild
in interface IModelElementParent
void removeChild(IModelElement child)
removeChild
in interface IModelElementParent
IModelElement getChildByIndex(int index)
getChildByIndex
in interface IModelElementParent
IModelElement getChildByIndex(java.lang.String modelType, int index)
void removeChildByIndex(int index)
removeChildByIndex
in interface IModelElementParent
int childCount()
childCount
in interface IModelElementParent
int childCount(java.lang.String modelType)
int childCount(java.lang.String[] modelTypes)
java.util.Iterator childIterator()
childIterator
in interface IModelElementParent
java.util.Iterator childIterator(java.lang.String modelType)
java.util.Iterator childIterator(java.lang.String[] modelTypes)
IModelElement[] toChildArray()
toChildArray
in interface IModelElementParent
IModelElement[] toChildArray(java.lang.String modelType)
IModelElement[] toChildArray(java.lang.String[] modelTypes)
IModelElement createChild(java.lang.String modelType)
createChild
in interface IModelElementParent
IModelElement getChildById(java.lang.String id)
IModelElement getChildByName(java.lang.String name)
getChildByName
in interface IModelElementParent
IModelElement getChildByName(java.lang.String modelType, java.lang.String name)
getChildByName
in interface IModelElementParent
int fromRelationshipCount()
ISimpleRelationship
that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship[] toFromRelationshipArray()
ISimpleRelationship
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship
s that connect from this model elementjava.util.Iterator fromRelationshipIterator()
ISimpleRelationship
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship
s that connect from this model elementint toRelationshipCount()
ISimpleRelationship
that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship[] toToRelationshipArray()
ISimpleRelationship
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship
s that connect to this model elementjava.util.Iterator toRelationshipIterator()
ISimpleRelationship
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445ISimpleRelationship
s that connect to this model elementint fromRelationshipEndCount()
IRelationshipEnd
that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd[] toFromRelationshipEndArray()
IRelationshipEnd
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd
s that connect from this model elementjava.util.Iterator fromRelationshipEndIterator()
IRelationshipEnd
s that connect from this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd
s that connect from this model elementint toRelationshipEndCount()
IRelationshipEnd
that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd[] toToRelationshipEndArray()
IRelationshipEnd
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd
s that connect to this model elementjava.util.Iterator toRelationshipEndIterator()
IRelationshipEnd
s that connect to this model element.
Sample usage please refer to http://knowhow.visual-paradigm.com/?p=2445IRelationshipEnd
s that connect to this model elementint fromChartRelationshipCount()
IChartRelationship[] toFromChartRelationshipArray()
java.util.Iterator fromChartRelationshipIterator()
int toChartRelationshipCount()
IChartRelationship[] toToChartRelationshipArray()
java.util.Iterator toChartRelationshipIterator()
void addSubDiagram(IDiagramUIModel diagram)
void removeSubDiagram(IDiagramUIModel diagram)
IDiagramUIModel getSubDiagramAt(int index)
int indexOfSubDiagram(IDiagramUIModel diagram)
int subDiagramCount()
java.util.Iterator subDiagramIterator()
IDiagramUIModel[] toSubDiagramArray()
void setDocumentation(java.lang.String documentation)
setDescription(String)
void setHTMLDocumentation(java.lang.String documentation)
setHTMLDescription(String)
java.lang.String getDocumentation()
getDescription()
java.lang.String getHTMLDocumentation()
getHTMLDescription()
java.lang.String getHTMLDocumentation(boolean aConvertFromPlainText)
getHTMLDescription(boolean)
java.lang.String getDocumentationWithReferenceModels()
getDescriptionWithReferenceModels()
java.lang.String getHTMLDocumentationWithReferenceModels()
getHTMLDescriptionWithReferenceModels()
java.lang.String getHTMLDocumentationWithReferenceModels(boolean aConvertFromPlainText)
getHTMLDescriptionWithReferenceModels(boolean)
void setNickDocumentation(java.lang.String documentation)
setNickDescription(String)
void setNickHTMLDocumentation(java.lang.String documentation)
setNickHTMLDescription(String)
java.lang.String getNickDocumentation()
getNickDescription()
java.lang.String getNickHTMLDocumentation()
getNickHTMLDescription()
java.lang.String getNickHTMLDocumentation(boolean aConvertFromPlainText)
getNickHTMLDescription(boolean)
java.lang.String getNickDocumentationWithReferenceModels()
getNickDescriptionWithReferenceModels()
java.lang.String getNickHTMLDocumentationWithReferenceModels()
getNickHTMLDescriptionWithReferenceModels()
java.lang.String getNickHTMLDocumentationWithReferenceModels(boolean aConvertFromPlainText)
getNickHTMLDescriptionWithReferenceModels(boolean)
void setDescription(java.lang.String description)
void setHTMLDescription(java.lang.String description)
java.lang.String getDescription()
java.lang.String getHTMLDescription()
java.lang.String getHTMLDescription(boolean aConvertFromPlainText)
java.lang.String getDescriptionWithReferenceModels()
java.lang.String getHTMLDescriptionWithReferenceModels()
java.lang.String getHTMLDescriptionWithReferenceModels(boolean aConvertFromPlainText)
void setNickDescription(java.lang.String description)
void setNickHTMLDescription(java.lang.String description)
java.lang.String getNickDescription()
java.lang.String getNickHTMLDescription()
java.lang.String getNickHTMLDescription(boolean aConvertFromPlainText)
java.lang.String getNickDescriptionWithReferenceModels()
java.lang.String getNickHTMLDescriptionWithReferenceModels()
java.lang.String getNickHTMLDescriptionWithReferenceModels(boolean aConvertFromPlainText)
void addStereotype(java.lang.String name)
IStereotype
does not existing in current project. It will be auto created.stereotype
- the stereotype name will be added into this model element.java.lang.UnsupportedOperationException
- if this model does not support "stereotypes" property.void removeStereotype(java.lang.String name)
stereotype
- the stereotype name will be removed from this model element.java.lang.UnsupportedOperationException
- if this model does not support "stereotypes" property.void addStereotype(IStereotype 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=2378stereotype
- 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.
java.lang.IllegalArgumentException
- if the stereotype
is null, or its baseType
does not match with modelType
of this model element.java.lang.UnsupportedOperationException
- if this model does not support "stereotypes" property.void removeStereotype(IStereotype stereotype)
IStereotype
from this model element. The IStereotype
can belong to current project or referenced project(s).stereotype
- the IStereotype
will be removed from this model element.java.lang.UnsupportedOperationException
- if this model does not support "stereotypes" property.boolean hasStereotype(java.lang.String name)
int stereotypeCount()
java.util.Iterator stereotypeModelIterator()
IStereotype
.IStereotype[] toStereotypeModelArray()
void setTaggedValues(ITaggedValueContainer taggedValues)
ITaggedValueContainer getTaggedValues()
void delete()
IModelProperty getModelPropertyByName(java.lang.String propertyName)
IModelProperty[] toModelPropertyArray()
void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
IDiagramElement[] getDiagramElements()
IDiagramElement getMasterView()
IModelElement[] getReferencingModels(java.lang.String ownerModelType, java.lang.String propertyName)
IReferencedBy[] getReferencedBys()
int getQualityScore()
java.lang.String getDisplayQualityScore()
getQualityScore()
java.lang.String getQualityReason()
IModelQualityDetail[] getModelQualityDetails()
getQualityReason()
IModelQualityDetail
provides functions: getProblem()
, and getSuggestion()
to get the detailsIModelElement duplicate()
java.util.Iterator constraintsIterator()
java.lang.String toPropertiesString()
IProject getProject()
boolean isTransientModel()
void disposeTransientModel()
boolean isMirrorModelElement()
IModelElement getMirrorSource()
boolean canModify()