ilog.views.chart.data

Class IlvMovingAvgDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.IlvCombinedDataSet

ilog.views.chart.data.IlvMovingAvgDataSet

All Implemented Interfaces:

IlvDataSet, IlvDataSetList, IlvBatchable, Serializable

public class IlvMovingAvgDataSet
extends IlvCombinedDataSet

Implements a data set that computes the moving average of another data set.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.data.IlvAbstractDataSet

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvMovingAvgDataSet() Creates a moving average with a default period.
IlvMovingAvgDataSet(IlvDataSet dataSet, int period) Creates a moving average of the specified data set, with the specified period.
IlvMovingAvgDataSet(int period) Creates a moving average with the specified period.

Method Summary

Modifier and Type	Method and Description
protected int	computeDataCount() Computes the data count of this data set.
protected void	dataSetContentsChanged(DataSetContentsEvent event) Called when one of the data sets referenced by this object has been modified.
protected void	dataSetPropertyChanged(DataSetPropertyEvent event) Called when a property of one of the data sets referenced by this object has been modified.
double	getMinimumXDifference() Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order.
String	getName() Returns the name of this data set.
int	getPeriod() Returns the period over which the average is computed.
double	getXData(int idx) Returns the X-value of the data point at the specified index.
double	getYData(int idx) Returns the Y-value of the data point at the specified index.
boolean	isXValuesSorted() Returns true if the referenced data set provides sorted X values.
void	setPeriod(int period) Sets the period over which the average is computed.

Methods inherited from class ilog.views.chart.data.IlvCombinedDataSet

addDataSet, addDataSet, dataSetsChanged, dispose, fireDataSetContentsEvent, getDataCount, getDataSet, getDataSetCount, getDataSetIndex, getDataSets, getMaxDataSetCount, removeDataSet, removeDataSet, replaceDataSet, setDataSet, setDataSets, setMaxDataSetCount, updateDataCount

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSet

addData, addDataSetListener, computeLimits, computeMinimumXDifference, dataAdded, dataChanged, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetPropertyEvent, getData, getDataBetween, getDataInside, getDataInside, getDataLabel, getProperty, getUndefValue, getXRange, getXRange, getYRange, getYRange, invalidateLimits, invalidateLimits, invalidateLimits, isBatched, isEditable, isXRangeIncludingUndefinedPoints, putProperty, removeDataSetListener, setData, setLimitsValid, setName, setUndefValue, setXRangeIncludingUndefinedPoints, startBatch, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvMovingAvgDataSet

public IlvMovingAvgDataSet()

Creates a moving average with a default period.

IlvMovingAvgDataSet

public IlvMovingAvgDataSet(int period)

Creates a moving average with the specified period.

IlvMovingAvgDataSet

public IlvMovingAvgDataSet(IlvDataSet dataSet,
                           int period)

Creates a moving average of the specified data set, with the specified period.

Method Detail

getName

public String getName()

Returns the name of this data set. This method appends "Mov. Avg." to the name of the referenced data set.

Specified by:

getName in interface IlvDataSet

Overrides:

getName in class IlvAbstractDataSet

isXValuesSorted

public boolean isXValuesSorted()

Returns true if the referenced data set provides sorted X values.

Specified by:

isXValuesSorted in interface IlvDataSet

Overrides:

isXValuesSorted in class IlvCombinedDataSet

See Also:

IlvAbstractDataSet.isXValuesSorted()

getMinimumXDifference

public double getMinimumXDifference()

Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order.

Overrides:

getMinimumXDifference in class IlvAbstractDataSet

getPeriod

public int getPeriod()

Returns the period over which the average is computed.

See Also:

setPeriod(int)

setPeriod

public void setPeriod(int period)

Sets the period over which the average is computed.

See Also:

getPeriod()

getYData

public double getYData(int idx)

Returns the Y-value of the data point at the specified index.

Specified by:

getYData in interface IlvDataSet

Specified by:

getYData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

getXData

public double getXData(int idx)

Returns the X-value of the data point at the specified index.

Specified by:

getXData in interface IlvDataSet

Specified by:

getXData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

dataSetContentsChanged

protected void dataSetContentsChanged(DataSetContentsEvent event)

Called when one of the data sets referenced by this object has been modified.

Overrides:

dataSetContentsChanged in class IlvCombinedDataSet

dataSetPropertyChanged

protected void dataSetPropertyChanged(DataSetPropertyEvent event)

Called when a property of one of the data sets referenced by this object has been modified. The method forwards the received event, as if this data set was the source of the event.

Overrides:

dataSetPropertyChanged in class IlvCombinedDataSet

computeDataCount

protected int computeDataCount()

Computes the data count of this data set.

Overrides:

computeDataCount in class IlvCombinedDataSet