org.eclipse.eavp.viz

Class PlotEntryContentProvider

java.lang.Object

org.eclipse.eavp.viz.PlotEntryContentProvider

All Implemented Interfaces:

IVizEntryContentProvider

public class PlotEntryContentProvider
extends java.lang.Object
implements IVizEntryContentProvider

This class provides an IEntryContentProvider for plots, which are stored as Entries for an ICEResource wrapping a VisIt-compatible file.

The Entry's parent should be the category or group of plots, e.g., "Meshes", "Scalars", "Vectors", or "Materials".

The Entry's allow values are "true" or "false", which correspond to being plotted or not plotted, respectively.

Author:

Jordan H. Deyton

Constructor Summary

Constructors

Constructor and Description
PlotEntryContentProvider(java.lang.String parent) The default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone of this PlotEntryContentProvider.
boolean	equals(java.lang.Object otherProvider) This operation checks to see if this PlotEntryContentProvider is equal to an input IEntryContentProvider.
java.util.ArrayList<java.lang.String>	getAllowedValues() This operation returns a list of allowed values.
VizAllowedValueType	getAllowedValueType() This operation retrieves the description of the types of values that are stored in an instance of the Entry class.
java.lang.String	getDefaultValue() This operation retrieves the default String for the value of instances of the Entry class.
java.lang.String	getParent() Returns the name of the parent.
java.lang.String	getTag() Returns the tag.
int	hashCode() Compute and return the hash code for instances of this object
void	setAllowedValues(java.util.ArrayList<java.lang.String> allowedValues)
void	setAllowedValueType(VizAllowedValueType type) Sets the AllowedValueType.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value.Can not be null! (Can be the empty string!)
void	setParent(java.lang.String parentName) Sets the name of the parent.
void	setTag(java.lang.String tagValue) Sets the tag.Can be set to null.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotEntryContentProvider

public PlotEntryContentProvider(java.lang.String parent)

The default constructor.

Parameters:

parent - A String representing the parent group of plots.

Method Detail

getAllowedValues

public java.util.ArrayList<java.lang.String> getAllowedValues()

This operation returns a list of allowed values. In this case, those values are "true" and "false".

Specified by:

getAllowedValues in interface IVizEntryContentProvider

Returns:

The list of Strings of allowed values

setAllowedValues

public void setAllowedValues(java.util.ArrayList<java.lang.String> allowedValues)

Specified by:

setAllowedValues in interface IVizEntryContentProvider

Parameters:

allowedValues -

The allowedValues. Can not be null.

getDefaultValue

public java.lang.String getDefaultValue()

This operation retrieves the default String for the value of instances of the Entry class.

Specified by:

getDefaultValue in interface IVizEntryContentProvider

Returns:

The returned value.

getAllowedValueType

public VizAllowedValueType getAllowedValueType()

This operation retrieves the description of the types of values that are stored in an instance of the Entry class.

Specified by:

getAllowedValueType in interface IVizEntryContentProvider

Returns:

The returned value.

setAllowedValueType

public void setAllowedValueType(VizAllowedValueType type)

Description copied from interface: IVizEntryContentProvider

Sets the AllowedValueType.

Specified by:

setAllowedValueType in interface IVizEntryContentProvider

Parameters:

type -

The allowedValueType to set.

setParent

public void setParent(java.lang.String parentName)

Description copied from interface: IVizEntryContentProvider

Sets the name of the parent. Can not be null.

Specified by:

setParent in interface IVizEntryContentProvider

Parameters:

parentName -

The name of the parent.

getParent

public java.lang.String getParent()

Description copied from interface: IVizEntryContentProvider

Returns the name of the parent.

Specified by:

getParent in interface IVizEntryContentProvider

Returns:

The returned value.

equals

public boolean equals(java.lang.Object otherProvider)

This operation checks to see if this PlotEntryContentProvider is equal to an input IEntryContentProvider.

Specified by:

equals in interface IVizEntryContentProvider

Overrides:

equals in class java.lang.Object

Parameters:

otherProvider - The IEntryContentProvider to check if this is equal to.

Returns:

True if equivalent, false otherwise.

hashCode

public int hashCode()

Compute and return the hash code for instances of this object

Specified by:

hashCode in interface IVizEntryContentProvider

Overrides:

hashCode in class java.lang.Object

Returns:

The returned value.

getTag

public java.lang.String getTag()

Description copied from interface: IVizEntryContentProvider

Returns the tag.

Specified by:

getTag in interface IVizEntryContentProvider

Returns:

The returned value.

setTag

public void setTag(java.lang.String tagValue)

Description copied from interface: IVizEntryContentProvider

Sets the tag.Can be set to null.

Specified by:

setTag in interface IVizEntryContentProvider

Parameters:

tagValue -

The tag value to set.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Description copied from interface: IVizEntryContentProvider

Sets the default value.Can not be null! (Can be the empty string!)

Specified by:

setDefaultValue in interface IVizEntryContentProvider

Parameters:

defaultValue -

The default value to set.

clone

public java.lang.Object clone()

Returns a clone of this PlotEntryContentProvider.

Specified by:

clone in interface IVizEntryContentProvider

Overrides:

clone in class java.lang.Object

Returns:

A clone of the IEntryContentProvider.