Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data

Class ComparableObjectItem

Implemented Interfaces:
Cloneable, Comparable, Serializable
Known Direct Subclasses:
OHLCItem, VectorDataItem, XIntervalDataItem, XYIntervalDataItem, YIntervalDataItem
public class ComparableObjectItem
extends java.lang.Object
implements Cloneable, Comparable, Serializable
Represents one (Comparable, Object) data item for use in a ComparableObjectSeries.
Since:
1.0.3

Constructor Summary

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

Method Summary

Object
clone()
Returns a clone of this object.
int
compareTo(Object o1)
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.

Constructor Details

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 Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this object.
Returns:
A clone.

compareTo

public int compareTo(Object o1)
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".

Parameters:
o1 - the object being compared to.
Returns:
An integer indicating the order of this data pair object relative to another object.

equals

public boolean equals(Object obj)
Tests if this object is equal to another.
Parameters:
obj - the object to test against for equality (null permitted).
Returns:
A boolean.

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).

hashCode

public int hashCode()
Returns a hash code.
Returns:
A hash code.

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).

Overview Package Class Use Source Tree Index Deprecated About