Package org.jfree.data.xy
Class XYItemKey<S extends java.lang.Comparable<S>>
- java.lang.Object
-
- org.jfree.data.xy.XYItemKey<S>
-
- Type Parameters:
S
- the series key type.
public class XYItemKey<S extends java.lang.Comparable<S>> extends java.lang.Object implements ItemKey, java.lang.Comparable<XYItemKey<S>>, java.io.Serializable
An object that references one data item in anXYZDataset
. This is used internally to track the data item that a 3D object is related to, if any (and later that link is used for chart interaction). Instances of this class are immutable.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(XYItemKey<S> key)
boolean
equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.int
getItemIndex()
Returns the item index.S
getSeriesKey()
Returns the series key.int
hashCode()
java.lang.String
toJSONString()
Returns a JSON formatted string representing the key.java.lang.String
toString()
-
-
-
Constructor Detail
-
XYItemKey
public XYItemKey(S seriesKey, int itemIndex)
Creates a new instance.- Parameters:
seriesKey
- the series key.itemIndex
- the item index.
-
-
Method Detail
-
getSeriesKey
public S getSeriesKey()
Returns the series key.- Returns:
- The series key (never
null
).
-
getItemIndex
public int getItemIndex()
Returns the item index.- Returns:
- The item index.
-
equals
public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object to test (null
permitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toJSONString
public java.lang.String toJSONString()
Description copied from interface:ItemKey
Returns a JSON formatted string representing the key.- Specified by:
toJSONString
in interfaceItemKey
- Returns:
- A JSON formatted string.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-