org.jfree.data.xy

Class XYDataItem

Implemented Interfaces:
Cloneable, Comparable, Serializable

public class XYDataItem
extends java.lang.Object
implements Cloneable, Comparable, Serializable

Represents one (x, y) data item for an XYSeries.

Constructor Summary

XYDataItem(Number x, Number y)
Constructs a new data item.
XYDataItem(double x, double 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.
Number
getX()
Returns the x-value.
double
getXValue()
Returns the x-value as a double primitive.
Number
getY()
Returns the y-value.
double
getYValue()
Returns the y-value as a double primitive.
int
hashCode()
Returns a hash code.
void
setY(Number y)
Sets the y-value for this data item.
void
setY(double y)
Sets the y-value for this data item.
String
toString()
Returns a string representing this instance, primarily for debugging use.

Constructor Details

XYDataItem

public XYDataItem(Number x,
                  Number y)
Constructs a new data item.
Parameters:
x - the x-value (null NOT permitted).
y - the y-value (null permitted).

XYDataItem

public XYDataItem(double x,
                  double y)
Constructs a new data item.
Parameters:
x - the x-value.
y - the y-value.

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.

getX

public Number getX()
Returns the x-value.
Returns:
The x-value (never null).

getXValue

public double getXValue()
Returns the x-value as a double primitive.
Returns:
The x-value.
Since:
1.0.9

getY

public Number getY()
Returns the y-value.
Returns:
The y-value (possibly null).

getYValue

public double getYValue()
Returns the y-value as a double primitive.
Returns:
The y-value.
Since:
1.0.9

hashCode

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

setY

public void setY(Number 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).

setY

public void setY(double 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.

toString

public String toString()
Returns a string representing this instance, primarily for debugging use.
Returns:
A string.