Package com.storedobject.chart

Class DataChannel

java.lang.Object

com.storedobject.chart.DataChannel

public final class DataChannel
extends Object

Data channel opens up a channel to push data on to a SOChart once rendered. This channel can be used to push or append more data to the charts. These push/append operations will not touch your sources, so you need to maintain those yourself if you want to do complete redrawing of the chart later.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
DataChannel(SOChart soChart, AbstractDataProvider<?>... dataProviders)	Create a data channel for the given set of data providers.

Method Summary

Modifier and Type	Method	Description
void	append(Object... data)	Append data to the chart.
void	appendEncoded(Object... data)	Append data to the chart.
void	push(Object... data)	Push data to the chart.
void	pushEncoded(Object... data)	Push encoded data to the chart.
void	reset()	Reset data.

Methods inherited from class java.lang.Object

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

Constructor Details

DataChannel

public DataChannel(SOChart soChart,
 AbstractDataProvider<?>... dataProviders)

Create a data channel for the given set of data providers.

Parameters:

soChart - Chart on which this channel needs to be activated.

dataProviders - Data sources for which the channel needs to be created.

Method Details

append

public void append(Object... data)
            throws ChartException

Append data to the chart. The number of data elements will grow by 1 due to this and the chart will be repainted accordingly.

Parameters:

data - Data to append. The data types should be compatible with the data providers for which this channel was created.

Throws:

ChartException - If invalid data is passed.

appendEncoded

public void appendEncoded(Object... data)

Append data to the chart. The number of data elements will grow by 1 due to this and the chart will be repainted accordingly.

Parameters:

data - Data to push. No error checking will happen and the data is pushed as such. Null values are allowed and will be handled as per the behaviour of the corresponding charts.

push

public void push(Object... data)
          throws ChartException

Push data to the chart. The number of data elements will remain the same after this operation because for the new value added, the value from the other end will be removed and the chart will be repainted accordingly.

Parameters:

data - Data to push. The data types should be compatible with the data providers for which this channel was created.

Throws:

ChartException - If invalid data is passed.

pushEncoded

public void pushEncoded(Object... data)

Push encoded data to the chart. The number of data elements will remain the same after this operation because for the new value added, the value from the other end will be removed and the chart will be repainted accordingly.

Parameters:

data - Data to push. No error checking will happen and the data is pushed as such. Null values are allowed and will be handled as per the behaviour of the corresponding charts.

reset

public void reset()

Reset data. All data defined in this channel are removed.