|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface holds all the data needed to export a RAS asset using the default profile. It represents the model part of the model-view-controller implementation of the RAS export service. Although it can be, it's not intended to be implemented by clients.
Field Summary |
Fields inherited from interface com.ibm.xtools.ras.core.data.IDataModel |
NULL |
Method Summary | |
Asset |
getAsset()
Retrieves the Asset representing the profile for the
export data model. |
String |
getAssetWriter()
Retrieves the asset writer ID. |
IRASAssetWriter |
getAssetWriterInstance()
Retrieves the asset writer instance representing the writer format returned by getAssetWriter() . |
Boolean |
getOverwriteExisting()
Retrieves whether or not the export model is configured to overwrite existing resouces discovered during the export process. |
IRelatedAssetManager |
getRelatedAssetManager()
Retrieves the IRelatedAssetManager used to manage the
direct and indirect related assets contained within the
Asset being exported. |
String |
getTargetFileSystemPath()
Retrieves the asset file system target path. |
boolean |
isNewAsset()
Determines if the export data model is using an Asset that
was created by the data model or if it is one that was passed to the
export data model when it was constructed. |
void |
setAssetTargetPath(String targetPath)
Set the asset's target file system path. |
void |
setAssetWriter(String writerID)
Sets the asset writer ID. |
void |
setOverwriteExisting(boolean overwriteExisting)
Sets the property indicating if existing resources should be overwritten during the export process. |
IStatus |
validateAll()
Validates the entire data model to determine if the model is ready for export. |
IStatus |
validateProperty(String thePropertyName)
Validates the property to see if it is ready for the export. |
Methods inherited from interface com.ibm.xtools.ras.core.data.IDataModel |
addDataModelListener, containsProperty, getProperty, getPropertyAsBoolean, getPropertyAsInteger, getPropertyAsString, registerValidator, removeDataModelListener, removeProperty, setProperty, setProperty, setProperty, unregisterValidator, validateAll, validateProperty |
Method Detail |
public IStatus validateAll()
IStatus
the status object that holds the status
code and any messagespublic IStatus validateProperty(String thePropertyName) throws IllegalArgumentException
thePropertyName
- the name of the property to validate
IStatus
the status object that holds the status
code and any messages
IllegalArgumentException
- if thePropertyName
is null
public Asset getAsset()
Asset
representing the profile for the
export data model. It may be left null
prior to using the
export data model in an export operation. If so, a new Asset
is created during the export operation.
null
if the model doesn't contain an asset.public boolean isNewAsset()
Asset
that
was created by the data model or if it is one that was passed to the
export data model when it was constructed.
true
if the Asset
was created by
the data modelpublic IRelatedAssetManager getRelatedAssetManager()
IRelatedAssetManager
used to manage the
direct and indirect related assets contained within the
Asset
being exported.
Asset
being exportedpublic String getTargetFileSystemPath()
getPropertyAsString(ExportDataModelConstants.ASSET_TARGET_PATH)
.
null
if it
doesn't existpublic void setAssetTargetPath(String targetPath) throws IllegalArgumentException
setProperty(ExportDataModelConstants.ASSET_TARGET_PATH, targetPath)
.
targetPath
- the file system location where the export service is expected
to place it's output.
IllegalArgumentException
- if the targetPath is null
.public String getAssetWriter()
getPropertyAsString(ExportDataModelConstants.ASSET_WRITER_ID)
.
null
if it doesn't exist.public IRASAssetWriter getAssetWriterInstance()
getAssetWriter()
. This will be null
until opened during the export process by the open asset writer task
in the finalization phase of the export. Tasks that wish to access the
writer should join the export process during the finalization phase and
specify a priority lower than 95.
getAssetWriter()
.public void setAssetWriter(String writerID) throws IllegalArgumentException
setProperty(ExportDataModelConstants.ASSET_WRITER_ID, writerID)
.
writerID
- the ID representing the asset writer
IllegalArgumentException
- if the writer ID is null
.public Boolean getOverwriteExisting()
getPropertyAsBoolean(ExportDataModelConstants.OVERWRITE_EXISTING)
.
Boolean
indicating whether existing resources
should be overwritten during the export process or
null
if it doesn't existpublic void setOverwriteExisting(boolean overwriteExisting)
setProperty(ExportDataModelConstants.OVERWRITE_EXISTING,
overwriteExisting)
.
overwriteExisting
- boolean
flag indicating whether existing
resources should be overwritten during the export process.
|
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.