Package adams.flow.container

Class SequencePlotterContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.SequencePlotterContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class SequencePlotterContainer
extends AbstractContainer

A container for a single plot item. Can be used to name plots.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SequencePlotterContainer.ContentType	The type of content in the container.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_PLOTNAME	the default plot name.
static String	VALUE_CONTENTTYPE	the identifier for the "content type" value.
static String	VALUE_ERROR_X	the identifier for the X error value.
static String	VALUE_ERROR_Y	the identifier for the Y error value.
static String	VALUE_METADATA	the identifier for the meta-data.
static String	VALUE_PLOTNAME	the identifier for the PlotName.
static String	VALUE_X	the identifier for the X value.
static String	VALUE_Y	the identifier for the Y value.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
SequencePlotterContainer()	Initializes the container with the default plot name and no X value and Y value of 0.0.
SequencePlotterContainer(Comparable x, Comparable y)	Initializes the container with the default plot name.
SequencePlotterContainer(String plotName, Comparable y)	Initializes the container with the specified plot name and no X value.
SequencePlotterContainer(String plotName, Comparable y, SequencePlotterContainer.ContentType type)	Initializes the container with the specified plot name and no X value.
SequencePlotterContainer(String plotName, Comparable x, Comparable y)	Initializes the container with the default plot name.
SequencePlotterContainer(String plotName, Comparable x, Comparable y, SequencePlotterContainer.ContentType type)	Initializes the container with the default plot name.
SequencePlotterContainer(String plotName, Comparable x, Comparable y, Double[] errorX, Double[] errorY, SequencePlotterContainer.ContentType type)	Initializes the container with the default plot name.

Method Summary

Modifier and Type	Method	Description
Object	addMetaData(String key, Object value)	Adds the meta-data key-value relation.
HashMap<String,Object>	getMetaData()	Returns the meta-data, if any.
boolean	hasMetaData()	Checks whether any meta-data is stored.
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_PLOTNAME

public static final String VALUE_PLOTNAME

the identifier for the PlotName.

See Also:

Constant Field Values

VALUE_X

public static final String VALUE_X

the identifier for the X value.

See Also:

Constant Field Values

VALUE_Y

public static final String VALUE_Y

the identifier for the Y value.

See Also:

Constant Field Values

VALUE_CONTENTTYPE

public static final String VALUE_CONTENTTYPE

the identifier for the "content type" value.

See Also:

Constant Field Values

DEFAULT_PLOTNAME

public static final String DEFAULT_PLOTNAME

the default plot name.

See Also:

Constant Field Values

VALUE_ERROR_X

public static final String VALUE_ERROR_X

the identifier for the X error value.

See Also:

Constant Field Values

VALUE_ERROR_Y

public static final String VALUE_ERROR_Y

the identifier for the Y error value.

See Also:

Constant Field Values

VALUE_METADATA

public static final String VALUE_METADATA

the identifier for the meta-data.

See Also:

Constant Field Values

Constructor Detail

SequencePlotterContainer

public SequencePlotterContainer()

Initializes the container with the default plot name and no X value and Y value of 0.0.

Only used for generating help information.

SequencePlotterContainer

public SequencePlotterContainer(String plotName,
                                Comparable y)

Initializes the container with the specified plot name and no X value.

Parameters:

plotName - the name of the plot

y - the y value of the plot

SequencePlotterContainer

public SequencePlotterContainer(String plotName,
                                Comparable y,
                                SequencePlotterContainer.ContentType type)

Initializes the container with the specified plot name and no X value.

Parameters:

plotName - the name of the plot

y - the y value of the plot

type - what this container represents

SequencePlotterContainer

public SequencePlotterContainer(Comparable x,
                                Comparable y)

Initializes the container with the default plot name.

Parameters:

x - the x value of the plot

y - the y value of the plot

See Also:

DEFAULT_PLOTNAME

SequencePlotterContainer

public SequencePlotterContainer(String plotName,
                                Comparable x,
                                Comparable y)

Initializes the container with the default plot name.

Parameters:

plotName - the name of the plot

x - the x value of the plot

y - the y value of the plot

SequencePlotterContainer

public SequencePlotterContainer(String plotName,
                                Comparable x,
                                Comparable y,
                                SequencePlotterContainer.ContentType type)

Initializes the container with the default plot name.

Parameters:

plotName - the name of the plot

x - the x value of the plot

y - the y value of the plot

type - what this container represents

SequencePlotterContainer

public SequencePlotterContainer(String plotName,
                                Comparable x,
                                Comparable y,
                                Double[] errorX,
                                Double[] errorY,
                                SequencePlotterContainer.ContentType type)

Initializes the container with the default plot name.

Parameters:

plotName - the name of the plot

x - the x value of the plot

y - the y value of the plot

errorX - the error range for X

errorY - the error range for Y

type - what this container represents

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

enumeration over all possible value names

addMetaData

public Object addMetaData(String key,
                          Object value)

Adds the meta-data key-value relation. Ignores null values.

Parameters:

key - the key of the meta-data value

value - the associated value

Returns:

any previously stored value, null if none replaced

hasMetaData

public boolean hasMetaData()

Checks whether any meta-data is stored.

Returns:

true if any meta-data stored

getMetaData

public HashMap<String,Object> getMetaData()

Returns the meta-data, if any.

Returns:

the meta-data, null if none stored

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available