public interface IAnalysisAsset
This interface represents an asset created by an IAnalysisDocument. Each IAnalysisAsset has a name, a type and a URI from which the asset can be retrieved. IAnalysisAssets also have a select number of properties whose values can be set to manipulate the asset. New properties can not be added.
An example of an IAnalysisAsset is a plot that is stored as a Portable Network Graphic (PNG) file. It has a name, is a picture, is stored somewhere on the disk and has properties such as the x axis label and the title.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
This operation returns the name of the asset.
|
java.util.Properties |
getProperties()
This operation returns the entire list of properties for this IAnalysisAsset as an instance of Java's Properties class.
|
java.util.ArrayList<Entry> |
getPropertiesAsEntryList()
This operation returns the asset's properties as a list of Entry objects.
|
java.lang.String |
getProperty(java.lang.String key)
This operation returns the value of one of the assets properties, requested by a key.
|
AnalysisAssetType |
getType()
This operation returns the type of the IAnalysisAsset.
|
java.net.URI |
getURI()
This operation returns the URI of the asset.
|
void |
resetProperties()
This operations resets the properties of the asset to their default state.
|
boolean |
setProperty(java.lang.String key,
java.lang.String value)
This operation sets the value of a property with the given key.
|
java.lang.String getName()
This operation returns the name of the asset.
The name
AnalysisAssetType getType()
This operation returns the type of the IAnalysisAsset.
The type of the asset
java.lang.String getProperty(java.lang.String key)
This operation returns the value of one of the assets properties, requested by a key. If that property does not exist, it returns null.
key
- The key of the property that should be retrieved.
The value or null if the key does not exist.
boolean setProperty(java.lang.String key, java.lang.String value)
This operation sets the value of a property with the given key. It returns true if the key is in the properties list and false if not. Calling this operation will never add new properties to the list.
key
- The key whose value should be set.
value
- The value for the specified key. This value will only be set if the key exists.
True if the key is in the list, false otherwise.
void resetProperties()
This operations resets the properties of the asset to their default state.
java.util.Properties getProperties()
This operation returns the entire list of properties for this IAnalysisAsset as an instance of Java's Properties class.
The properties of this asset or null if no properties exist.
java.util.ArrayList<Entry> getPropertiesAsEntryList()
This operation returns the asset's properties as a list of Entry objects.
java.net.URI getURI()
This operation returns the URI of the asset.
The URI