ilog.views.chart.datax.adapter

Class IlvFlatSetToTreeSetModel

java.lang.Object

ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

ilog.views.chart.datax.adapter.IlvFlatSetToTreeSetModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeSetModel, IlvBatchable, Cloneable

public class IlvFlatSetToTreeSetModel
extends IlvAbstractTreeSetModel

This class implements an IlvTreeSetModel, based on an IlvFlatSetModel and an IlvPartitionerFactory that is used to give a tree structure to the set of objects.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.set.IlvTreeSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitioner partitioner) Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitioner[] partitioners) Creates an IlvTreeSetModel from an IlvFlatSetModel and a list of partitioners.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitioner[] partitioners, int eventsMaskHint) Creates an IlvTreeSetModel from an IlvFlatSetModel and a list of partitioners.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitionerFactory partitionerFactory) Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner factory.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitionerFactory[] partitionerFactories) Creates an IlvTreeSetModel from an IlvFlatSetModel and a list of partitioner factories.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitionerFactory[] partitionerFactories, int eventsMaskHint) Creates an IlvTreeSetModel from an IlvFlatSetModel and a list of partitioner factories.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitionerFactory partitionerFactory, int eventsMaskHint) Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner factory.
IlvFlatSetToTreeSetModel(IlvFlatSetModel model, IlvPartitioner partitioner, int eventsMaskHint) Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner.

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.
Collection	getChildren(Object parent) Returns the set of 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.set.IlvAbstractTreeSetModel

addTreeSetModelListener, clone, convertToDouble, endBatch, fireModelEvent, postOrderIterator, preOrderIterator, removeTreeSetModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitioner[] partitioners)

Creates an IlvTreeSetModel from an IlvFlatSetModel 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.

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitioner[] partitioners,
                                int eventsMaskHint)

Creates an IlvTreeSetModel from an IlvFlatSetModel 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.

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

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitionerFactory[] partitionerFactories)

Creates an IlvTreeSetModel from an IlvFlatSetModel 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.

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitionerFactory[] partitionerFactories,
                                int eventsMaskHint)

Creates an IlvTreeSetModel from an IlvFlatSetModel 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.

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

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitioner partitioner)

Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner.

Parameters:

model - The underlying model.

partitioner - A partitioning criterion.

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitioner partitioner,
                                int eventsMaskHint)

Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner.

Parameters:

model - The underlying model.

partitioner - A partitioning criterion.

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

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitionerFactory partitionerFactory)

Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner factory.

Parameters:

model - The underlying model.

partitionerFactory - A partitioning criterion.

IlvFlatSetToTreeSetModel

public IlvFlatSetToTreeSetModel(IlvFlatSetModel model,
                                IlvPartitionerFactory partitionerFactory,
                                int eventsMaskHint)

Creates an IlvTreeSetModel from an IlvFlatSetModel and a partitioner factory.

Parameters:

model - The underlying model.

partitionerFactory - A partitioning criterion.

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 Collection getChildren(Object parent)

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

Returns:

A collection that cannot be modified.

getPath

public TreePath getPath(Object object)

Returns the path from the root to the given object.

Specified by:

getPath in interface IlvTreeSetModel

Overrides:

getPath in class IlvAbstractTreeSetModel

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 IlvTreeSetModel

Overrides:

getSupportedEventsMask in class IlvAbstractTreeSetModel

See Also:

IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.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