org.eclipse.eavp.viz.datastructures.resource

Interface IVizResource

All Superinterfaces:

IResource, IVizObject

All Known Implementing Classes:

VisualizationResource

public interface IVizResource
extends IResource

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:

Matthew Wang, Jay Jay Billings, Taylor Patterson

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<IVizResource>	getChildrenResources() Return any possible children VizResources.
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.
boolean	isRemote() Retrieve the flag signifying if this file is on a remote machine or not.
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

Methods inherited from interface org.eclipse.eavp.viz.datastructures.resource.IResource

getContents, getLastModificationDate, getPath, getProperties, isPictureType, setContents, setPath, setPictureType, setProperties

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

clone, copy, equals, getDescription, getId, getName, hashCode, register, setDescription, setId, setName, unregister, update

Method Detail

getChildrenResources

java.util.ArrayList<IVizResource> getChildrenResources()

Return any possible children VizResources.

Returns:

A list containing child viz resources.

setFileSet

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

Mutator for the file set

Parameters:

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

setFileSetTitle

void setFileSetTitle(java.lang.String title)

Set the fileSetTitle

Parameters:

title - The String to use as the file set ID

getFileSet

java.lang.String[] getFileSet()

Accessor for the file set

Returns:

The list of file names in the file set

getFileSetTitle

java.lang.String getFileSetTitle()

Accessor for the file set's title

Returns:

The title used to identify the file set

setHost

void setHost(java.lang.String name)

Set the remote file flag

Parameters:

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

getHost

java.lang.String getHost()

Retrieve the name of the host for this file.

Returns:

The String for the name of the host machine.

isRemote

boolean isRemote()

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

Returns:

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