org.eclipse.nebula.visualization.xygraph.dataprovider

Class AbstractDataProvider

java.lang.Object

org.eclipse.nebula.visualization.xygraph.dataprovider.AbstractDataProvider

All Implemented Interfaces:

IDataProvider

Direct Known Subclasses:

CircularBufferDataProvider

public abstract class AbstractDataProvider
extends java.lang.Object
implements IDataProvider

This gives the most common implementation of the IDataProvider interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	chronological
protected java.util.List<IDataProviderListener>	listeners
protected Range	xDataMinMax
protected Range	yDataMinMax

Constructor Summary

Constructors

Constructor and Description
AbstractDataProvider(boolean chronological)

Method Summary

Modifier and Type	Method and Description
void	addDataProviderListener(IDataProviderListener listener) Add listener
protected void	fireDataChange() a data change has occured
Range	getDataRange(boolean positiveOnly, boolean isAxis) Returns an updated range whenever data changed, for the XAxis or YAxis, with positive data only or not.
Range	getDataRange(boolean positiveOnly, boolean isXAxis, int lowerBound) Returns an updated range whenever data changed, for the XAxis or YAxis, with positive data only or not.
abstract ISample	getSample(int index) Get sample by index
abstract int	getSize() Total number of samples.
Range	getXDataMinMax() Get the minimum and maximum xdata.
Range	getXDataMinMax(boolean positiveOnly) Get the minimum and maximum xdata.
Range	getYDataMinMax() Get the minimum and maximum ydata.
Range	getYDataMinMax(boolean positiveOnly) Get the minimum and maximum ydata.
boolean	isChronological()
boolean	removeDataProviderListener(IDataProviderListener listener) Remove listener
void	setChronological(boolean chronological)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.visualization.xygraph.dataprovider.IDataProvider

hasErrors

Field Detail

chronological

protected boolean chronological

listeners

protected java.util.List<IDataProviderListener> listeners

xDataMinMax

protected Range xDataMinMax

yDataMinMax

protected Range yDataMinMax

Constructor Detail

AbstractDataProvider

public AbstractDataProvider(boolean chronological)

Parameters:

trace - the trace which the data provider will provide data to.

chronological - true if the data is sorted chronologically on xAxis, which means the data is sorted on X Axis.

Method Detail

getSize

public abstract int getSize()

Description copied from interface: IDataProvider

Total number of samples.

Specified by:

getSize in interface IDataProvider

Returns:

size

See Also:

IDataProvider.getSample(int)

getSample

public abstract ISample getSample(int index)

Description copied from interface: IDataProvider

Get sample by index

Synchronization: Since the data might change dynamically, synchronize on the IDataProvider around calls to getSize() and getSample().

Specified by:

getSample in interface IDataProvider

Parameters:

index -

Returns:

the ISample element at the given index

getXDataMinMax

public Range getXDataMinMax()

Description copied from interface: IDataProvider

Get the minimum and maximum xdata.

Specified by:

getXDataMinMax in interface IDataProvider

Returns:

a range includes the min and max as lower and upper. return null if there is no data.

getYDataMinMax

public Range getYDataMinMax()

Description copied from interface: IDataProvider

Get the minimum and maximum ydata.

Specified by:

getYDataMinMax in interface IDataProvider

Returns:

a range includes the min and max as lower and upper. return null if there is no data.

getXDataMinMax

public Range getXDataMinMax(boolean positiveOnly)

Description copied from interface: IDataProvider

Get the minimum and maximum xdata.

Specified by:

getXDataMinMax in interface IDataProvider

Parameters:

positiveOnly - if true, return values greater than zero

Returns:

a range includes the min and max as lower and upper. return null if there is no data.

getYDataMinMax

public Range getYDataMinMax(boolean positiveOnly)

Description copied from interface: IDataProvider

Get the minimum and maximum ydata.

Specified by:

getYDataMinMax in interface IDataProvider

Parameters:

positiveOnly - if true, return values greater than zero

Returns:

a range includes the min and max as lower and upper. return null if there is no data.

getDataRange

public Range getDataRange(boolean positiveOnly,
                          boolean isAxis)

Returns an updated range whenever data changed, for the XAxis or YAxis, with positive data only or not.

Parameters:

positiveOnly - if data is positive only (for log scale mode)

isXAxis -

isXAxis - if true, then this will return the updated range for the XAxis, YAxis otherwise

getDataRange

public Range getDataRange(boolean positiveOnly,
                          boolean isXAxis,
                          int lowerBound)

Returns an updated range whenever data changed, for the XAxis or YAxis, with positive data only or not.

Parameters:

positiveOnly - if data is positive only (for log scale mode)

isXAxis - if true, then this will return the updated range for the XAxis, YAxis otherwise

lowerBound - by default it should be 0

setChronological

public void setChronological(boolean chronological)

Parameters:

chronological - the chronological to set

isChronological

public boolean isChronological()

Specified by:

isChronological in interface IDataProvider

Returns:

true if the order is chronological

addDataProviderListener

public void addDataProviderListener(IDataProviderListener listener)

Add listener

Specified by:

addDataProviderListener in interface IDataProvider

Parameters:

listener -

removeDataProviderListener

public boolean removeDataProviderListener(IDataProviderListener listener)

Remove listener

Specified by:

removeDataProviderListener in interface IDataProvider

Parameters:

listener -

Returns:

true if this list contained the specified element

fireDataChange

protected void fireDataChange()

a data change has occured