ilog.views.chart.datax.tree.set

Class IlvFilterTreeSetModel

java.lang.Object

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

ilog.views.chart.datax.tree.set.IlvFilterTreeSetModel

All Implemented Interfaces:

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

Direct Known Subclasses:

IlvFilteredTreeSetModel, IlvSubTreeSetModel

public class IlvFilterTreeSetModel
extends IlvAbstractTreeSetModel

This class is a base class for tree-like object set models that encapsulate other models. A subclass of this class can easily present a filtered view on a given model.

All the methods on this model are implemented by an indirection to the underlying model. Subclasses will override some of these methods to actually implement filtering or other additional functionalities.

An instance of this class automatically propagates notification events from the underlying model to its own listeners.

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
IlvFilterTreeSetModel() Creates a filter model without any underlying model.
IlvFilterTreeSetModel(IlvTreeSetModel model) Creates a filter model.
IlvFilterTreeSetModel(int eventsMask) Creates a filter model without any underlying model.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a copy of this object.
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	fireBeforeColumnRemoved(int column, IlvDataColumnInfo columnInfo) Fires a BEFORE_COLUMN_REMOVED event.
void	fireBeforeDataChange(Object object, TreePath objectPath, boolean recursive, int column) Fires a BEFORE_DATA_CHANGE event.
void	fireBeforeObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Fires a BEFORE_OBJECTS_REMOVED event.
void	fireColumnAdded(int column, IlvDataColumnInfo columnInfo) Fires a COLUMN_ADDED event.
void	fireColumnPropertyChanged(TreeSetModelEvent.Type type, int column, Object oldValue, Object newValue) Fires an EMPTY_VALUE_CHANGED or ENUMERATED_CHANGED or ENUM_VALUES_CHANGED or MIN_VALUE_CHANGED or MAX_VALUE_CHANGED event.
void	fireColumnRemoved(int column, IlvDataColumnInfo columnInfo) Fires a COLUMN_REMOVED event.
void	fireDataChanged(Object object, TreePath objectPath, boolean recursive, int column) Fires a DATA_CHANGED event.
void	fireDuringObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Fires a DURING_OBJECTS_REMOVED event.
void	fireObjectsAdded(Object parent, TreePath parentPath, Object[] objects) Fires an OBJECTS_ADDED event.
void	fireObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Fires an OBJECTS_REMOVED event.
Collection	getChildren(Object parent) This method is implemented through a call to the underlying model.
IlvDataColumnInfo	getColumn(int columnIndex) This method is implemented through a call to the underlying model.
int	getColumnCount() This method is implemented through a call to the underlying model.
double	getDoubleAt(Object object, int columnIndex) This method is implemented through a call to the underlying model.
IlvTreeSetModel	getFilteredModel() Returns the underlying model.
TreePath	getPath(Object object) This method is implemented through a call to the underlying model.
Object	getRoot() This method is implemented through a call to the underlying model.
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) This method is implemented through a call to the underlying model.
void	noteBeforeColumnRemoved(int column, IlvDataColumnInfo columnInfo) Reacts on a BEFORE_COLUMN_REMOVED event from the underlying model.
void	noteBeforeDataChange(Object object, TreePath objectPath, boolean recursive, int column) Reacts on a BEFORE_DATA_CHANGED event from the underlying model.
void	noteBeforeObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Reacts on a BEFORE_OBJECTS_REMOVED event from the underlying model.
void	noteColumnAdded(int column, IlvDataColumnInfo columnInfo) Reacts on a COLUMN_ADDED event from the underlying model.
void	noteColumnPropertyChanged(TreeSetModelEvent.Type type, int column, Object oldValue, Object newValue) Reacts on a EMPTY_VALUE_CHANGED or ENUMERATED_CHANGED or ENUM_VALUES_CHANGED or MIN_VALUE_CHANGED or MAX_VALUE_CHANGED event from the underlying model.
void	noteColumnRemoved(int column, IlvDataColumnInfo columnInfo) Reacts on a COLUMN_REMOVED event from the underlying model.
void	noteDataChanged(Object object, TreePath objectPath, boolean recursive, int column) Reacts on a DATA_CHANGED event from the underlying model.
void	noteDuringObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Reacts on a DURING_OBJECTS_REMOVED event from the underlying model.
void	noteObjectsAdded(Object parent, TreePath parentPath, Object[] objects) Reacts on an OBJECTS_ADDED event from the underlying model.
void	noteObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Reacts on an OBJECTS_REMOVED event from the underlying model.
void	setDoubleAt(double value, Object object, int columnIndex) This method is implemented through a call to the underlying model.
void	setFilteredModel(IlvTreeSetModel model) Sets the underlying model.
void	setValueAt(Object value, Object object, int columnIndex) This method is implemented through a call to the underlying model.

