org.zkoss.google.charts.data

Class DataTable

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Object,Object>

org.zkoss.json.JSONObject

org.zkoss.google.charts.data.DataTable

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, org.zkoss.json.JSONAware

public class DataTable
extends org.zkoss.json.JSONObject

Wrapper of the google.visualization.DataTable JavaScript class provided in Google Charts.

Author:

Sean Connolly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataTable.Column A column of the DataTable contents.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DataTable()

Method Summary

Modifier and Type	Method and Description
DataTable.Column	addBooleanColumn(String label)
DataTable.Column	addBooleanColumn(String label, String id)
DataTable.Column	addColumn(ColumnType type, ColumnRole role)
DataTable.Column	addColumn(ColumnType type, String label)
DataTable.Column	addColumn(ColumnType type, String label, String id)
DataTable.Column	addDateColumn(String label)
DataTable.Column	addDateColumn(String label, String id)
DataTable.Column	addDateTimeColumn(String label)
DataTable.Column	addDateTimeColumn(String label, String id)
DataTable.Column	addNumberColumn(String label)
DataTable.Column	addNumberColumn(String label, String id)
org.zkoss.google.charts.data.DataTable.Row	addRow()
org.zkoss.google.charts.data.DataTable.Row	addRow(int index)
org.zkoss.google.charts.data.DataTable.Row	addRow(Object... values)
DataTable.Column	addStringColumn(String label)
DataTable.Column	addStringColumn(String label, String id)
DataTable.Column	addTimeColumn(String label)
DataTable.Column	addTimeColumn(String label, String id)
String	getColumnId(int index)
String	getColumnLabel(int index)
ColumnType	getColumnType(int index)
int	getNumberOfColumns()
int	getNumberOfRows()
Object	getValue(int rowIndex, int columnIndex) Returns the value of the cell at the given row and column indexes.
void	setValue(int rowIndex, int columnIndex, Object value) Sets the value of a cell.

Methods inherited from class org.zkoss.json.JSONObject

toJSONString, toJSONString, toString, toString

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DataTable

public DataTable()

Method Detail

getNumberOfColumns

public int getNumberOfColumns()

Returns:

the number of columns in the table

getNumberOfRows

public int getNumberOfRows()

Returns:

the number of rows in the table

getValue

public Object getValue(int rowIndex,
                       int columnIndex)

Returns the value of the cell at the given row and column indexes.

Parameters:

rowIndex - should be a number greater than or equal to zero, and less than the number of rows as returned by the getNumberOfRows() method.

columnIndex - should be a number greater than or equal to zero, and less than the number of columns as returned by the getNumberOfColumns() method.

Returns:

The type of the returned value depends on the column type (see getColumnType(int)):

• If the column type is 'string', the value is a String.
• If the column type is 'number', the value is an Integer.
• If the column type is 'boolean', the value is a Boolean.
• If the column type is 'date' or 'datetime', the value is a Date object.
• If the column type is 'timeofday', the value is an array of four numbers: [hour, minute, second, milliseconds].
• If the column value is a null value, an exception is thrown.

setValue

public void setValue(int rowIndex,
                     int columnIndex,
                     Object value)

Sets the value of a cell. In addition to overwriting any existing cell value, this method will also clear out any formatted value and properties for the cell.

Parameters:

rowIndex - should be a number greater than or equal to zero, and less than the number of rows as returned by the getNumberOfRows() method.

columnIndex - should be a number greater than or equal to zero, and less than the number of columns as returned by the getNumberOfColumns() method.

value - is the value assigned to the specified cell. The type of the returned value depends on the column type (see getColumnType(int)):

• If the column type is 'string', the value is a String.
• If the column type is 'number', the value is an Integer.
• If the column type is 'boolean', the value is a Boolean.
• If the column type is 'date' or 'datetime', the value is a Date object.
• If the column type is 'timeofday', the value is an array of four numbers: [hour, minute, second, milliseconds].
• If the column value is a null value, an exception is thrown.

addStringColumn

public DataTable.Column addStringColumn(String label)

addNumberColumn

public DataTable.Column addNumberColumn(String label)

addBooleanColumn

public DataTable.Column addBooleanColumn(String label)

addDateColumn

public DataTable.Column addDateColumn(String label)

addDateTimeColumn

public DataTable.Column addDateTimeColumn(String label)

addTimeColumn

public DataTable.Column addTimeColumn(String label)

addColumn

public DataTable.Column addColumn(ColumnType type,
                                  String label)

addStringColumn

public DataTable.Column addStringColumn(String label,
                                        String id)

addNumberColumn

public DataTable.Column addNumberColumn(String label,
                                        String id)

addBooleanColumn

public DataTable.Column addBooleanColumn(String label,
                                         String id)

addDateColumn

public DataTable.Column addDateColumn(String label,
                                      String id)

addDateTimeColumn

public DataTable.Column addDateTimeColumn(String label,
                                          String id)

addTimeColumn

public DataTable.Column addTimeColumn(String label,
                                      String id)

addColumn

public DataTable.Column addColumn(ColumnType type,
                                  String label,
                                  String id)

addColumn

public DataTable.Column addColumn(ColumnType type,
                                  ColumnRole role)

getColumnType

public ColumnType getColumnType(int index)

getColumnLabel

public String getColumnLabel(int index)

getColumnId

public String getColumnId(int index)

addRow

public org.zkoss.google.charts.data.DataTable.Row addRow()

addRow

public org.zkoss.google.charts.data.DataTable.Row addRow(int index)

addRow

public org.zkoss.google.charts.data.DataTable.Row addRow(Object... values)