com.jrefinery.data
Class XYSeries

java.lang.Object
  |
  +--com.jrefinery.data.Series
        |
        +--com.jrefinery.data.XYSeries
All Implemented Interfaces:
java.lang.Cloneable

public class XYSeries
extends Series

Represents a sequence of zero or more data pairs in the form (x, y).

Author:
DG

Constructor Summary
XYSeries(java.lang.String name)
          Constructs a new xy-series that contains no data.
XYSeries(java.lang.String name, boolean allowDuplicateXValues)
          Constructs a new xy-series that contains no data.
 
Method Summary
 void add(double x, double y)
          Adds a data item to the series.
 void add(double x, java.lang.Number y)
          Adds a data item to the series.
 void add(java.lang.Number x, java.lang.Number y)
          Adds new data to the series.
 void add(XYDataPair pair)
          Adds a data item to the series.
 void clear()
          Removes all data pairs from the series.
 java.lang.Object clone()
          Returns a clone of the series.
 XYSeries createCopy(int start, int end)
          Creates a new series by copying a subset of the data in this time series.
 void delete(int start, int end)
          Deletes a range of items from the series.
 XYDataPair getDataPair(int index)
          Return the data pair with the specified index.
 int getItemCount()
          Returns the number of items in the series.
 java.lang.Number getXValue(int index)
          Returns the x-value at the specified index.
 java.lang.Number getYValue(int index)
          Returns the y-value at the specified index.
 void update(int index, java.lang.Number y)
          Updates the value of an item in the series.
 
Methods inherited from class com.jrefinery.data.Series
addChangeListener, addPropertyChangeListener, firePropertyChange, fireSeriesChanged, getDescription, getName, notifyListeners, removeChangeListener, removePropertyChangeListener, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XYSeries

public XYSeries(java.lang.String name)
Constructs a new xy-series that contains no data.

By default, duplicate x-values will be allowed for the series.

Parameters:
name - the series name.

XYSeries

public XYSeries(java.lang.String name,
                boolean allowDuplicateXValues)
Constructs a new xy-series that contains no data. You can specify whether or not duplicate x-values are allowed for the series.
Parameters:
name - the series name.
allowDuplicateXValues - a flag that controls whether duplicate x-values are allowed.
Method Detail

getItemCount

public int getItemCount()
Returns the number of items in the series.
Returns:
The item count.

add

public void add(XYDataPair pair)
         throws SeriesException
Adds a data item to the series.
Parameters:
pair - the (x, y) pair.
Throws:
SeriesException - if there is a problem adding the data.

add

public void add(double x,
                double y)
         throws SeriesException
Adds a data item to the series.
Parameters:
x - the x value.
y - the y value.
Throws:
SeriesException - if there is a problem adding the data.

add

public void add(double x,
                java.lang.Number y)
         throws SeriesException
Adds a data item to the series.

The unusual pairing of parameter types is to make it easier to add null y-values.

Parameters:
x - the x value.
y - the y value.
Throws:
SeriesException - if there is a problem adding the data.

add

public void add(java.lang.Number x,
                java.lang.Number y)
         throws SeriesException
Adds new data to the series.

Throws an exception if the x-value is a duplicate AND the allowDuplicateXValues flag is false.

Parameters:
x - the x-value.
y - the y-value.
Throws:
SeriesException - if there is a problem adding the data.

delete

public void delete(int start,
                   int end)
Deletes a range of items from the series.
Parameters:
start - The start index (zero-based).
end - The end index (zero-based).

clear

public void clear()
Removes all data pairs from the series.

getDataPair

public XYDataPair getDataPair(int index)
Return the data pair with the specified index.
Parameters:
index - The index.
Returns:
The data pair with the specified index.

getXValue

public java.lang.Number getXValue(int index)
Returns the x-value at the specified index.
Parameters:
index - The index.
Returns:
The x-value.

getYValue

public java.lang.Number getYValue(int index)
Returns the y-value at the specified index.
Parameters:
index - The index.
Returns:
The y-value.

update

public void update(int index,
                   java.lang.Number y)
Updates the value of an item in the series.
Parameters:
index - The item (zero based index).
y - The new value.

clone

public java.lang.Object clone()
Returns a clone of the series.
Overrides:
clone in class Series
Returns:
a clone of the time series.

createCopy

public XYSeries createCopy(int start,
                           int end)
Creates a new series by copying a subset of the data in this time series.
Parameters:
start - The index of the first item to copy.
end - The index of the last item to copy.
Returns:
A series containing a copy of this series from start until end.