com.aquafold.openapi.chart
Interface AQChartModel

public interface AQChartModel

ChartModel

Synopsis:

ChartModel contains the data to be rendered in the chart.

Description:
ChartModel provides an interface to query and modify the chart's underlying data set.
Values are stored as a list of rows, with each row containing a category value and a list of series values (one value for each series).
Note that category values are not unique, and the same category value can appear in multiple rows.

The list of series is created and queried using these methods:
addSeries(String name)
addSeries(String ... names)
setSeries(int index, String name)

Once the series are defined, then values can be specified individually using:
setValue(int seriesNumber, int categoryNumber, Number value)
Or, rows of values can be specified using:
addRow(Object category, List values)
addRow(int rowIndex, Object category, List values)
Note that the list of values contains a value from each series. These values are all associated with the specified category.

The ChartModel provides a set of statistics for each series, each category and for the entire dataset.
These statistics include totals, min/max, range

ChartModel data can be obtained from an AQDataSource.
Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods:
addCategoryField(String field)
addSeriesField(String field)
setCategoryFieldNumbers(Integer ... fieldIndexes)
setCategoryFields(String ... fields)
setSeriesFieldNumbers(Integer ... fieldIndexes)
setSeriesFields(String ... fields)

Values are also summarized by country when the category values contain country names/ids.
This geographic categorization is visualized in the Map chart, which highlights countries based on these totals.
The default country identifiers use the standard ISO2, ISO3, FIPS & GMI codes.
These identifiers can be modified using these methods:
resetCountryNameMap()
addCountryNameMapping(String defaultCountryNameMapping, String newCountryNameMapping)
removeCountryNameMapping(String countryNameMapping)

Method Summary

