|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is used to read in an asset in a storage format independent way. Any file read-access to the asset should be done throught this class. This interface is not intended to be implemented by clients.
Method Summary | |
void |
close()
Closes any resources used by the reader. |
String |
getAssetPath()
Get the asset's path. |
IRASAssetReader |
getAssetReader(String theReference)
Gets a reference that is specified in the asset as an asset reader. |
Document |
getManifest()
Get the asset's manifest in the latest supported format. |
String |
getManifestReference()
Get the asset's manifest reference. |
InputStream |
getResourceStream(String theReference)
Gets a reference that is specified in the asset as a stream. |
Object |
loadAsset()
Load the asset as an emf model. |
void |
open(String theAssetPath,
String theManifestReference)
Set the asset's path. |
boolean |
performExportIfRelatedAssets()
Indicates if it should recursively export this asset or treat it as already packaged. |
Method Detail |
public String getAssetPath()
public void open(String theAssetPath, String theManifestReference)
theAssetPath
- the new asset paththeManifestReference
- optional; the manifest to use in the asset. This may be null
in which case the reader should use the default manifest.public Document getManifest() throws IOException, NullPointerException
IOException
- if an error occured retrieving the manifest
NullPointerException
- if an error occured retrieving the manifest because an
argument was null
public Object loadAsset() throws IOException, NullPointerException
null
if it can't be found
NullPointerException
- if the manifest is null
or it couldn't be
initialized
IOException
- if an error occured retrieving the manifestpublic InputStream getResourceStream(String theReference) throws IOException
theReference
- the reference as specified in the asset
null
if the resource doesn't exist.
IOException
- if an error occured retrieving the reference or if it didn't
existpublic void close()
public IRASAssetReader getAssetReader(String theReference)
theReference
- the reference as specified in the asset
null
if the
reference doesn't point to a valid asset/manifest.public boolean performExportIfRelatedAssets()
true
if the assets should be processedpublic String getManifestReference()
null
. For instance for a bundled asset this can point
to the specific manifest to use.
|
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.