ilog.views.chart.data

Class IlvSwingTableDataSource

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSource

ilog.views.chart.data.IlvAbstractTableDataSource

ilog.views.chart.data.IlvSwingTableDataSource

All Implemented Interfaces:

IlvDataSource, IlvBatchable, Serializable

Direct Known Subclasses:

IlvJDBCDataSource

public class IlvSwingTableDataSource
extends IlvAbstractTableDataSource

A data source that handles data stored in a TableModel.

Since:

JViews 5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvSwingTableDataSource.Mapping Deprecated. Please use the superclass instead.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMN_SERIES The type of the table model when series are ordered by column.
static int	ROW_SERIES The type of the table model when series are ordered by rows.

Constructor Summary

Constructors

Constructor and Description
IlvSwingTableDataSource() Creates a new IlvSwingTableDataSource.
IlvSwingTableDataSource(TableModel tableModel) Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered by column and uses no specific serie for x values.
IlvSwingTableDataSource(TableModel tableModel, int type) Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered according to the specified type and uses no specific serie for x values.
IlvSwingTableDataSource(TableModel tableModel, int type, IlvAbstractTableDataSource.Mapping[] mapping) Creates a new IlvSwingTableDataSource associated with the given TableModel with the series ordered according to the specified type and initialized with the specified mapping.
IlvSwingTableDataSource(TableModel tableModel, int type, int xSeries, int dataLabels) Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered according to the specified type and using the given series for x values.

Method Summary

Modifier and Type	Method and Description
String	formatDataLabel(String value) Returns the data label to be used for a table cell value.
IlvDataConverter	getDataConverter(Class<?> dataClass) Returns the converter of the given data class.
IlvDataConverter	getDataConverter(int column) Returns the data converter for the given column.
int	getDataLabelsIndex() Returns the data labels index.
static IlvDataConverter	getDefaultConverter(Class<?> dataClass) Returns the default converter of the given data class.
Locale	getLocale() Returns the locale that is used by the converter for objects of type String.
IlvAbstractTableDataSource.Mapping[]	getMapping() Returns the contents of this data source according to the specified mapping.
int	getSeriesType() Returns the type of the series.
TableModel	getTableModel() Returns the table model associated to this data source.
ULocale	getULocale() Returns the locale that is used by the converter for objects of type String.
Double	getUndefValue() Returns the undefined value for the data sets of this data source.
int	getXSeriesIndex() Returns the xseries index.
boolean	isTimeSeries(int index) Returns whether the specified column or row (depending on the type of this data source) represents a time series.
void	setDataConverter(int column, IlvDataConverter conv) Sets the data converter for the given column.
void	setDataLabelsIndex(int index) Sets the data labels index.
void	setDataSets(IlvDataSet[] dataSets) Initializes this data source with the specified data sets.
static void	setDefaultConverter(Class<?> dataClass, IlvDataConverter converter) Sets the default converter of a data class.
void	setLocale(Locale locale) Sets the locale.
void	setMapping(IlvAbstractTableDataSource.Mapping[] mapping) Initializes the contents of this data source according to the specified mapping.
void	setSeriesType(int type) Sets the type of the series.
void	setTableModel(TableModel tableModel) Sets the table model associated to this data source.
void	setULocale(ULocale locale) Sets the locale.
void	setUndefValue(Double undefValue) Specifies the undefined value for the data sets of this data source.
void	setXSeriesIndex(int index) Sets the xseries column index.
void	tableChanged(TableModelEvent event) Handles changes that occur on the table model.

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSource

addDataSet, addDataSet, addDataSourceListener, containsDataSet, endBatch, fireDataSourceEvent, getDataSet, getDataSetByName, getDataSetCount, getDataSetIndex, getDataSetIterator, getDataSetList, getDataSets, initDataSets, removeDataSourceListener, setDataSet, startBatch

Methods inherited from class java.lang.Object

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

Field Detail

COLUMN_SERIES

public static final int COLUMN_SERIES

The type of the table model when series are ordered by column.

See Also:

Constant Field Values

ROW_SERIES

public static final int ROW_SERIES

