public interface IResource extends IVizObject
The Resource class represents persistent data resources used by ICE and the other software packages with which it interacts. This includes files containing simulation input and output data, movies and plots, amongst others.
Modifier and Type | Method and Description |
---|---|
java.io.File |
getContents()
This operations returns the contents of the Resource as an instance of
File.
|
java.lang.String |
getLastModificationDate()
This operation returns the last modification date of the file.
|
java.net.URI |
getPath()
This operation returns the URI to the Resource.
|
java.util.ArrayList<VizEntry> |
getProperties()
This operation associates a set of Entries with the resource that
describe specific properties.
|
boolean |
isPictureType()
This operation returns true if the ICEResource is an image and false if
not based upon the isPicture attribute.
|
void |
setContents(java.io.File resourceFile)
This operation sets the File which the Resource represents.
|
void |
setPath(java.net.URI path)
This operation sets the path to the Resource and is an alternative to
setContents().
|
void |
setPictureType(boolean isPicture)
An operation that sets the isPicture attribute on ICEResource.
|
void |
setProperties(java.util.ArrayList<VizEntry> props)
This operation returns the set of Entries that describe specific
properties of the resource.
|
clone, copy, equals, getDescription, getId, getName, hashCode, register, setDescription, setId, setName, unregister, update
java.lang.String getLastModificationDate()
This operation returns the last modification date of the file.
The date.
java.io.File getContents()
This operations returns the contents of the Resource as an instance of File.
The file.
java.net.URI getPath()
This operation returns the URI to the Resource.
The path as a URL.
void setPath(java.net.URI path)
This operation sets the path to the Resource and is an alternative to setContents(). It will reset the File handle if it is different.
path
- java.util.ArrayList<VizEntry> getProperties()
This operation associates a set of Entries with the resource that describe specific properties. The list of Entries is returned by reference and is not a deep copy, i.e. - changing one will change it on the resource.
The properties or null if there are no properties.
void setProperties(java.util.ArrayList<VizEntry> props)
This operation returns the set of Entries that describe specific properties of the resource. The properties can be set multiple times.
props
- The properties.
boolean isPictureType()
This operation returns true if the ICEResource is an image and false if not based upon the isPicture attribute.
True if this is a picture, false otherwise.
void setPictureType(boolean isPicture)
An operation that sets the isPicture attribute on ICEResource.
isPicture
- Determines if ICEResource is a picture.
void setContents(java.io.File resourceFile) throws java.io.IOException, java.lang.NullPointerException
This operation sets the File which the Resource represents. The default values of the name, id and description for this class are the filename, 1 and the absolute path, respectively.
resourceFile
- The file that the Resource should be created to represent.
java.io.IOException
java.lang.NullPointerException