void	addCategory(Object category) Add category with the specified value (String, Number or Date)
void	addCategoryField(String categoryFieldName) Select category from a field in the datasource
void	addCountryNameMapping(String defaultCountryName, String newCountryNameMapping) Map the specified name to the specified country
AQChartRow	addRow(Object category, Number... values) Add a row of data containing the specified Category and an array of numbers, one for each series.
void	addSeries(String... series) Add an array of series names
void	addSeries(String series) Add a series with the specified name
void	addSeriesField(String seriesFieldName) Add a series of values from the specified field in the current DataSource
void	clearCountryNameMap() Clear all country name mappings.
void	clearRows() Remove all rows
void	clearSeries() Remove all series
Object	getCategory(int categoryNumber) Get the category object at the specified row index.
double	getCategoryAxisDivisor() Get the Divisor used to subdivide the category axis
double	getCategoryAxisMax() Get the Maximum value on the category axis
double	getCategoryAxisMin() Get the Minimum value on the category axis
double	getCategoryAxisMinSeparation() Get the Minimum separation between category axis values
double	getCategoryAxisRange() Get the Size of range on the category axis
double	getCategoryAxisSubdivisions() Get the Number of subdivisions along the range of the category axis
int	getCategoryCount() Get the number of categories
List<String>	getCategoryFields() Get the list of datasource fields containing category values
double	getCategoryTotal(int categoryNumber) Get the Total of all series values in the specified category
double	getCategoryTotalNegative(int categoryNumber) Get the Total of all negative series values in the specified category
double	getCategoryTotalPositive(int categoryNumber) Get the Total of all positive series values in the specified category
Double	getCountryMax(int seriesNumber) Get the Maximum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g.
Double	getCountryMin(int seriesNumber) Get the Minimum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g.
Double	getCountryValue(String countryId, int seriesNumber) Get the Sum of all series values for the specified country
Double	getCountryValueByIndex(int countryIndex, int seriesNumber) Get the Sum of all series values for the specified country
AQDataSource	getDataSource() Get the chart model's underlying DataSource (for example, an AQDataSet or AQPivotDataSet).
double	getDivisor() Get the Divisor used when all series are merged
double	getDivisor(int seriesNumber) Get the Divisor used for the specified series
double	getDivisorTotal() Get the Divisor used to subdivide the total range
double	getMaximumAxisValue() Get the Maximum value for all series
double	getMaximumAxisValue(int seriesNumber) Get the Maximum value in series
double	getMaximumValue() Get the Maximum value across all series
double	getMaximumValue(int seriesNumber) Get the Maximum value in series
double	getMinimumAxisValue() Get the Minimum value for all series
double	getMinimumAxisValue(int seriesNumber) Get the Minimum value in series
double	getMinimumValue() Get the Minimum value across all series
double	getMinimumValue(int seriesNumber) Get the Minimum value in series
double	getRange() Get the Size of range when all series are merged
double	getRange(int seriesNumber) Get the Size of the numeric range for the specified series
double	getRangeTotal() Get the Size of numeric range between total positive & total negative
AQChartRow	getRow(int rowNumber) Get the row at the specified index
int	getRowCount() Return the number of rows in the model
List<AQChartRow>	getRows() Get the list of rows
List<Number>	getRowValues(int rowNumber) Get the List of values at specified row
List<String>	getSeries() Get the list of series names
String	getSeries(int seriesNumber) Get the series name at the specified index
int	getSeriesCount() Get the number of series
List<String>	getSeriesFields() Get the list of datasource fields containing series values
double	getSubdivisions() Get the Number of subdivisions on range when all series are merged
double	getSubdivisions(int seriesNumber) Get the Number of subdivisions on a series range
double	getSubdivisionsTotal() Get the Number of subdivisions on the total range
double	getTotal(int seriesNumber) Get the Total of all values in the specified series
double	getTotalAbsolute(int seriesNumber) Get the Total of all absolute values in the specified series
double	getTotalNegative() Get the Sum of all series minima which are less than zero
double	getTotalPositive() Get the Sum of all series maxima which are greater than zero
Number	getValue(int categoryNumber, int seriesNumber) Get the Value at specified category and series indices
AQChartRow	insertRow(int index, Object category, Number... values) Insert a row of data containing the specified Category and an array of numbers, one for each series.
void	insertSeriesField(int seriesNumber, String seriesFieldName) Select a series field from the datasource and place it at the specified series index
boolean	isUseNumericCategoryAxis() Get the True if the category axis uses numeric values
void	parseDataScript(String dataScript) Parses string to generate model data Script Format: category="[Category A], [Category B], [Category C]", series="[Series X], [Series Y]", values="1000,2000,3000,5,10,20" Note: values are in the order: [Series 0 Category 0], [Series 0 Category 1], [Series 0 Category 2], [Series 1 Category 0], ...
void	removeCategory(Object category) Remove first category which matches the specified category
void	removeCategoryByIndex(int index) Remove the category at the specified index
void	removeCountryNameMapping(String countryNameMapping) Remove the specified country name mapping.
AQChartRow	removeRow(int index) Remove the row at the specified index
void	removeSeries(String series) Remove first series with the specified name
void	removeSeriesField(int seriesNumber) Remove a series field
void	resetCountryNameMap() Reset the country name mappings to the defaults.
void	setCategory(int categoryNumber, Object category) Set category at the specified index
void	setCategoryFieldNumbers(Integer... categoryFieldNumbers) Select categories from one or more fields in the datasource
void	setCategoryFields(String... categoryFieldNames) Select categories from one or more fields in the datasource
void	setDataSource(AQDataSet dataSet) Use the specified AQDataSet as the Chart Model's data source. Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods: addCategoryField(String field) addSeriesField(String field) setCategoryFieldNumbers(Integer ...
void	setDataSource(AQDataSource dataSource) Use the specified AQDataSource as the Chart Model's data source Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods: addCategoryField(String field) addSeriesField(String field) setCategoryFieldNumbers(Integer ...
void	setDataSource(AQPivotDataSet pivotDataSet) Use the specified AQPivotDataSet as the Chart Model's data source Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods: addCategoryField(String field) addSeriesField(String field) setCategoryFieldNumbers(Integer ...
void	setMaximumAxisValue(double max) Set the maximum value for all series
void	setMaximumAxisValue(int seriesNumber, double max) Set the maximum value for the specified series
void	setMinimumAxisValue(double min) Set the minimum value for all series
void	setMinimumAxisValue(int seriesNumber, double min) Set the minimum value for the specified series
void	setMinimumMaximumAxisValues(double min, double max) Set both minimum and maximum values for all series
void	setMinimumMaximumAxisValues(int seriesNumber, double min, double max) Set both minimum and maximum values for the specified series
void	setSeries(int seriesNumber, String series) Set the value of the specified series
void	setSeriesFieldNumbers(Integer... seriesFieldNumbers) Select series from one or more fields in the datasource
void	setSeriesFields(String... seriesFieldNames) Select series from one or more fields in the datasource
void	setValue(int seriesNumber, int categoryNumber, Number value) Set value at the specified series and category indices

