IlvTreeTableDataSource (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.data.IlvAbstractDataSource
- - ilog.views.chart.data.IlvAbstractTableDataSource
  - - ilog.views.chart.data.IlvTreeTableDataSource

All Implemented Interfaces:

IlvDataSource, IlvDataConverter, IlvBatchable, Serializable
```
public class IlvTreeTableDataSource
extends IlvAbstractTableDataSource
implements IlvDataConverter
```
This class encapsulates a tree-table or table-like model in an IlvDataSource.

Since:

JViews 7.5

See Also:

IlvObjectModelWithColumns, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ilog.views.chart.data.IlvAbstractTableDataSource
  IlvAbstractTableDataSource.Mapping

Constructor Summary

Constructors
Constructor and Description
`IlvTreeTableDataSource()` Creates an `IlvTreeTableDataSource` not yet connected to a model.
`IlvTreeTableDataSource(IlvModelWithColumns model)` Creates an `IlvTreeTableDataSource` initially connected to a given model.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDataSet(IlvDataSet dataSet)` Adds a new data set at the end of this data source.
`void`	`addDataSet(int idx, IlvDataSet dataSet)` Inserts a new data set at the specified position.
`void`	`addTreeTableDataSourceListener(TreeTableDataSourceListener listener)` Adds the specified listener to receive events concerning changes regarding the three views of this data source.
`double`	`convertToDouble(Object value)` Converts an object to a double.
`void`	`disconnect()` Drops references to objects to help garbage collection.
`void`	`dispose()` Cleans up this model and drops references to objects to help garbage collection.
`void`	`fireTreeTableDataSourceEvent(TreeTableDataSourceEvent event)` Fires a data source event to all subscribed listeners.
`IlvFilter<?>`	`getFilterCriterion()` Returns the filter criterion that is used to constrain the model objects that are to be displayed.
`IlvModelWithColumns`	`getFilteredModel()` Returns the model after filtering.
`IlvFlatListModel`	`getFlatModel()` Returns the flat-model view of this data source.
`IlvFlatTableModel`	`getFlatTableModel()` Returns the flat-table-model view of this data source.
`Comparator<IlvClusterId>`	`getIdComparator()` Returns the comparator used to compare cluster ids.
`IlvFlatListModel`	`getLastingFlatModel()` Returns the flat-model view of this data source.
`IlvFlatTableModel`	`getLastingFlatTableModel()` Returns the flat-table-model view of this data source.
`IlvTreeListModel`	`getLastingTreeModel()` Returns the tree-model view of this data source.
`IlvAbstractTableDataSource.Mapping[]`	`getMappings()` Returns the mapping from flat-table-model to data sets.
`int`	`getNonClusterPosition()` Returns the relative position of non-clusters compared to clusters.
`IlvPartitionerFactory<?>[]`	`getPartitionerFactories()` Returns the partitioning rules that determine how objects are grouped together.
`Comparator<?>`	`getSortCriterion()` Returns the sort criterion used to order the model objects.
`IlvComparatorFactory`	`getSortCriterionFactory()` Returns the sort criterion used to order the model objects, as a model-independent factory.
`IlvTreeListModel`	`getTreeModel()` Returns the tree-model view of this data source.
`com.ibm.icu.util.ULocale`	`getULocale()` Returns the locale used to sort cluster ids when `getIdComparator()` is `null`.
`IlvModelWithColumns`	`getUnderlyingModel()` Returns the underlying model that this data source represents.
`boolean`	`isSorting()` Returns `true` if sorting is enabled.
`boolean`	`isTimeSeries(IlvDataColumnInfo column)` Returns `true` if the given column shall be considered to be a time-series.
`void`	`removeTreeTableDataSourceListener(TreeTableDataSourceListener listener)` Removes the specified listener.
`void`	`setDataSet(int idx, IlvDataSet dataSet)` Replaces the data set at the specified index.
`void`	`setDataSets(IlvDataSet[] dataSets)` Initializes this data source with the specified data sets.
`void`	`setFilterCriterion(IlvFilter<?> filter)` Changes the filter criterion that is used to constrain the model objects that are to be displayed.
`void`	`setIdComparator(Comparator<IlvClusterId> idComparator)` Changes the comparator used to compare cluster ids.
`void`	`setMappings(IlvAbstractTableDataSource.Mapping[] mappings)` Changes the mapping from flat-table-model to data sets.
`void`	`setNonClusterPosition(int nonClusterPosition)` Changes the relative position of non-clusters compared to clusters.
`void`	`setPartitionerFactories(IlvPartitionerFactory<?>[] partitionerFactories)` Changes the partitioning rules that determine how objects are grouped together.
`void`	`setSortCriterion(Comparator<?> sortCriterion)` Deprecated. Please use `setSortCriterionFactory(ilog.views.chart.datax.adapter.sort.IlvComparatorFactory)` with an instance of `IlvConstantComparatorFactory`.
`void`	`setSortCriterionFactory(IlvComparatorFactory sortCriterionFactory)` Changes the sort criterion used to order the model objects.
`void`	`setSorting(boolean sorting)` Specifies whether sorting of model objects shall be enabled.
`void`	`setULocale(com.ibm.icu.util.ULocale locale)` Changes the locale used to sort cluster ids when `getIdComparator()` is `null`.
`void`	`setUnderlyingModel(IlvModelWithColumns model)` Changes the underlying model that this data source represents.

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSource
addDataSourceListener, containsDataSet, endBatch, fireDataSourceEvent, getDataSet, getDataSetByName, getDataSetCount, getDataSetIndex, getDataSetIterator, getDataSetList, getDataSets, initDataSets, removeDataSourceListener, startBatch

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvTreeTableDataSource
```
public IlvTreeTableDataSource()
```
    Creates an IlvTreeTableDataSource not yet connected to a model.
    
    See Also:
    
    setUnderlyingModel(ilog.views.chart.datax.IlvModelWithColumns)
  - IlvTreeTableDataSource
```
public IlvTreeTableDataSource(IlvModelWithColumns model)
```
    Creates an IlvTreeTableDataSource initially connected to a given model.
    
    Parameters:
    
    model - An instance of IlvFlatListModel or IlvFlatSetModel or IlvFlatTableModel or IlvTreeListModel or IlvTreeSetModel.
- Method Detail
  - setDataSet
```
public void setDataSet(int idx,
                       IlvDataSet dataSet)
```
    Replaces the data set at the specified index. The default implementation does nothing. This implementation throws an UnsupportedOperationException.
    
    Specified by:
    
    setDataSet in interface IlvDataSource
    
    Overrides:
    
    setDataSet in class IlvAbstractDataSource
    
    Parameters:
    
    idx - The index of the data set to replace.
    
    dataSet - The new data set. If this parameter is null, the data set at the index idx is removed.
  - setDataSets
```
public void setDataSets(IlvDataSet[] dataSets)
```
    Initializes this data source with the specified data sets. The default implementation does nothing. This implementation throws an UnsupportedOperationException.
    
    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.
  - addDataSet
```
public void addDataSet(int idx,
                       IlvDataSet dataSet)
```
    Inserts a new data set at the specified position. The default implementation does nothing. This implementation throws an UnsupportedOperationException.
    
    Specified by:
    
    addDataSet in interface IlvDataSource
    
    Overrides:
    
    addDataSet in class IlvAbstractDataSource
  - addDataSet
```
public void addDataSet(IlvDataSet dataSet)
```
    Adds a new data set at the end of this data source. The default implementation does nothing. This implementation throws an UnsupportedOperationException.
    
    Specified by:
    
    addDataSet in interface IlvDataSource
    
    Overrides:
    
    addDataSet in class IlvAbstractDataSource
  - fireTreeTableDataSourceEvent
```
public void fireTreeTableDataSourceEvent(TreeTableDataSourceEvent event)
```
    Fires a data source event to all subscribed listeners.
  - addTreeTableDataSourceListener
```
public void addTreeTableDataSourceListener(TreeTableDataSourceListener listener)
```
    Adds the specified listener to receive events concerning changes regarding the three views of this data source.
  - removeTreeTableDataSourceListener
```
public void removeTreeTableDataSourceListener(TreeTableDataSourceListener listener)
```
    Removes the specified listener.
  - isTimeSeries
```
public boolean isTimeSeries(IlvDataColumnInfo column)
```
    Returns true if the given column shall be considered to be a time-series. The default implementation returns true if the column class is java.util.Date or a subclass of it.
  - getUnderlyingModel
```
public IlvModelWithColumns getUnderlyingModel()
```
    Returns the underlying model that this data source represents.
  - setUnderlyingModel
```
public void setUnderlyingModel(IlvModelWithColumns model)
```
    Changes the underlying model that this data source represents.
    
    Parameters:
    
    model - An instance of IlvFlatListModel or IlvFlatSetModel or IlvFlatTableModel or IlvTreeListModel or IlvTreeSetModel.
  - getULocale
```
public com.ibm.icu.util.ULocale getULocale()
```
    Returns the locale used to sort cluster ids when getIdComparator() is null. If none has been set, the return value is null and the current locale is used.
    
    Since:
    
    JViews 8.8
  - setULocale
```
public void setULocale(com.ibm.icu.util.ULocale locale)
```
    Changes the locale used to sort cluster ids when getIdComparator() is null. If the argument is null, the current locale is used.
    
    Since:
    
    JViews 8.8
  - getFilterCriterion
```
public IlvFilter<?> getFilterCriterion()
```
    Returns the filter criterion that is used to constrain the model objects that are to be displayed.
  - setFilterCriterion
```
public void setFilterCriterion(IlvFilter<?> filter)
```
    Changes the filter criterion that is used to constrain the model objects that are to be displayed.
    Note: The filter is ignored when the underlying model is of type IlvFlatTableModel.
  - getFilteredModel
```
public IlvModelWithColumns getFilteredModel()
```
    Returns the model after filtering. If the underlying model is an IlvFlatListModel, the filtered model is of type IlvFlatListModel as well. If the underlying model is an IlvTreeListModel, the filtered model is of type IlvTreeListModel as well.
  - isSorting
```
public boolean isSorting()
```
    Returns true if sorting is enabled.
  - setSorting
```
public void setSorting(boolean sorting)
```
    Specifies whether sorting of model objects shall be enabled.
    Note: Sorting is not performed when the underlying model is of type IlvFlatTableModel.
  - getSortCriterionFactory
```
public IlvComparatorFactory getSortCriterionFactory()
```
    Returns the sort criterion used to order the model objects, as a model-independent factory.
    
    Since:
    
    JViews 8.1
  - setSortCriterionFactory
```
public void setSortCriterionFactory(IlvComparatorFactory sortCriterionFactory)
```
    Changes the sort criterion used to order the model objects.
    
    Parameters:
    
    sortCriterionFactory - Sorting criterion, as a model-independent factory. null means the natural sorting order for objects implementing the Comparable interface.
    Note: The sort criterion is only used when isSorting is true or when the underlying model is of type IlvFlatSetModel or IlvTreeSetModel.
    Note: The sort criterion is ignored when the underlying model is of type IlvFlatTableModel.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    IlvConstantComparatorFactory
  - getSortCriterion
```
public Comparator<?> getSortCriterion()
```
    Returns the sort criterion used to order the model objects. It depends on the current model.
  - setSortCriterion
```
@Deprecated
public void setSortCriterion(Comparator<?> sortCriterion)
```
    Deprecated. Please use setSortCriterionFactory(ilog.views.chart.datax.adapter.sort.IlvComparatorFactory) with an instance of IlvConstantComparatorFactory.
    
    Changes the sort criterion used to order the model objects.
    
    Parameters:
    
    sortCriterion - Sorting criterion. null means the natural sorting order for objects implementing the Comparable interface.
    Note: The sort criterion is only used when isSorting is true or when the underlying model is of type IlvFlatSetModel or IlvTreeSetModel.
    Note: The sort criterion is ignored when the underlying model is of type IlvFlatTableModel.
    
    Deprecated Since:
    
    JViews 8.1
  - getPartitionerFactories
```
public IlvPartitionerFactory<?>[] getPartitionerFactories()
```
    Returns the partitioning rules that determine how objects are grouped together.
  - setPartitionerFactories
```
public void setPartitionerFactories(IlvPartitionerFactory<?>[] partitionerFactories)
```
    Changes the partitioning rules that determine how objects are grouped together.
    Note: The partitioning rules are ignored when the underlying model is already of type IlvTreeListModel or IlvTreeSetModel.
  - getIdComparator
```
public Comparator<IlvClusterId> getIdComparator()
```
    Returns the comparator used to compare cluster ids.
  - setIdComparator
```
public void setIdComparator(Comparator<IlvClusterId> idComparator)
```
    Changes the comparator used to compare cluster ids.
    
    Parameters:
    
    idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator.
  - getNonClusterPosition
```
public int getNonClusterPosition()
```
    Returns the relative position of non-clusters compared to clusters.
  - setNonClusterPosition
```
public void setNonClusterPosition(int nonClusterPosition)
```
    Changes the relative position of non-clusters compared to clusters.
    
    Parameters:
    
    nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.
  - getFlatTableModel
```
public final IlvFlatTableModel getFlatTableModel()
```
    Returns the flat-table-model view of this data source.
    
    See Also:
    
    getLastingFlatTableModel(), TreeTableDataSourceEvent.FLAT_TABLE_MODEL_CHANGE
  - getLastingFlatTableModel
```
public final IlvFlatTableModel getLastingFlatTableModel()
```
    Returns the flat-table-model view of this data source.
    This is a wrapper around getFlatTableModel(). At any moment, getLastingFlatTableModel() has the same structure and contents as getFlatTableModel(). The difference is that while the result of getFlatTableModel() can change over time, for example when the parameters of this data source change, the result of getLastingFlatTableModel() is the same object across the entire lifetime of this data source.
    
    See Also:
    
    getFlatTableModel()
  - getFlatModel
```
public final IlvFlatListModel getFlatModel()
```
    Returns the flat-model view of this data source.
    
    See Also:
    
    getLastingFlatModel(), TreeTableDataSourceEvent.FLAT_MODEL_CHANGE
  - getLastingFlatModel
```
public final IlvFlatListModel getLastingFlatModel()
```
    Returns the flat-model view of this data source.
    This is a wrapper around getFlatModel(). At any moment, getLastingFlatModel() has the same structure and contents as getFlatModel(). The difference is that while the result of getFlatModel() can change over time, for example when the parameters of this data source change, the result of getLastingFlatModel() is the same object across the entire lifetime of this data source.
    
    See Also:
    
    getFlatModel()
  - getTreeModel
```
public final IlvTreeListModel getTreeModel()
```
    Returns the tree-model view of this data source.
    
    See Also:
    
    getLastingTreeModel(), TreeTableDataSourceEvent.TREE_MODEL_CHANGE
  - getLastingTreeModel
```
public final IlvTreeListModel getLastingTreeModel()
```
    Returns the tree-model view of this data source.
    This is a wrapper around getTreeModel(). At any moment, getLastingTreeModel() has the same structure and contents as getTreeModel(). The difference is that while the result of getTreeModel() can change over time, for example when the parameters of this data source change, the result of getLastingTreeModel() is the same object across the entire lifetime of this data source.
    
    See Also:
    
    getTreeModel()
  - getMappings
```
public IlvAbstractTableDataSource.Mapping[] getMappings()
```
    Returns the mapping from flat-table-model to data sets.
    
    Returns:
    
    An array of mapping information, or null if none has been set so far.
  - setMappings
```
public void setMappings(IlvAbstractTableDataSource.Mapping[] mappings)
```
    Changes the mapping from flat-table-model to data sets.
    
    Parameters:
    
    mappings - An array of mapping information, or null to return to the default mapping.
  - convertToDouble
```
public double convertToDouble(Object value)
```
    Converts an object to a double. This implementation dispatches to the underlying model if it implements IlvDataConverter, or uses a default conversion otherwise.
    
    Specified by:
    
    convertToDouble in interface IlvDataConverter
  - dispose
```
public void dispose()
```
    Cleans up this model and drops references to objects to help garbage collection.
    Note: After calling this function, this data source is no longer functional.
  - disconnect
```
public void disconnect()
```
    Drops references to objects to help garbage collection.
    Note: After calling this function, and after some changes occurred in the underlying model, this data source is no longer functional.
    
    Since:
    
    JViews 8.0

Class IlvTreeTableDataSource

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.chart.data.IlvAbstractTableDataSource

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

IlvTreeTableDataSource

IlvTreeTableDataSource

Method Detail

setDataSet

setDataSets

addDataSet

addDataSet

fireTreeTableDataSourceEvent

addTreeTableDataSourceListener

removeTreeTableDataSourceListener

isTimeSeries

getUnderlyingModel

setUnderlyingModel

getULocale

setULocale

getFilterCriterion

setFilterCriterion

getFilteredModel

isSorting

setSorting

getSortCriterionFactory

setSortCriterionFactory

getSortCriterion

setSortCriterion

getPartitionerFactories

setPartitionerFactories

getIdComparator

setIdComparator

getNonClusterPosition

setNonClusterPosition

getFlatTableModel

getLastingFlatTableModel

getFlatModel

getLastingFlatModel

getTreeModel

getLastingTreeModel

getMappings

setMappings

convertToDouble

dispose

disconnect