ilog.views.chart.datax.adapter

Class IlvFlatListToTreeListModel

java.lang.Object

ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

ilog.views.chart.datax.adapter.IlvFlatListToTreeListModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeListModel, IlvBatchable, Cloneable

public class IlvFlatListToTreeListModel
extends IlvAbstractTreeListModel

This class implements an IlvTreeListModel, based on an IlvFlatListModel and an IlvPartitionerFactory that is used to give a tree structure to the list of objects. The order of leaf objects in the tree reflects the order in the list; the order of clusters (non-leaf objects) in the tree is given by a comparator.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.list.IlvTreeListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitioner<CIT>[] partitioners, Comparator<? super CIT> idComparator, int nonClusterPosition) Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioners.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitioner<CIT>[] partitioners, Comparator<? super CIT> idComparator, int nonClusterPosition, int eventsMaskHint) Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioners.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitioner<CIT> partitioner, Comparator<? super CIT> idComparator, int nonClusterPosition) Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitioner<CIT> partitioner, Comparator<? super CIT> idComparator, int nonClusterPosition, int eventsMaskHint) Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitionerFactory<CIT>[] partitionerFactories, Comparator<? super CIT> idComparator, int nonClusterPosition) Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioner factories.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitionerFactory<CIT>[] partitionerFactories, Comparator<? super CIT> idComparator, int nonClusterPosition, int eventsMaskHint) Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioner factories.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitionerFactory<CIT> partitionerFactory, Comparator<? super CIT> idComparator, int nonClusterPosition) Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner factory.
IlvFlatListToTreeListModel(IlvFlatListModel model, IlvPartitionerFactory<CIT> partitionerFactory, Comparator<? super CIT> idComparator, int nonClusterPosition, int eventsMaskHint) Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner factory.

Method Summary

Modifier and Type	Method and Description
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.
List	getChildren(Object parent) Returns the children objects of a given object in this model.
IlvDataColumnInfo	getColumn(int columnIndex) Returns metainformation about a column.
int	getColumnCount() Returns the number of columns in the model.
double	getDoubleAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
Object	getParent(Object object) Returns the parent object of a given object, or null if it is the root.
TreePath	getPath(Object object) Returns the path from the root to the given object.
Object	getRoot() Returns the root object in this model, or null if the model is empty.
int	getSupportedEventsMask() Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.
Object	getValueAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
void	setDoubleAt(double value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.
void	setValueAt(Object value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.

Methods inherited from class ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

addTreeListModelListener, clone, convertToDouble, endBatch, fireModelEvent, postOrderIterator, preOrderIterator, removeTreeListModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitioner<CIT>[] partitioners,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition)

Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioners.

Note: It is not useful to pass the same partitioner more than once. Instead, use different partitioners or a recursive partitioner.

Parameters:

model - The underlying model.

partitioners - The partitioning criteria.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitioner<CIT>[] partitioners,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition,
                                  int eventsMaskHint)

Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioners.

Note: It is not useful to pass the same partitioner more than once. Instead, use different partitioners or a recursive partitioner.

Parameters:

model - The underlying model.

partitioners - The partitioning criteria.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitionerFactory<CIT>[] partitionerFactories,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition)

Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioner factories.

Note: It is not useful to pass the same partitioner factory more than once. Instead, use different partitioner factories or factory for a recursive partitioner.

Parameters:

model - The underlying model.

partitionerFactories - The partitioning criteria.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitionerFactory<CIT>[] partitionerFactories,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition,
                                  int eventsMaskHint)

Creates an IlvTreeListModel from an IlvFlatListModel and a list of partitioner factories.

Note: It is not useful to pass the same partitioner factory more than once. Instead, use different partitioner factories or factory for a recursive partitioner.

Parameters:

model - The underlying model.

partitionerFactories - The partitioning criteria.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitioner<CIT> partitioner,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition)

Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner.

Parameters:

model - The underlying model.

partitioner - The partitioning criterion.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitioner<CIT> partitioner,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition,
                                  int eventsMaskHint)

Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner.

Parameters:

model - The underlying model.

partitioner - The partitioning criterion.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitionerFactory<CIT> partitionerFactory,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition)

Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner factory.

Parameters:

model - The underlying model.

partitionerFactory - The partitioning criterion.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

IlvFlatListToTreeListModel

public IlvFlatListToTreeListModel(IlvFlatListModel model,
                                  IlvPartitionerFactory<CIT> partitionerFactory,
                                  Comparator<? super CIT> idComparator,
                                  int nonClusterPosition,
                                  int eventsMaskHint)

Creates an IlvTreeListModel from an IlvFlatListModel and a partitioner factory.

Parameters:

model - The underlying model.

partitionerFactory - The partitioning criterion.

idComparator - The comparator that is used to compare cluster ids, or null denoting a default comparator. See IlvDefaultClusterIdComparator.

nonClusterPosition - Determines how non-clusters are sorted: -1 means they precede all clusters, 1 means they come at the end, 0 means no preference.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

Method Detail

getRoot

public Object getRoot()

Returns the root object in this model, or null if the model is empty.

getChildren

public List getChildren(Object parent)

Returns the children objects of a given object in this model.

Returns:

An unmodifiable list.

getPath

public TreePath getPath(Object object)

Returns the path from the root to the given object.

Specified by:

getPath in interface IlvTreeListModel

Overrides:

getPath in class IlvAbstractTreeListModel

Parameters:

object - An object in the model.

Returns:

A TreePath whose first component is getRoot() and whose last component is the given object.

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.

Valid column indices range from 0 to getColumnCount()-1 (inclusive).

getColumn

public IlvDataColumnInfo getColumn(int columnIndex)

Returns metainformation about a column.

Parameters:

columnIndex - The column.

getValueAt

public Object getValueAt(Object object,
                         int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

getDoubleAt

public double getDoubleAt(Object object,
                          int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

This method should only be used for columns whose type is Double. For other types of columns, this method will do a conversion from the object returned by getValueAt, which may be inefficient or inaccurate or raise exceptions.

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

setValueAt

public void setValueAt(Object value,
                       Object object,
                       int columnIndex)

Sets the value for the attribute number columnIndex in the given object to the given value.

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute whose value is to be changed.

setDoubleAt

public void setDoubleAt(double value,
                        Object object,
                        int columnIndex)

Sets the value for the attribute number columnIndex in the given object to the given value.

This method should only be used for columns whose type is Double. For other types of columns, this method will do a conversion to the column type, which may be inefficient or inaccurate or raise exceptions.

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute whose value is to be changed.

getSupportedEventsMask

public int getSupportedEventsMask()

Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.

This implementation returns a mask that corresponds to the one of the underlying model, combined with DURING_OBJECTS_REMOVED_MASK, intersected with the eventsMaskHint constructor argument. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvTreeListModel

Overrides:

getSupportedEventsMask in class IlvAbstractTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

getParent

public Object getParent(Object object)

Returns the parent object of a given object, or null if it is the root.

dispose

public void dispose()

Cleans up this model and drops references to objects to help garbage collection.

Note: After calling this function, this model 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 or to the partitioners, this model is no longer functional.

Since:

JViews 8.0