org.eclipse.eavp.viz.datastructures.resource

Class VisualizationResource

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

org.eclipse.eavp.viz.datastructures.resource.VisualizationResource

All Implemented Interfaces:

IResource, IVizResource, IVizObject, IVizUpdateable

public class VisualizationResource
extends VizObject
implements IVizResource

The VizResource is used for loading a data set that should be visualized in one of the platform's many visualization services. It is significantly different than the base resource in that it can track multiple files that collectively define a single resource as well as whether or not that resource is a local or remote file.

Author:

Scott Forest Hull II, Matthew Wang, Jay Jay Billings, Taylor Patterson

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Constructor Summary

Constructors

Constructor and Description
VisualizationResource() The default constructor.
VisualizationResource(java.io.File resourceFile) An alternative constructor that takes the File as an argument.
VisualizationResource(java.io.File resourceFile, java.util.ArrayList<IVizResource> children) The Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation provides a deep copy of the VizResource.
void	copy(VisualizationResource otherResource) This operation performs a deep copy of the attributes of another VizResource into the current VizResource.
boolean	equals(java.lang.Object otherObject) This operation is used to check equality between the ICEResource and another ICEResource.
java.util.ArrayList<IVizResource>	getChildrenResources() Return any possible children VizResources.
java.io.File	getContents() This operations returns the contents of the Resource as an instance of File.
java.lang.String[]	getFileSet() Accessor for the file set
java.lang.String	getFileSetTitle() Accessor for the file set's title
java.lang.String	getHost() Retrieve the name of the host for this 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.
int	hashCode() This operation returns the hashcode value of the ICEObject.
boolean	isPictureType() This operation returns true if the ICEResource is an image and false if not based upon the isPicture attribute.
boolean	isRemote() Retrieve the flag signifying if this file is on a remote machine or not.
void	setContents(java.io.File resourceFile) This operation sets the File which the Resource represents.
void	setFileSet(java.lang.String[] fileSet) Mutator for the file set
void	setFileSetTitle(java.lang.String title) Set the fileSetTitle
void	setHost(java.lang.String name) Set the remote file flag
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.

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizObject

copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister, update

Constructor Detail

VisualizationResource

public VisualizationResource()

The default constructor. If this constructor is used, a second call to setContents() must be made.

VisualizationResource

public VisualizationResource(java.io.File resourceFile)
                      throws java.io.IOException

An alternative constructor that takes the File as an argument. The default values of the name, id and description for this class are the filename, 1 and the absolute path, respectively. It is the same as calling the no-arg constructor followed by calling setContents().

Parameters:

resourceFile -

The file that the Resource should be created to represent.

Throws:

java.io.IOException

VisualizationResource

public VisualizationResource(java.io.File resourceFile,
                             java.util.ArrayList<IVizResource> children)
                      throws java.io.IOException

The Constructor. This allows for the creation of a VizResource that is composed of other VizResources.

Parameters:

resourceFile -

children -

Throws:

java.io.IOException

Method Detail

getLastModificationDate

public java.lang.String getLastModificationDate()

Description copied from interface: IResource

This operation returns the last modification date of the file.

Specified by:

getLastModificationDate in interface IResource

Returns:

The date.

getContents

public java.io.File getContents()

Description copied from interface: IResource

This operations returns the contents of the Resource as an instance of File.

Specified by:

getContents in interface IResource

Returns:

The file.

getPath

public java.net.URI getPath()

Description copied from interface: IResource

This operation returns the URI to the Resource.

Specified by:

getPath in interface IResource

Returns:

The path as a URL.

setPath

public void setPath(java.net.URI path)

Description copied from interface: IResource

This operation sets the path to the Resource and is an alternative to setContents(). It will reset the File handle if it is different.

Specified by:

setPath in interface IResource

getProperties

public java.util.ArrayList<VizEntry> getProperties()

Description copied from interface: IResource

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.

Specified by:

getProperties in interface IResource

Returns:

The properties or null if there are no properties.

setProperties

public void setProperties(java.util.ArrayList<VizEntry> props)

