Module org.jfree.chart

Package org.jfree.data

Class ComparableObjectItem

java.lang.Object

org.jfree.data.ComparableObjectItem

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ComparableObjectItem>

Direct Known Subclasses:

OHLCItem, VectorDataItem, XIntervalDataItem, XYIntervalDataItem, YIntervalDataItem

public class ComparableObjectItem
extends Object
implements Comparable<ComparableObjectItem>, Cloneable, Serializable

Represents one (Comparable, Object) data item for use in a ComparableObjectSeries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComparableObjectItem(Comparable x, Object y)	Constructs a new data item.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of this object.
int	compareTo(ComparableObjectItem other)	Returns an integer indicating the order of this object relative to another object.
boolean	equals(Object obj)	Tests if this object is equal to another.
protected Comparable	getComparable()	Returns the x-value.
protected Object	getObject()	Returns the y-value.
int	hashCode()	Returns a hash code.
protected void	setObject(Object y)	Sets the y-value for this data item.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparableObjectItem

public ComparableObjectItem(Comparable x,
                            Object y)

Constructs a new data item.

Parameters:

x - the x-value (null NOT permitted).

y - the y-value (null permitted).

Method Detail

getComparable

protected Comparable getComparable()

Returns the x-value.

Returns:

The x-value (never null).

getObject

protected Object getObject()

Returns the y-value.

Returns:

The y-value (possibly null).

setObject

protected void setObject(Object y)

Sets the y-value for this data item. Note that there is no corresponding method to change the x-value.

Parameters:

y - the new y-value (null permitted).

compareTo

public int compareTo(ComparableObjectItem other)

Returns an integer indicating the order of this object relative to another object.

For the order we consider only the x-value: negative == "less-than", zero == "equal", positive == "greater-than".

Specified by:

compareTo in interface Comparable<ComparableObjectItem>

Parameters:

other - the object being compared to.

Returns:

An integer indicating the order of this data pair object relative to another object.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this object.

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - not thrown by this class, but subclasses may differ.

equals

public boolean equals(Object obj)

Tests if this object is equal to another.

Overrides:

equals in class Object

Parameters:

obj - the object to test against for equality (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code.

Overrides:

hashCode in class Object

Returns:

A hash code.