Methods inherited from class ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

addTreeSetModelListener, 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

IlvFilterTreeSetModel

public IlvFilterTreeSetModel()

Creates a filter model without any underlying model. You need to call setFilteredModel in order to specify the underlying model.

IlvFilterTreeSetModel

public IlvFilterTreeSetModel(int eventsMask)

Creates a filter model without any underlying model. You need to call setFilteredModel in order to specify the underlying model.

Parameters:

eventsMask - Required supported events mask for any underlying model.

IlvFilterTreeSetModel

public IlvFilterTreeSetModel(IlvTreeSetModel model)

Creates a filter model.

Parameters:

model - The underlying model.

Method Detail

getRoot

public Object getRoot()

This method is implemented through a call to the underlying model.

getChildren

public Collection getChildren(Object parent)

This method is implemented through a call to the underlying model.

Returns:

A collection that cannot be modified.

getPath

public TreePath getPath(Object object)

This method is implemented through a call to the underlying model.

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()

This method is implemented through a call to the underlying model.

getValueAt

public Object getValueAt(Object object,
                         int columnIndex)

This method is implemented through a call to the underlying model.

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)

This method is implemented through a call to the underlying model.

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.

getDoubleAt

public double getDoubleAt(Object object,
                          int columnIndex)

This method is implemented through a call to the underlying model.

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.

setDoubleAt

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

This method is implemented through a call to the underlying model.

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.

getColumn

public IlvDataColumnInfo getColumn(int columnIndex)

This method is implemented through a call to the underlying model.

Parameters:

columnIndex - The column.

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 the event mask given at construction time. 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

fireDataChanged

public void fireDataChanged(Object object,
                            TreePath objectPath,
                            boolean recursive,
                            int column)

Fires a DATA_CHANGED event.

Parameters:

object - The object whose attributes have changed.

objectPath - The path from the root to the object.

recursive - true if the attributes of the entire subtree have changed, false for a change affecting only the single object.

column - Column that changed, or -1 for all columns.

fireBeforeDataChange

public void fireBeforeDataChange(Object object,
                                 TreePath objectPath,
                                 boolean recursive,
                                 int column)

Fires a BEFORE_DATA_CHANGE event.

Parameters:

object - The object whose attributes will change.

objectPath - The path from the root to the object.

recursive - true if the attributes of the entire subtree will change, false for a change affecting only the single object.

column - Column that will change, or -1 for all columns.

fireObjectsAdded

public void fireObjectsAdded(Object parent,
                             TreePath parentPath,
                             Object[] objects)

Fires an OBJECTS_ADDED event.

Parameters:

parent - The parent object of the set of objects that were added, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that was added (together with their entire subtrees).

fireObjectsRemoved

public void fireObjectsRemoved(Object parent,
                               TreePath parentPath,
                               Object[] objects)

Fires an OBJECTS_REMOVED event.

Parameters:

parent - The parent object of the set of objects that were removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that was removed (together with their entire subtrees).

fireBeforeObjectsRemoved

public void fireBeforeObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects)

Fires a BEFORE_OBJECTS_REMOVED event.

Parameters:

parent - The parent object of the set of objects that will be removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that will be removed (together with their entire subtrees).

fireDuringObjectsRemoved

public void fireDuringObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects)

Fires a DURING_OBJECTS_REMOVED event.

Parameters:

parent - The parent object of the set of objects that will be removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that will be removed (together with their entire subtrees).

fireColumnAdded

public void fireColumnAdded(int column,
                            IlvDataColumnInfo columnInfo)

Fires a COLUMN_ADDED event.

Parameters:

column - The column that was added (index after adding).

columnInfo - The IlvDataColumnInfo of the column that was added.

fireColumnRemoved

public void fireColumnRemoved(int column,
                              IlvDataColumnInfo columnInfo)

Fires a COLUMN_REMOVED event.

Parameters:

column - The column that was removed (index before removing).

columnInfo - The IlvDataColumnInfo of the column that was removed.

fireBeforeColumnRemoved

public void fireBeforeColumnRemoved(int column,
                                    IlvDataColumnInfo columnInfo)