Method Detail

parseDataScript

void parseDataScript(String dataScript)

Parses string to generate model data
Script Format:
category="[Category A], [Category B], [Category C]",
series="[Series X], [Series Y]",
values="1000,2000,3000,5,10,20"

Note: values are in the order: [Series 0 Category 0], [Series 0 Category 1], [Series 0 Category 2], [Series 1 Category 0], ...

Parameters:

dataScript - String in the format: 'category="[Category A], [Category B], [Category C]", series="[Series X], [Series Y]", values="1000,2000,3000, 5,10,20"'

setDataSource

void setDataSource(AQDataSet dataSet)

Use the specified AQDataSet as the Chart Model's data source.

Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods:
addCategoryField(String field)
addSeriesField(String field)
setCategoryFieldNumbers(Integer ... fieldIndexes)
setCategoryFields(String ... fields)
setSeriesFieldNumbers(Integer ... fieldIndexes)
setSeriesFields(String ... fields)

Parameters:

dataSet - AQDataSet containing rows and columns of data. If null, then values must be explicitly added using the add/insert/set methods.

getDataSource

AQDataSource getDataSource()

Get the chart model's underlying DataSource (for example, an AQDataSet or AQPivotDataSet).

Returns:

dataSource Chart Model's AQDataSource containing rows and columns of data

setDataSource

void setDataSource(AQDataSource dataSource)

Use the specified AQDataSource as the Chart Model's data source

Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods:
addCategoryField(String field)
addSeriesField(String field)
setCategoryFieldNumbers(Integer ... fieldIndexes)
setCategoryFields(String ... fields)
setSeriesFieldNumbers(Integer ... fieldIndexes)
setSeriesFields(String ... fields)

Parameters:

dataSource - AQDataSource containing rows and columns of data. If null, then values must be explicitly added using the add/insert/set methods.

setDataSource

void setDataSource(AQPivotDataSet pivotDataSet)

Use the specified AQPivotDataSet as the Chart Model's data source

Once the DataSource is specified, then the category & series values can be populated by selecting DataSource fields using these methods:
addCategoryField(String field)
addSeriesField(String field)
setCategoryFieldNumbers(Integer ... fieldIndexes)
setCategoryFields(String ... fields)
setSeriesFieldNumbers(Integer ... fieldIndexes)
setSeriesFields(String ... fields)

Parameters:

pivotDataSet - AQPivotDataSet containing rows and columns of data. If null, then values must be explicitly added using the add/insert/set methods.

addSeriesField

void addSeriesField(String seriesFieldName)

Add a series of values from the specified field in the current DataSource

Parameters:

seriesFieldName - Name of field in datasource

insertSeriesField

void insertSeriesField(int seriesNumber,
                       String seriesFieldName)

Select a series field from the datasource and place it at the specified series index

Parameters:

seriesNumber - Zero-based series index

seriesFieldName - Name of field in datasource

getSeriesFields

List<String> getSeriesFields()

Get the list of datasource fields containing series values

Returns:

List of datasource fields containing series values

setSeriesFields

void setSeriesFields(String... seriesFieldNames)

Select series from one or more fields in the datasource

Parameters:

seriesFieldNames - Names of fields in datasource