The type of the table model when series are ordered by rows.

See Also:

Constant Field Values

Constructor Detail

IlvSwingTableDataSource

public IlvSwingTableDataSource()

Creates a new IlvSwingTableDataSource.

IlvSwingTableDataSource

public IlvSwingTableDataSource(TableModel tableModel)

Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered by column and uses no specific serie for x values.

Parameters:

tableModel - The TableModel to attach.

IlvSwingTableDataSource

public IlvSwingTableDataSource(TableModel tableModel,
                               int type)

Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered according to the specified type and uses no specific serie for x values.

Parameters:

tableModel - The TableModel to attach.

type - The type of the series.

See Also:

COLUMN_SERIES, ROW_SERIES

IlvSwingTableDataSource

public IlvSwingTableDataSource(TableModel tableModel,
                               int type,
                               int xSeries,
                               int dataLabels)

Creates a new IlvSwingTableDataSource associated to the given TableModel with the series ordered according to the specified type and using the given series for x values.

Parameters:

tableModel - The TableModel to attach.

type - The type of the series.

xSeries - The column index of the x series. A value of -1 means that no specific x series is used.

dataLabels - The column index of the data labels. A value of -1 means that no labels are available.

See Also:

COLUMN_SERIES, ROW_SERIES

IlvSwingTableDataSource

public IlvSwingTableDataSource(TableModel tableModel,
                               int type,
                               IlvAbstractTableDataSource.Mapping[] mapping)

Creates a new IlvSwingTableDataSource associated with the given TableModel with the series ordered according to the specified type and initialized with the specified mapping.

Since:

JViews 6.0

Method Detail

getXSeriesIndex

public final int getXSeriesIndex()

Returns the xseries index.

See Also:

setXSeriesIndex(int)

setXSeriesIndex

public void setXSeriesIndex(int index)

Sets the xseries column index.

Parameters:

index - The xseries column or row index depending on the series type. A value equals to -1 means that no specific xseries should be used.

getDataLabelsIndex

public final int getDataLabelsIndex()

Returns the data labels index.

See Also:

setDataLabelsIndex(int)

setDataLabelsIndex

public void setDataLabelsIndex(int index)

Sets the data labels index.

Parameters:

index - The data labels column or row index depending on the series type. A value of -1 means that no data labels are available.

getSeriesType

public final int getSeriesType()

Returns the type of the series.

See Also:

COLUMN_SERIES, ROW_SERIES

setSeriesType

public void setSeriesType(int type)

Sets the type of the series. Should be one of COLUMN_SERIES or ROW_SERIES.

See Also:

COLUMN_SERIES, ROW_SERIES

getTableModel

public final TableModel getTableModel()

Returns the table model associated to this data source.

setTableModel

public void setTableModel(TableModel tableModel)

Sets the table model associated to this data source.

setMapping

public void setMapping(IlvAbstractTableDataSource.Mapping[] mapping)

Initializes the contents of this data source according to the specified mapping.

Since:

JViews 6.0

getMapping

public IlvAbstractTableDataSource.Mapping[] getMapping()

Returns the contents of this data source according to the specified mapping. May return null if no mapping has been defined.

Since:

JViews 6.0

tableChanged

public void tableChanged(TableModelEvent event)

Handles changes that occur on the table model.

setUndefValue

public void setUndefValue(Double undefValue)

Specifies the undefined value for the data sets of this data source.

Since:

JViews 5.5

See Also:

IlvDataSet.getUndefValue()

getUndefValue

public final Double getUndefValue()

Returns the undefined value for the data sets of this data source.

Returns:

The value specified by the setUndefValue(java.lang.Double) method.

Since:

JViews 5.5

setDefaultConverter

public static void setDefaultConverter(Class<?> dataClass,
                                       IlvDataConverter converter)

Sets the default converter of a data class. The IlvSwingTableDataSource makes use of data converter to convert the objects contained in the TableModel to their corresponding double value. The data source, through its data set, asks the tableModel for the object type (using getColumnClass()), and then tries to find a converter able to handle the object. By default, the IlvSwingTableDataSource registers converters for the following types: Date, String, Short, Integer, Long, Float and Double. Note that the converter for String set through this method has no effect: an IlvStringConverter is used instead that depends on the locale. If you need to handle other kind of objects, you might write a specific IlvDataConverter and register it on the data source.

