Package org.zkoss.chart.model

Interface BoxPlotModel

All Superinterfaces:

ChartsModel

All Known Implementing Classes:

DefaultBoxPlotModel

public interface BoxPlotModel
extends ChartsModel

A data model to be used with box plot.

Author:

Christopher

Method Summary

Modifier and Type	Method	Description
void	addValue(Comparable<?> series, Number low, Number q1, Number median, Number q3, Number high)	Append a (low, q1, median, q3, high) value into the the given series.
void	addValue(Comparable<?> series, Number low, Number q1, Number median, Number q3, Number high, int index)	Add a (low, q1, median, q3, high) value into the the given series at the given index.
void	addValue(Comparable<?> series, Number x, Number low, Number q1, Number median, Number q3, Number high)	Append a (x, low, q1, median, q3, high) value into the the given series.
void	addValue(Comparable<?> series, Number x, Number low, Number q1, Number median, Number q3, Number high, int index)	Add a (x, low, q1, median, q3, high) value into the the given series at the given index.
void	addValue(Comparable<?> series, String name, Number low, Number q1, Number median, Number q3, Number high)	Append a (name, low, q1, median, q3, high) value into the the given series.
void	addValue(Comparable<?> series, String name, Number low, Number q1, Number median, Number q3, Number high, int index)	Add a (name, low, q1, median, q3, high) value into the the given series at the given index.
void	clear()	clear this model.
int	getDataCount(Comparable<?> series)	Get data count of a specified series.
Number	getHigh(Comparable<?> series, int index)	Get the high value from the specified series at the given index.
Number	getLow(Comparable<?> series, int index)	Get the low value from the specified series at the given index.
Number	getMedian(Comparable<?> series, int index)	Get the median value from the specified series at the given index.
String	getName(Comparable<?> series, int index)	Get the name value from the specified series at the given index.
Number	getQ1(Comparable<?> series, int index)	Get the q1 value from the specified series at the given index.
Number	getQ3(Comparable<?> series, int index)	Get the q3 value from the specified series at the given index.
Collection<Comparable<?>>	getSeries()	Get all series as a collection.
Comparable<?>	getSeries(int index)	Get a series of the specified index;
Number	getX(Comparable<?> series, int index)	Get the x value from the specified series at the given index.
void	removeSeries(Comparable<?> series)	Remove data of a specified series.
void	removeValue(Comparable<?> series, int index)	Remove a (x, low, q1, median, q3, high) value from the specified series at the given index.
void	setValue(Comparable<?> series, Number low, Number q1, Number median, Number q3, Number high, int index)	Replace the (low, q1, median, q3, high) value at the given index of the specified series.
void	setValue(Comparable<?> series, Number x, Number low, Number q1, Number median, Number q3, Number high, int index)	Replace the (x, low, q1, median, q3, high) value at the given index of the specified series.
void	setValue(Comparable<?> series, String name, Number low, Number q1, Number median, Number q3, Number high, int index)	Replace the (name, low, q1, median, q3, high) value at the given index of the specified series.

Methods inherited from interface org.zkoss.chart.model.ChartsModel

addChartsDataListener, removeChartsDataListener

Method Detail

getSeries

Comparable<?> getSeries(int index)

Get a series of the specified index;

getSeries

Collection<Comparable<?>> getSeries()

Get all series as a collection.

getDataCount

int getDataCount(Comparable<?> series)

Get data count of a specified series.

Parameters:

series - the specified series.

getName

String getName(Comparable<?> series,
               int index)

Get the name value from the specified series at the given index.

Parameters:

series -

index -

Returns:

name the name value

getX

Number getX(Comparable<?> series,
            int index)

Get the x value from the specified series at the given index.

Parameters:

series -

index -

Returns:

x the x value

getLow

Number getLow(Comparable<?> series,
              int index)

Get the low value from the specified series at the given index.

Parameters:

series -

index -

Returns:

low the low value

getQ1

Number getQ1(Comparable<?> series,
             int index)

Get the q1 value from the specified series at the given index.

Parameters:

series -

index -

Returns:

q1 the q1 value

getMedian

Number getMedian(Comparable<?> series,
                 int index)

Get the median value from the specified series at the given index.

Parameters:

series -

index -

Returns:

median the median value

getQ3

Number getQ3(Comparable<?> series,
             int index)

Get the q3 value from the specified series at the given index.

Parameters:

series -

index -

Returns:

q3 the q3 value

getHigh

Number getHigh(Comparable<?> series,
               int index)

Get the high value from the specified series at the given index.

Parameters:

series -

index -

Returns:

high the high value

setValue

void setValue(Comparable<?> series,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Replace the (low, q1, median, q3, high) value at the given index of the specified series.

Parameters:

series - the series

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the data index

setValue

void setValue(Comparable<?> series,
              Number x,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Replace the (x, low, q1, median, q3, high) value at the given index of the specified series.

Parameters:

series - the series

x - the x value

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the data index

setValue

void setValue(Comparable<?> series,
              String name,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Replace the (name, low, q1, median, q3, high) value at the given index of the specified series.

Parameters:

series - the series

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the data index

addValue

void addValue(Comparable<?> series,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high)

Append a (low, q1, median, q3, high) value into the the given series.

Parameters:

series - the series to append this value into

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

addValue

void addValue(Comparable<?> series,
              Number x,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high)

Append a (x, low, q1, median, q3, high) value into the the given series.

Parameters:

series - the series to append this value into

x - the x value

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

addValue

void addValue(Comparable<?> series,
              String name,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high)

Append a (name, low, q1, median, q3, high) value into the the given series.

Parameters:

series - the series to append this value into

name - the name value

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

addValue

void addValue(Comparable<?> series,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Add a (low, q1, median, q3, high) value into the the given series at the given index.

Parameters:

series - the series to append this value into

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the index value

addValue

void addValue(Comparable<?> series,
              Number x,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Add a (x, low, q1, median, q3, high) value into the the given series at the given index.

Parameters:

series - the series to append this value into

x - the x value

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the index value

addValue

void addValue(Comparable<?> series,
              String name,
              Number low,
              Number q1,
              Number median,
              Number q3,
              Number high,
              int index)

Add a (name, low, q1, median, q3, high) value into the the given series at the given index.

Parameters:

series - the series to append this value into

name - the name value

low - the low value

q1 - the q1 value

median - the median value

q3 - the q1 value

high - the high value

index - the index value

removeSeries

void removeSeries(Comparable<?> series)

Remove data of a specified series.

Parameters:

series - the series

removeValue

void removeValue(Comparable<?> series,
                 int index)

Remove a (x, low, q1, median, q3, high) value from the specified series at the given index.

Parameters:

series - the series.

index - the data index.

clear

void clear()

clear this model.