Description copied from interface: IResource

This operation returns the set of Entries that describe specific properties of the resource. The properties can be set multiple times.

Specified by:

setProperties in interface IResource

Parameters:

props -

The properties.

isPictureType

public boolean isPictureType()

Description copied from interface: IResource

This operation returns true if the ICEResource is an image and false if not based upon the isPicture attribute.

Specified by:

isPictureType in interface IResource

Returns:

True if this is a picture, false otherwise.

setPictureType

public void setPictureType(boolean isPicture)

Description copied from interface: IResource

An operation that sets the isPicture attribute on ICEResource.

Specified by:

setPictureType in interface IResource

Parameters:

isPicture -

Determines if ICEResource is a picture.

copy

public void copy(VisualizationResource otherResource)

This operation performs a deep copy of the attributes of another VizResource into the current VizResource.

Parameters:

otherResource - The other VizResource from which information should be copied.

clone

public java.lang.Object clone()

This operation provides a deep copy of the VizResource.

Specified by:

clone in interface IVizObject

Overrides:

clone in class VizObject

Returns:

A clone of the VizResource.

equals

public boolean equals(java.lang.Object otherObject)

This operation is used to check equality between the ICEResource and another ICEResource. It returns true if the ICEResources are equal and false if they are not.

Specified by:

equals in interface IVizObject

Overrides:

equals in class VizObject

Parameters:

otherICEResource - The other ICEResource to which this ICEResource should be compared.

Returns:

True if the ICEResources are equal, false otherwise.

See Also:

Identifiable#equals(Object otherObject)

hashCode

public int hashCode()

This operation returns the hashcode value of the ICEObject.

Specified by:

hashCode in interface IVizObject

Overrides:

hashCode in class VizObject

Returns:

The hashcode for the ICEResource.

See Also:

Identifiable#hashCode()

setContents

public void setContents(java.io.File resourceFile)
                 throws java.io.IOException,
                        java.lang.NullPointerException

Description copied from interface: IResource

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.

Specified by:

setContents in interface IResource

Parameters:

resourceFile -

The file that the Resource should be created to represent.

Throws:

java.io.IOException

java.lang.NullPointerException

getChildrenResources

public java.util.ArrayList<IVizResource> getChildrenResources()

Description copied from interface: IVizResource

Return any possible children VizResources.

Specified by:

getChildrenResources in interface IVizResource

Returns:

A list containing child viz resources.

setFileSet

public void setFileSet(java.lang.String[] fileSet)

Description copied from interface: IVizResource

Mutator for the file set

Specified by:

setFileSet in interface IVizResource

Parameters:

fileSet - The list of file names to add to the file set

setFileSetTitle

public void setFileSetTitle(java.lang.String title)

Description copied from interface: IVizResource

Set the fileSetTitle

Specified by:

setFileSetTitle in interface IVizResource

Parameters:

title - The String to use as the file set ID

getFileSet

public java.lang.String[] getFileSet()

Description copied from interface: IVizResource

Accessor for the file set

Specified by:

getFileSet in interface IVizResource

Returns:

The list of file names in the file set

getFileSetTitle

public java.lang.String getFileSetTitle()

Description copied from interface: IVizResource

Accessor for the file set's title

Specified by:

getFileSetTitle in interface IVizResource

Returns:

The title used to identify the file set

setHost

public void setHost(java.lang.String name)

Description copied from interface: IVizResource

Set the remote file flag

Specified by:

setHost in interface IVizResource

Parameters:

name - The new name of the host. If local, use "localhost". Any other hostname will be treated as remote.

getHost

public java.lang.String getHost()

Description copied from interface: IVizResource

Retrieve the name of the host for this file.

Specified by:

getHost in interface IVizResource

Returns:

The String for the name of the host machine.

isRemote

public boolean isRemote()

Description copied from interface: IVizResource

Retrieve the flag signifying if this file is on a remote machine or not.

Specified by:

isRemote in interface IVizResource

Returns:

True if this resource is on a remote machine; false otherwise