setSeriesFieldNumbers

void setSeriesFieldNumbers(Integer... seriesFieldNumbers)

Select series from one or more fields in the datasource

Parameters:

seriesFieldNumbers - Column numbers of fields in datasource

removeSeriesField

void removeSeriesField(int seriesNumber)

Remove a series field

Parameters:

seriesNumber - Zero-based series index

addCategoryField

void addCategoryField(String categoryFieldName)

Select category from a field in the datasource

Parameters:

categoryFieldName - Name of field in datasource

getCategoryFields

List<String> getCategoryFields()

Get the list of datasource fields containing category values

Returns:

List of category fields in datasource

setCategoryFields

void setCategoryFields(String... categoryFieldNames)

Select categories from one or more fields in the datasource

Parameters:

categoryFieldNames - Name of field in datasource

setCategoryFieldNumbers

void setCategoryFieldNumbers(Integer... categoryFieldNumbers)

Select categories from one or more fields in the datasource

Parameters:

categoryFieldNumbers - Column numbers of field in datasource

getSeries

String getSeries(int seriesNumber)

Get the series name at the specified index

Parameters:

seriesNumber - Zero-based series index

Returns:

Series name

getSeries

List<String> getSeries()

Get the list of series names

Returns:

List of series names

getSeriesCount

int getSeriesCount()

Get the number of series

Returns:

Number of series

addSeries

void addSeries(String series)

Add a series with the specified name

Parameters:

series - Series name

addSeries

void addSeries(String... series)

Add an array of series names

Parameters:

series - Array of series names

removeSeries

void removeSeries(String series)

Remove first series with the specified name

Parameters:

series - Series name

setSeries

void setSeries(int seriesNumber,
               String series)

Set the value of the specified series

Parameters:

seriesNumber - Zero-based index of series

series - Series name

clearSeries

void clearSeries()

Remove all series

getCategory

Object getCategory(int categoryNumber)

Get the category object at the specified row index.

Parameters:

categoryNumber - Zero-based index of category

Returns:

Category value at the specified index

getCategoryCount

int getCategoryCount()

Get the number of categories

Returns:

Number of categories

addCategory

void addCategory(Object category)

Add category with the specified value (String, Number or Date)

Parameters:

category - Category value (String, Number or Date)

removeCategory

void removeCategory(Object category)

Remove first category which matches the specified category

Parameters:

category - Category value

removeCategoryByIndex

void removeCategoryByIndex(int index)

Remove the category at the specified index

Parameters:

index - Index of category

setCategory

void setCategory(int categoryNumber,
                 Object category)

Set category at the specified index

Parameters:

categoryNumber - Zero-based index of category

category - Category value

clearRows

void clearRows()

Remove all rows

getRows

List<AQChartRow> getRows()

Get the list of rows

Returns:

List of rows

getRow

AQChartRow getRow(int rowNumber)

Get the row at the specified index

Parameters:

rowNumber - Zero-based index of row

Returns:

Row at the specified index

getRowCount

int getRowCount()

Return the number of rows in the model

Returns:

the number of rows in the model

addRow

AQChartRow addRow(Object category,
                  Number... values)

Add a row of data containing the specified Category and an array of numbers, one for each series.

Parameters:

category - Category object, allows null value

values - Array of numbers, one for each series

Returns:

the newly added AQChartRow

insertRow

AQChartRow insertRow(int index,
                     Object category,
                     Number... values)

Insert a row of data containing the specified Category and an array of numbers, one for each series.

Parameters:

index - Index at which row should be inserted

category - Category object, allows null value

values - Array of numbers, one for each series

Returns:

the newly added AQChartRow

removeRow

AQChartRow removeRow(int index)

Remove the row at the specified index

Parameters:

index - Row index

Returns:

the row that was removed

setValue

void setValue(int seriesNumber,
              int categoryNumber,
              Number value)

Set value at the specified series and category indices

Parameters:

seriesNumber - Zero-based index of series

categoryNumber - Zero-based index of category

value - Value to set

getRowValues

