Package adams.gui.visualization.sequence

Class XYSequenceContainer

java.lang.Object

adams.gui.visualization.container.AbstractContainer

adams.gui.visualization.sequence.XYSequenceContainer

All Implemented Interfaces:

IDHandler, MutableIDHandler, ColorContainer, NamedContainer, VisibilityContainer, Serializable, Comparable<AbstractContainer>

Direct Known Subclasses:

SequencePlotContainer

public class XYSequenceContainer
extends AbstractContainer
implements ColorContainer, VisibilityContainer, NamedContainer

A container class for an XY sequence.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_Color	the associated color.
protected boolean	m_Visible	whether the sequence is visible.

Fields inherited from class adams.gui.visualization.container.AbstractContainer

m_Manager, m_Payload, m_Updating

Constructor Summary

Constructors

Constructor	Description
XYSequenceContainer(XYSequenceContainerManager manager, XYSequence data)	Initializes the container.

Method Summary

Modifier and Type	Method	Description
void	assign(XYSequenceContainer c)	Updates itself with the values from given container (the manager is excluded!).
int	compareTo(AbstractContainer o)	Compares this object with the specified object for order.
Color	getColor()	Returns the current color in use.
XYSequence	getData()	Returns the stored sequence.
String	getDisplayID()	Returns the displayed container's ID.
String	getID()	Returns the container's ID.
int	hashCode()	Returns the hashcode of the sequence.
protected void	initialize()	Initializes members.
boolean	isVisible()	Returns whether the sequence is visible.
void	setColor(Color value)	Sets the color to use.
void	setData(XYSequence value)	Sets the sequence.
void	setID(String value)	Sets the container's ID.
void	setVisible(boolean value)	Sets the sequence's visibility.
String	toString()	Returns a short string representation of the container.

Methods inherited from class adams.gui.visualization.container.AbstractContainer

assign, copy, equals, getManager, getPayload, invalidate, postProcessPayload, setManager, setPayload

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_Color

protected Color m_Color

the associated color.

m_Visible

protected boolean m_Visible

whether the sequence is visible.

Constructor Detail

XYSequenceContainer

public XYSequenceContainer(XYSequenceContainerManager manager,
                           XYSequence data)

Initializes the container.

Parameters:

manager - the owning manager

data - the sequence to encapsulate

Method Detail

initialize

protected void initialize()

Initializes members.

Overrides:

initialize in class AbstractContainer

assign

public void assign(XYSequenceContainer c)

Updates itself with the values from given container (the manager is excluded!).

Parameters:

c - the container to get the values from

setColor

public void setColor(Color value)

Sets the color to use.

Specified by:

setColor in interface ColorContainer

Parameters:

value - the color

getColor

public Color getColor()

Returns the current color in use.

Specified by:

getColor in interface ColorContainer

Returns:

the color

setVisible

public void setVisible(boolean value)

Sets the sequence's visibility.

Specified by:

setVisible in interface VisibilityContainer

Parameters:

value - if true then the sequence will be visible

isVisible

public boolean isVisible()

Returns whether the sequence is visible.

Specified by:

isVisible in interface VisibilityContainer

Returns:

true if the sequence is visible

setData

public void setData(XYSequence value)

Sets the sequence.

Parameters:

value - the sequence

getData

public XYSequence getData()

Returns the stored sequence.

Returns:

the sequence

setID

public void setID(String value)

Sets the container's ID.

Specified by:

setID in interface MutableIDHandler

Specified by:

setID in interface NamedContainer

Parameters:

value - the new ID

getID

public String getID()

Returns the container's ID.

Specified by:

getID in interface IDHandler

Specified by:

getID in interface NamedContainer

Returns:

the ID

getDisplayID

public String getDisplayID()

Returns the displayed container's ID.

Specified by:

getDisplayID in interface NamedContainer

Returns:

the displayed ID

compareTo

public int compareTo(AbstractContainer o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable<AbstractContainer>

Overrides:

compareTo in class AbstractContainer

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this object.

hashCode

public int hashCode()

Returns the hashcode of the sequence.

Overrides:

hashCode in class Object

Returns:

the hashcode

toString

public String toString()

Returns a short string representation of the container.

Overrides:

toString in class AbstractContainer

Returns:

a string representation