Fires a BEFORE_COLUMN_REMOVED event.

Parameters:

column - The column that will be removed (index before removing).

columnInfo - The IlvDataColumnInfo of the column that will be removed.

fireColumnPropertyChanged

public void fireColumnPropertyChanged(TreeSetModelEvent.Type type,
                                      int column,
                                      Object oldValue,
                                      Object newValue)

Fires an EMPTY_VALUE_CHANGED or ENUMERATED_CHANGED or ENUM_VALUES_CHANGED or MIN_VALUE_CHANGED or MAX_VALUE_CHANGED event.

Parameters:

type - One of EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

column - The affected column.

oldValue - The old value.

newValue - The new Value.

noteDataChanged

public void noteDataChanged(Object object,
                            TreePath objectPath,
                            boolean recursive,
                            int column)

Reacts on a DATA_CHANGED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireDataChanged.

Parameters:

object - The object whose attributes have changed

objectPath - The path from the root to the object

recursive - true if the attributes of the entire subtree have changed, false for a change affecting only the single object.

column - Column that changed, or -1 for all columns.

noteBeforeDataChange

public void noteBeforeDataChange(Object object,
                                 TreePath objectPath,
                                 boolean recursive,
                                 int column)

Reacts on a BEFORE_DATA_CHANGED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeDataChange.

Parameters:

object - The object whose attributes will change

objectPath - The path from the root to the object

recursive - true if the attributes of the entire subtree will change, false for a change affecting only the single object.

column - Column that will change, or -1 for all columns.

noteObjectsAdded

public void noteObjectsAdded(Object parent,
                             TreePath parentPath,
                             Object[] objects)

Reacts on an OBJECTS_ADDED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireObjectsAdded.

Parameters:

parent - The parent object of the set of objects that were added, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that was added (together with their entire subtrees).

noteObjectsRemoved

public void noteObjectsRemoved(Object parent,
                               TreePath parentPath,
                               Object[] objects)

Reacts on an OBJECTS_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireObjectsRemoved.

Parameters:

parent - The parent object of the set of objects that were removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that was removed (together with their entire subtrees).

noteBeforeObjectsRemoved

public void noteBeforeObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects)

Reacts on a BEFORE_OBJECTS_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeObjectsRemoved.

Parameters:

parent - The parent object of the set of objects that will be removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that will be removed (together with their entire subtrees).

noteDuringObjectsRemoved

public void noteDuringObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects)

Reacts on a DURING_OBJECTS_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireDuringObjectsRemoved.

Parameters:

parent - The parent object of the set of objects that will be removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that will be removed (together with their entire subtrees).

noteColumnAdded

public void noteColumnAdded(int column,
                            IlvDataColumnInfo columnInfo)

Reacts on a COLUMN_ADDED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireColumnAdded.

Parameters:

column - The column that was added (index after adding).

columnInfo - The IlvDataColumnInfo of the column that was added.

noteColumnRemoved

public void noteColumnRemoved(int column,
                              IlvDataColumnInfo columnInfo)

Reacts on a COLUMN_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireColumnRemoved.

Parameters:

column - The column that was removed (index before removing).

columnInfo - The IlvDataColumnInfo of the column that was removed.

noteBeforeColumnRemoved

public void noteBeforeColumnRemoved(int column,
                                    IlvDataColumnInfo columnInfo)

Reacts on a BEFORE_COLUMN_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeColumnRemoved.

Parameters:

column - The column that will be removed (index before removing).

columnInfo - The IlvDataColumnInfo of the column that will be removed.

noteColumnPropertyChanged

public void noteColumnPropertyChanged(TreeSetModelEvent.Type type,
                                      int column,
                                      Object oldValue,
                                      Object newValue)

Reacts on a EMPTY_VALUE_CHANGED or ENUMERATED_CHANGED or ENUM_VALUES_CHANGED or MIN_VALUE_CHANGED or MAX_VALUE_CHANGED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireColumnPropertyChanged.

Parameters:

type - One of EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

column - The affected column.

oldValue - The old value.

newValue - The new Value.

getFilteredModel

public IlvTreeSetModel getFilteredModel()

Returns the underlying model.

setFilteredModel

public void setFilteredModel(IlvTreeSetModel model)

Sets the underlying model.

Parameters:

model - The data model that this model shall refer to.

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, this model is no longer functional.

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvAbstractTreeSetModel