|
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 ' Asset'. xmi:ordered=true association order is (these are role names) 1. profile 2. description 3. classification 4. solution 5. usage 6. relatedAsset This is a descriptive container for an asset's artifacts. The artifacts may include models, source code, requirements, test cases, documentation, and so on. Every RAS manifest document begins with a single Asset element. This element defines the identity of the reusable software asset. An asset package is always in RAS format. However, it may not be RAS-compliant, meaning it passes all integrity constraints as documented in RAS (e.g., required content supplied). An asset package contains or references the artifacts of the asset itself. The artifacts of the asset are the things that are actually reused. Some artifacts are descriptive content which helps the Asset Conumer understand the asset, and provide guidance on how to apply the asset. This guidance may be in the form of documentation, or may be executable install programs or scripts that automate the injection of an asset's artifacts into another project (such binaries can be included as part of the descriptive content of the asset's package). Assets vary in their size, complexity, and variability. The asset package, as a whole, should provide enough information to allow the Asset Consumer to decide if he/she wants to purchase/use the asset.
The following features are supported:
Name
Id
Date
State
Version
Access Rights
Short Description
Classification
Solution
Usage
Related Asset
Profile
Description
DefaultprofilePackage.getAsset()
Method Summary | |
VisitorStatus |
accept(com.ibm.xtools.ras.profile.defauld.navigation.internal.IActivityVisitor visitor)
Accepts the given visitor. |
VisitorStatus |
accept(IArtifactVisitor visitor)
Accepts the given visitor. |
Classification |
createClassification()
Helper method used to create a Classification |
Description |
createDescription()
Helper method used to create a Description |
Profile |
createProfile()
Helper method used to create a Profile |
RelatedAsset |
createRelatedAsset()
Helper method used to create a RelatedAsset |
Solution |
createSolution()
Helper method used to create a Solution |
Usage |
createUsage()
Helper method used to create a Usage |
String |
getAccessRights()
Returns the value of the 'Access Rights' attribute |
IAssetFactory |
getAssetFactory()
Get the asset factory with which to create the elements in this asset |
IRASAssetReader |
getAssetReader()
Get the asset reader. |
Classification |
getClassification()
Returns the value of the 'Classification' containment reference. |
String |
getDate()
Returns the value of the 'Date' attribute. |
Description |
getDescription()
Returns the value of the 'Description' containment reference. |
String |
getId()
Returns the value of the 'Id' attribute. |
String |
getName()
Returns the value of the 'Name' attribute. |
Profile |
getProfile()
Returns the value of the 'Profile' containment reference. |
EList |
getRelatedAsset()
Returns the value of the 'Related Asset' containment reference list. |
String |
getShortDescription()
Returns the value of the 'Short Description' attribute. |
Solution |
getSolution()
Returns the value of the 'Solution' containment reference. |
String |
getState()
Returns the value of the 'State' attribute. |
Usage |
getUsage()
Returns the value of the 'Usage' containment reference. |
String |
getVersion()
Returns the value of the 'Version' attribute. |
void |
save(OutputStream theOutputStream,
URI theURI)
Save the asset to the given output stream |
void |
save(String theFilePath)
Save the asset to the given file path |
void |
save(URI theURI)
Save the asset to the given uri |
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 asset. |
void |
setAssetReader(IRASAssetReader theReader)
Get the asset reader. |
void |
setClassification(Classification value)
Sets the value of the ' Classification '
containment reference.
|
void |
setDate(Date value)
Sets the value of the ' Date '
attribute.
|
void |
setDate(String value)
Sets the value of the ' Date '
attribute.
|
void |
setDescription(Description value)
Sets the value of the ' Description '
containment reference.
|
void |
setId(String value)
Sets the value of the ' Id '
attribute.
|
void |
setName(String value)
Sets the value of the ' Name '
attribute.
|
void |
setProfile(Profile value)
Sets the value of the ' Profile '
containment reference.
|
void |
setShortDescription(String value)
Sets the value of the ' Short Description '
attribute.
|
void |
setSolution(Solution value)
Sets the value of the ' Solution '
containment reference.
|
void |
setState(String value)
Sets the value of the ' State '
attribute.
|
void |
setUsage(Usage value)
Sets the value of the ' Usage '
containment reference.
|
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.getAsset_Name()
public void setName(String value)
Name
'
attribute.
value
- the new value of the 'Name' attribute.getName()
public String getId()
setId(String)
,
DefaultprofilePackage.getAsset_Id()
public void setId(String value)
Id
'
attribute.
value
- the new value of the 'Id' attribute.getId()
public String getDate()
setDate(String)
,
DefaultprofilePackage.getAsset_Date()
public void setDate(String value)
Date
'
attribute.
value
- the new value of the 'Date' attribute.getDate()
public void setDate(Date value)
Date
'
attribute.
value
- the new value of the 'Date' attribute.getDate()
public String getState()
setState(String)
,
DefaultprofilePackage.getAsset_State()
public void setState(String value)
State
'
attribute.
value
- the new value of the 'State' attribute.getState()
public String getVersion()
setVersion(String)
,
DefaultprofilePackage.getAsset_Version()
public void setVersion(String value)
Version
'
attribute.
value
- the new value of the 'Version' attribute.getVersion()
public String getAccessRights()
setAccessRights(String)
,
DefaultprofilePackage.getAsset_AccessRights()
public void setAccessRights(String value)
Access Rights
'
attribute.
value
- the new value of the 'Access Rights' attribute.getAccessRights()
public String getShortDescription()
setShortDescription(String)
,
DefaultprofilePackage.getAsset_ShortDescription()
public void setShortDescription(String value)
Short Description
'
attribute.
value
- the new value of the 'Short Description'
attribute.getShortDescription()
public Classification getClassification()
setClassification(Classification)
,
DefaultprofilePackage.getAsset_Classification()
public void setClassification(Classification value)
Classification
'
containment reference.
value
- the new value of the 'Classification' containment
reference.getClassification()
public Solution getSolution()
setSolution(Solution)
,
DefaultprofilePackage.getAsset_Solution()
public void setSolution(Solution value)
Solution
'
containment reference.
value
- the new value of the 'Solution' containment
reference.getSolution()
public Usage getUsage()
setUsage(Usage)
,
DefaultprofilePackage.getAsset_Usage()
public void setUsage(Usage value)
Usage
'
containment reference.
value
- the new value of the 'Usage' containment
reference.getUsage()
public EList getRelatedAsset()
RelatedAsset
.
DefaultprofilePackage.getAsset_RelatedAsset()
public Profile getProfile()
setProfile(Profile)
,
DefaultprofilePackage.getAsset_Profile()
public void setProfile(Profile value)
Profile
'
containment reference.
value
- the new value of the 'Profile' containment
reference.getProfile()
public Description getDescription()
setDescription(Description)
,
DefaultprofilePackage.getAsset_Description()
public void setDescription(Description value)
Description
'
containment reference.
value
- the new value of the 'Description' containment
reference.getDescription()
public void setAssetFactory(IAssetFactory theAssetFactory)
theAssetFactory
- with which to create elementspublic IAssetFactory getAssetFactory()
public void setAssetReader(IRASAssetReader theReader)
theReader
- the asset's reader.public IRASAssetReader getAssetReader()
public Classification createClassification()
Classification element using the factory assigned
to the asset.
- Returns:
- a new instance of a
Classification
element or null
if one
could not be created. - See Also:
Classification
public Solution createSolution()
Solution element using the factory assigned
to the asset.
- Returns:
- a new instance of a
Solution
element or null
if one
could not be created. - See Also:
Solution
public Usage createUsage()
Usage element using the factory assigned
to the asset.
- Returns:
- a new instance of a
Usage
element or null
if one
could not be created. - See Also:
Usage
public RelatedAsset createRelatedAsset()
RelatedAsset element using the factory assigned
to the asset.
- Returns:
- a new instance of a
RelatedAsset
element or null
if one
could not be created. - See Also:
RelatedAsset
public Profile createProfile()
Profile element using the factory assigned
to the asset.
- Returns:
- a new instance of a
Profile
element or null
if one
could not be created. - See Also:
Profile
public Description createDescription()
Description element using the factory assigned
to the asset.
- Returns:
- a new instance of a
Description
element or null
if one
could not be created. - See Also:
Description
public VisitorStatus accept(IArtifactVisitor visitor)
visit
method is
called with this Asset
. Each Artifact
contained in the Asset
will be visited. The visitor
returns a VisitorStatus
indicating how visition should
proceed.
visitor
- the visitor used to visit each Artifact
IllegalArgumentException
- if visitor
is null
.IArtifactVisitor.visit(Artifact)
public VisitorStatus accept(com.ibm.xtools.ras.profile.defauld.navigation.internal.IActivityVisitor visitor)
visit
method is
called with this Asset
. Each Activity
contained in the Asset
will be visited. The visitor
returns a VisitorStatus
indicating how visition should
proceed.
visitor
- the visitor used to visit each Activity
IllegalArgumentException
- if visitor
is null
.IActivityVisitor.visit(Activity)
public void save(String theFilePath) throws NullPointerException, IOException
theFilePath
- the file path to which to save
NullPointerException
- if the parameter is null
IOException
- if an error occurs saving the filepublic void save(OutputStream theOutputStream, URI theURI) throws NullPointerException, IOException
theOutputStream
- the output stream to which to savetheURI
- the URI used during saving. Setting this helps in seting the
correct cross-file references.
NullPointerException
- if the parameter is null
IOException
- if an error occurs saving the filepublic void save(URI theURI) throws NullPointerException, IOException
theURI
- the uri to which to save
NullPointerException
- if the parameter is null
IOException
- if an error occurs saving the file
|
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.