List<Number> getRowValues(int rowNumber)

Get the List of values at specified row

Parameters:

rowNumber - Zero-based index of row

Returns:

List of values at specified row

getValue

Number getValue(int categoryNumber,
                int seriesNumber)

Get the Value at specified category and series indices

Parameters:

categoryNumber - Zero-based index of category

seriesNumber - Zero-based index of series

Returns:

Value at specified category and series indices

getRange

double getRange(int seriesNumber)

Get the Size of the numeric range for the specified series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Size of numeric range for the specified series

getMaximumValue

double getMaximumValue()

Get the Maximum value across all series

Returns:

Maximum value across all series

getMinimumValue

double getMinimumValue()

Get the Minimum value across all series

Returns:

Minimum value across all series

getMinimumValue

double getMinimumValue(int seriesNumber)

Get the Minimum value in series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Minimum value in series

getMaximumValue

double getMaximumValue(int seriesNumber)

Get the Maximum value in series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Maximum value in series

getMinimumAxisValue

double getMinimumAxisValue(int seriesNumber)

Get the Minimum value in series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Minimum value in series

getMaximumAxisValue

double getMaximumAxisValue(int seriesNumber)

Get the Maximum value in series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Maximum value in series

getMinimumAxisValue

double getMinimumAxisValue()

Get the Minimum value for all series

Returns:

Minimum value for all series

getMaximumAxisValue

double getMaximumAxisValue()

Get the Maximum value for all series

Returns:

Maximum value for all series

setMinimumAxisValue

void setMinimumAxisValue(int seriesNumber,
                         double min)

Set the minimum value for the specified series

Parameters:

seriesNumber - Zero-based index of series

min - New minimum value

setMaximumAxisValue

void setMaximumAxisValue(int seriesNumber,
                         double max)

Set the maximum value for the specified series

Parameters:

seriesNumber - Zero-based index of series

max - New maximum value

setMinimumAxisValue

void setMinimumAxisValue(double min)

Set the minimum value for all series

Parameters:

min - New minimum value

setMaximumAxisValue

void setMaximumAxisValue(double max)

Set the maximum value for all series

Parameters:

max - New maximum value

setMinimumMaximumAxisValues

void setMinimumMaximumAxisValues(double min,
                                 double max)

Set both minimum and maximum values for all series

Parameters:

min - New minimum value

max - New maximum value

setMinimumMaximumAxisValues

void setMinimumMaximumAxisValues(int seriesNumber,
                                 double min,
                                 double max)

Set both minimum and maximum values for the specified series

Parameters:

seriesNumber - Zero-based index of series

min - New minimum value

max - New maximum value

getTotalPositive

double getTotalPositive()

Get the Sum of all series maxima which are greater than zero

Returns:

Sum of all series maxima which are greater than zero

getTotalNegative

double getTotalNegative()

Get the Sum of all series minima which are less than zero

Returns:

Sum of all series minima which are less than zero

getRangeTotal

double getRangeTotal()

Get the Size of numeric range between total positive & total negative

Returns:

Size of numeric range between total positive & total negative

getSubdivisionsTotal

double getSubdivisionsTotal()

Get the Number of subdivisions on the total range

Returns:

Number of subdivisions on the total range

getDivisorTotal

double getDivisorTotal()

Get the Divisor used to subdivide the total range

Returns:

Divisor used to subdivide the total range

getSubdivisions

double getSubdivisions(int seriesNumber)

Get the Number of subdivisions on a series range

Parameters:

seriesNumber - Zero-based index of series

Returns:

Number of subdivisions on a series range

getDivisor

double getDivisor(int seriesNumber)

Get the Divisor used for the specified series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Divisor used for the specified series

getSubdivisions

double getSubdivisions()

Get the Number of subdivisions on range when all series are merged

Returns:

Number of subdivisions on range when all series are merged

getDivisor

double getDivisor()

Get the Divisor used when all series are merged

Returns:

Divisor used when all series are merged

getRange

double getRange()

Get the Size of range when all series are merged

Returns:

Size of range when all series are merged

getTotal

double getTotal(int seriesNumber)

Get the Total of all values in the specified series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Total of all values in the specified series

getTotalAbsolute

double getTotalAbsolute(int seriesNumber)

Get the Total of all absolute values in the specified series

Parameters:

seriesNumber - Zero-based index of series

Returns:

Total of all absolute values in the specified series

getCategoryAxisMin

double getCategoryAxisMin()

Get the Minimum value on the category axis

Returns:

Minimum value on the category axis

getCategoryAxisMax

double getCategoryAxisMax()

Get the Maximum value on the category axis

Returns:

Maximum value on the category axis

getCategoryAxisDivisor

double getCategoryAxisDivisor()

Get the Divisor used to subdivide the category axis

Returns:

Divisor used to subdivide the category axis

getCategoryAxisSubdivisions

double getCategoryAxisSubdivisions()

Get the Number of subdivisions along the range of the category axis

Returns:

Number of subdivisions along the range of the category axis

getCategoryAxisRange

double getCategoryAxisRange()

Get the Size of range on the category axis

Returns:

Size of range on the category axis

getCategoryAxisMinSeparation

double getCategoryAxisMinSeparation()

Get the Minimum separation between category axis values

Returns:

Minimum separation between category axis values

getCategoryTotal

double getCategoryTotal(int categoryNumber)

Get the Total of all series values in the specified category

Parameters:

categoryNumber - Zero-based index of category

Returns:

Total of all series values in the specified category

getCategoryTotalPositive

double getCategoryTotalPositive(int categoryNumber)

Get the Total of all positive series values in the specified category

Parameters:

categoryNumber - Zero-based index of category

Returns:

Total of all positive series values in the specified category

getCategoryTotalNegative

double getCategoryTotalNegative(int categoryNumber)

Get the Total of all negative series values in the specified category

Parameters:

categoryNumber - Zero-based index of category

Returns:

Total of all negative series values in the specified category

isUseNumericCategoryAxis

boolean isUseNumericCategoryAxis()

Get the True if the category axis uses numeric values

Returns:

True if the category axis uses numeric values

getCountryValueByIndex

Double getCountryValueByIndex(int countryIndex,
                              int seriesNumber)

Get the Sum of all series values for the specified country

Parameters:

countryIndex - Numeric country identifier

seriesNumber - Zero-based index of series

Returns:

Sum of all series values for the specified country

getCountryValue

Double getCountryValue(String countryId,
                       int seriesNumber)

Get the Sum of all series values for the specified country

Parameters:

countryId - Country identifier (e.g. "US", "USA", "United States"...)

seriesNumber - Zero-based index of series

Returns:

Sum of all series values for the specified country

getCountryMin

Double getCountryMin(int seriesNumber)

Get the Minimum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g. US, USA and United States all map to the same country))

Parameters:

seriesNumber - Zero-based index of series

Returns:

Minimum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g. US, USA and United States all map to the same country))

getCountryMax

Double getCountryMax(int seriesNumber)

Get the Maximum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g. US, USA and United States all map to the same country))

Parameters:

seriesNumber - Zero-based index of series

Returns:

Maximum value of all per-country totals (sum of all values for a specified series and country, regardless of identifier (e.g. US, USA and United States all map to the same country))

resetCountryNameMap

void resetCountryNameMap()

Reset the country name mappings to the defaults.

clearCountryNameMap

void clearCountryNameMap()

Clear all country name mappings.

addCountryNameMapping

void addCountryNameMapping(String defaultCountryName,
                           String newCountryNameMapping)

Map the specified name to the specified country

Parameters:

defaultCountryName - Default name of country to be mapped. Note: this country name is a reference to a default country mapping, and cannot be null.

newCountryNameMapping - Name to be associated with the country specified in the first parameter. A null country name can be added to handle null category values.

removeCountryNameMapping

void removeCountryNameMapping(String countryNameMapping)

Remove the specified country name mapping.

Parameters:

countryNameMapping - Name to be disassociated from its current country.