See Also:

getDefaultConverter(java.lang.Class<?>), getDataConverter(java.lang.Class<?>), IlvDataConverter

getDefaultConverter

public static IlvDataConverter getDefaultConverter(Class<?> dataClass)

Returns the default converter of the given data class. Since the AbstractTableModel.getColumnClass() method returns Object by default, this method converts Object data using the associated Double converter. Hence, if your data model only contains Double object, overriding getColumnClass() is not mandatory. The method first tries to find the exact mapping of the specified class. If none is found, then it iterates all over the registered data converter and returns the first data converter that can convert the given class, if any.

Returns:

The registered data converter for the specified class, or null if none is found.

See Also:

setDefaultConverter(java.lang.Class<?>, ilog.views.chart.data.IlvDataConverter), getDataConverter(java.lang.Class<?>)

setULocale

public void setULocale(ULocale locale)

Sets the locale. This locale is used by the converter for objects of type String.

Parameters:

locale - A locale, or null to designate locale independent conversion.

Since:

JViews 8.8

See Also:

getULocale()

getULocale

public ULocale getULocale()

Returns the locale that is used by the converter for objects of type String.

Returns:

A locale, or null to designate locale independent conversion.

Since:

JViews 8.8

See Also:

setULocale(com.ibm.icu.util.ULocale)

setLocale

public void setLocale(Locale locale)

Sets the locale. This locale is used by the converter for objects of type String.

Parameters:

locale - A locale, or null to designate locale independent conversion.

Since:

JViews 7.5

See Also:

getLocale()

getLocale

public Locale getLocale()

Returns the locale that is used by the converter for objects of type String.

Returns:

A locale, or null to designate locale independent conversion.

Since:

JViews 7.5

See Also:

setLocale(java.util.Locale)

getDataConverter

public IlvDataConverter getDataConverter(Class<?> dataClass)

Returns the converter of the given data class. In its default implementation, this method uses getDefaultConverter, except for class String. For String, an IlvStringConverter depending on this model locale is used.

Since:

JViews 7.5

See Also:

getLocale()

isTimeSeries

public boolean isTimeSeries(int index)

Returns whether the specified column or row (depending on the type of this data source) represents a time series. The default implementation makes the distinction between ROW_SERIES and COLUMN_SERIES data source:

• For COLUMN_SERIES, it returns true if the class returned by getTableModel().getColumnClass(idx) is an instance of java.util.Date. It returns false otherwise.
• For ROW_SERIES, it returns true if the class returned by getTableModel().getColumnClass(0) is an instance of java.util.Date. It returns false otherwise (that is, it tests only the type of the first column of the model.

Parameters:

index - The index of the column or rows.

Since:

JViews 6.0

getDataConverter

public IlvDataConverter getDataConverter(int column)

Returns the data converter for the given column. The default implementation returns the converter associated with the specified column if one exists, otherwise the default converter associated with the data class of the specified column if a TableModel has been set.

Since:

JViews 5.5

See Also:

getDefaultConverter(java.lang.Class<?>), getDataConverter(java.lang.Class<?>), setDataConverter(int, ilog.views.chart.data.IlvDataConverter)

setDataConverter

public void setDataConverter(int column,
                             IlvDataConverter conv)

Sets the data converter for the given column.

Since:

JViews 6.0

See Also:

getDataConverter(java.lang.Class<?>)

setDataSets

public void setDataSets(IlvDataSet[] dataSets)

Initializes this data source with the specified data sets.

Specified by:

setDataSets in interface IlvDataSource

Overrides:

setDataSets in class IlvAbstractDataSource

Parameters:

dataSets - The new data sets. If this parameter is null, all the data sets provided by this data source should be removed.

formatDataLabel

public String formatDataLabel(String value)

Returns the data label to be used for a table cell value.

Parameters:

value - A value from the table model.

Since:

JViews 8.1