|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The profile factory is used to create or load instances of the profiles. It handles the version upgrade (if required) and identification of the type of profile. This interface is not intended to be implemented by clients.
Method Summary | |
ComposeableAdapterFactory |
getAdapterFactory(String theProfileId)
Retrieves the ComposeableAdapterFactory factory for the
specified profile id. |
IAssetFactory |
getAssetFactory(String theProfileId)
Retrieves the asset factory for the specified profile id. |
IRASAssetReader |
getAssetReader(String theResourcePath)
Get the asset reader for the specified resource path |
IRASAssetReader |
getAssetReader(String theResourcePath,
String theManifestReference)
Get the asset reader for the specified resource path |
IRASAssetWriter |
getAssetWriter(String theStorageFormat)
Get the asset writer for the specified storage format. |
IProfileExtension |
getProfile(String theProfileId)
Retrieves the profile extension registered with the specified profile id. |
IProfileExtension[] |
getProfiles()
Retrieves all valid profile extensions registered with the profile service. |
IProfileFormat[] |
getReaderFormats()
Returns an array of the supported formats for reading an asset. |
IProfileFormat[] |
getWriterFormats()
Returns an array of the supported formats for writing an asset. |
IStatus |
initializeAsset(EObject theAsset)
Initializes the asset by invoking the IAssetInitializer
associated with the asset's profile ID. |
Method Detail |
public IRASAssetReader getAssetReader(String theResourcePath) throws IOException, IllegalArgumentException
theResourcePath
- the path to the resource. For instance a file path for file
based assets.
null
if none was found
IOException
- if there is an error reading the resource path
IllegalArgumentException
- if theResourcePath
is null
public IRASAssetReader getAssetReader(String theResourcePath, String theManifestReference) throws IOException, IllegalArgumentException
theResourcePath
- the path to the resource. For instance a file path for file
based assets.theManifestReference
- optional; the manifest to use in the asset. This may be
null
in which case the reader should use the
default manifest.
null
if none was found
IOException
- if there is an error reading the resource path
IllegalArgumentException
- if theResourcePath
is null
public IRASAssetWriter getAssetWriter(String theStorageFormat) throws IOException, IllegalArgumentException
theStorageFormat
- indicates the format in which the asset will be stored.
null
if none was
found
IOException
- if an error occurred getting the asset writer
IllegalArgumentException
- if theStorageFormat
is null
public IAssetFactory getAssetFactory(String theProfileId) throws IllegalArgumentException
theProfileId
- the id of the profile
null
if the profile id is not
supported
IllegalArgumentException
- if the theProfileId
is null
public ComposeableAdapterFactory getAdapterFactory(String theProfileId) throws IllegalArgumentException
ComposeableAdapterFactory
factory for the
specified profile id. If one has not been properly registered for the
specified profile id then null
is returned.
theProfileId
- the id of the profile
null
if an adapter factory
has not been properly registered for the profile id
IllegalArgumentException
- if the theProfileId
is null
public IProfileExtension getProfile(String theProfileId) throws IllegalArgumentException
theProfileId
- of the profile to retrieve
null
if the profile id is
not supported
IllegalArgumentException
- if the theProfileId
is null
public IProfileExtension[] getProfiles()
public IStatus initializeAsset(EObject theAsset) throws IllegalArgumentException
IAssetInitializer
associated with the asset's profile ID. Each initializer that is part of
the ancestry of the profile ID will be invoked. They are invoked from
least to most derived profile.
theAsset
- the asset instance to initialize with
IllegalArgumentException
- if theAsset
is null
public IProfileFormat[] getReaderFormats()
public IProfileFormat[] getWriterFormats()
|
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.