|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
A representation of the model object '
Artifact'.
xmi:ordered=true
property order is (these are role names) 1. description 2. artifactContext 3.
artifactDependency 4. variabilityPoint 5. artifactType 6. artifact
An artifact is a work product that can be created, stored and manipulated by
asset producers/consumers and by tools. An artifact is either an actual file
located in the asset's package, or represents a logical entity that contains
at least one child artifact that is an actual file. An
The following features are supported:
DefaultprofilePackage.getArtifact()| Method Summary | |
VisitorStatus |
accept(IArtifactVisitor visitor)
Accepts the given visitor. |
boolean |
addArtifact(Artifact anArtifact)
Helper method to add a nested Artifact to this
Artifact. |
String |
computePathFromArtifact(Artifact anArtifact,
String pathSeparator)
Helper method to compute the path of th Artifact relative
to its position from a parent/ancestor Artifact. |
String |
computePathInSolution(String pathSeparator)
Helper method used to compute the path of the Artifact
relative to it's position in the Solution. |
boolean |
containsArtifact(String theArtifactName)
Helper method to determine if an Artifact contains a top
level child Artifact with a particular name. |
Artifact |
createArtifact()
Helper method used to create an Artifact |
ArtifactContext |
createArtifactContext()
Helper method used to create an ArtifactContext |
ArtifactDependency |
createArtifactDependency()
Helper method used to create an ArtifactDependency |
ArtifactType |
createArtifactType()
Helper method used to create an ArtifactType |
Description |
createDescription()
Helper method used to create a Description |
VariabilityPoint |
createVariabilityPoint()
Helper method used to create a VariabilityPoint |
String |
getAccessRights()
Returns the value of the 'Access Rights' attribute |
EList |
getArtifact()
Returns the value of the 'Artifact' containment reference list. |
EList |
getArtifactContext()
Returns the value of the 'Artifact Context' containment reference list. |
EList |
getArtifactDependency()
Returns the value of the 'Artifact Dependency' containment reference list. |
EList |
getArtifactType()
Returns the value of the 'Artifact Type' containment reference list. |
IAssetFactory |
getAssetFactory()
Get the asset factory with which to create the elements in this Artifact. |
Description |
getDescription()
Returns the value of the 'Description' containment reference. |
String |
getDigestName()
Returns the value of the 'Digest Name' attribute |
String |
getDigestValue()
Returns the value of the 'Digest Value' attribute |
String |
getName()
Returns the value of the 'Name' attribute. |
String |
getReference()
Returns the value of the 'Reference' attribute. |
String |
getType()
Returns the value of the 'Type' attribute. |
EList |
getVariabilityPoint()
Returns the value of the 'Variability Point' containment reference list. |
String |
getVersion()
Returns the value of the 'Version' attribute. |
void |
setAccessRights(String value)
Sets the value of the ' Access Rights'
attribute.
|
void |
setAssetFactory(IAssetFactory theAssetFactory)
Set the asset factory with which to create the elements in this Artifact. |
void |
setDescription(Description value)
Sets the value of the ' Description'
containment reference.
|
void |
setDigestName(String value)
Sets the value of the ' Digest Name'
attribute.
|
void |
setDigestValue(String value)
Sets the value of the ' Digest Value'
attribute.
|
void |
setName(String value)
Sets the value of the ' Name'
attribute.
|
void |
setReference(String value)
Sets the value of the ' Reference'
attribute.
|
void |
setType(String value)
Sets the value of the ' Type'
attribute.
|
void |
setVersion(String value)
Sets the value of the ' Version'
attribute.
|
| Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
| Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
| Method Detail |
public String getName()
setName(String),
DefaultprofilePackage.getArtifact_Name()public void setName(String value)
Name'
attribute.
value - the new value of the 'Name' attribute.getName()public String getType()
setType(String),
DefaultprofilePackage.getArtifact_Type()public void setType(String value)
Type'
attribute.
value - the new value of the 'Type' attribute.getType()public String getReference()
setReference(String),
DefaultprofilePackage.getArtifact_Reference()public void setReference(String value)
Reference'
attribute.
value - the new value of the 'Reference' attribute.getReference()public String getVersion()
setVersion(String),
DefaultprofilePackage.getArtifact_Version()public void setVersion(String value)
Version'
attribute.
value - the new value of the 'Version' attribute.getVersion()public String getDigestName()
setDigestName(String),
DefaultprofilePackage.getArtifact_DigestName()public void setDigestName(String value)
Digest Name'
attribute.
value - the new value of the 'Digest Name' attribute.getDigestName()public String getDigestValue()
setDigestValue(String),
DefaultprofilePackage.getArtifact_DigestValue()public void setDigestValue(String value)
Digest Value'
attribute.
value - the new value of the 'Digest Value' attribute.getDigestValue()public String getAccessRights()
setAccessRights(String),
DefaultprofilePackage.getArtifact_AccessRights()public void setAccessRights(String value)
Access Rights'
attribute.
value - the new value of the 'Access Rights' attribute.getAccessRights()public EList getArtifactContext()
ArtifactContext.
DefaultprofilePackage.getArtifact_ArtifactContext()public EList getArtifactDependency()
ArtifactDependency.
DefaultprofilePackage.getArtifact_ArtifactDependency()public EList getArtifact()
Artifact.
DefaultprofilePackage.getArtifact_Artifact()public EList getVariabilityPoint()
VariabilityPoint.
DefaultprofilePackage.getArtifact_VariabilityPoint()public Description getDescription()
setDescription(Description),
DefaultprofilePackage.getArtifact_Description()public void setDescription(Description value)
Description'
containment reference.
value - the new value of the 'Description' containment
reference.getDescription()public EList getArtifactType()
ArtifactType.
DefaultprofilePackage.getArtifact_ArtifactType()public void setAssetFactory(IAssetFactory theAssetFactory)
Artifact. This method is called by the AssetFactory's
create method when the Artifact is created. It should
never have to be set by the user.
theAssetFactory - with which to create elementspublic IAssetFactory getAssetFactory()
Artifact.
public ArtifactContext createArtifactContext()
ArtifactContext element using the factory assigned
to the Artifact.
- Returns:
- a new instance of an
ArtifactContext element or null if one
could not be created. - See Also:
ArtifactContext
public ArtifactDependency createArtifactDependency()
ArtifactDependency element using the factory assigned
to the Artifact.
- Returns:
- a new instance of an
ArtifactDependency element or null if one
could not be created. - See Also:
ArtifactDependency
public Artifact createArtifact()
Artifact element using the factory assigned
to the Artifact.
- Returns:
- a new instance of an
Artifact element or null if one
could not be created. - See Also:
Artifact
public VariabilityPoint createVariabilityPoint()
VariabilityPoint element using the factory assigned
to the Artifact.
- Returns:
- a new instance of a
VariabilityPoint element or null if one
could not be created. - See Also:
VariabilityPoint
public Description createDescription()
Description element using the factory assigned
to the Artifact.
- Returns:
- a new instance of a
Description element or null if one
could not be created. - See Also:
Description
public ArtifactType createArtifactType()
ArtifactType element using the factory assigned
to the Artifact.
- Returns:
- a new instance of an
ArtifactType element or null if one
could not be created. - See Also:
ArtifactType
public String computePathInSolution(String pathSeparator)
Artifact
relative to it's position in the Solution. The path is
computed by concatenating the names of each Artifact from
the Solution to this Artifact. The names
are separated by a user supplied path separator. Since it is not required
that the Artifact have a name, "ArtifactName" is used as
the name if it doesn't have one.
pathSeparator - the separator to use between path segments
Artifact relative to the
Solution element in the Asset
public String computePathFromArtifact(Artifact anArtifact,
String pathSeparator)
Artifact relative
to its position from a parent/ancestor Artifact. The path
is computed by recursively concatenating a parent's artifact path. If the
parent of an
Artifact is the Solution while computing the path, null
is returned. If an Artifact does not have a name, "ArtifactName"
is used as the name.
- Parameters:
anArtifact - compute the path relative to this parameterpathSeparator - the separator to use between path segments
- Returns:
- a path from this
Artifact relative to the artifact parameter.
public boolean addArtifact(Artifact anArtifact)
throws IllegalArgumentException
Artifact to this
Artifact.
anArtifact - to add as the nested Artifact
true if successfully added
IllegalArgumentException - if anArtifact is nullpublic boolean containsArtifact(String theArtifactName)
Artifact contains a top
level child Artifact with a particular name. The
comparison is case insensitive.
theArtifactName - to search the child artifacts for
true if a top level child artifact exists with
theArtifactNamepublic VisitorStatus accept(IArtifactVisitor visitor)
visit method is
called with this artifact. If the visitor returns true,
this method visits this artifact's children.
visitor - the visitor used to visit each Artifact
IllegalArgumentException - if visitor is null.IArtifactVisitor.visit(Artifact)
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.