ilog.views.chart.datax.adapter

Class IlvTreeListToFlatListModel

java.lang.Object

ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

ilog.views.chart.datax.flat.list.IlvBasicFlatListModel

ilog.views.chart.datax.adapter.IlvTreeListToFlatListModel

All Implemented Interfaces:

IlvFlatListModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

public class IlvTreeListToFlatListModel
extends IlvBasicFlatListModel

This class implements an IlvFlatListModel, based on an IlvTreeListModel.

The table columns are the tree list model columns, plus a synthetic column called "path".

Note: This model does not support adding and removing rows. You should use the underlying IlvTreeListModel for this purpose (assuming it is an instance of IlvDefaultTreeListModel).

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.list.IlvFlatListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvTreeListToFlatListModel(IlvTreeListModel model, int depth) Creates a model backed by a given TreeModel, with zero columns.
IlvTreeListToFlatListModel(IlvTreeListModel model, int depth, IlvDataColumnInfo[] columns) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeListToFlatListModel(IlvTreeListModel model, int depth, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeListToFlatListModel(IlvTreeListModel model, int depth, int eventsMaskHint) Creates a model backed by a given TreeModel, with zero columns.

Method Summary

Modifier and Type	Method and Description
void	addRow() This method throws an UnsupportedOperationException.
void	addRow(Object[] rowData) This method throws an UnsupportedOperationException.
Object	clone() Returns a copy of this object.
Object	computePathValue(TreePath path) Returns the value of the special property denoting the tree path from tree root to the given 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	firePathColumnDataChanged() Notifies the listeners that all values in the path column may have changed.
double	getDoubleAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
List	getObjects() Returns the objects in this model.
TreePath	getPath(Object object) Returns the path in the underlying tree model from the root to the given object.
String	getPathProperty() Returns the name of the special property denoting the tree path from tree root to the given object.
String	getPathValueProperty() Returns the property used to compute the special property denoting the tree path.
String	getPathValueSeparator() Returns the separator used to compute the special property denoting the tree path.
int	getRowCount() Returns the number of rows.
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	insertColumn(int columnIndex, IlvDataColumnInfo column) Adds a column to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, double[] data) Adds a column with given data to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, Object[] data) Adds a column with given data to the model at a given index.
void	insertRow(int rowIndex) This method throws an UnsupportedOperationException.
void	insertRow(int rowIndex, Object[] rowData) This method throws an UnsupportedOperationException.
void	insertRows(int rowIndex, int count) This method throws an UnsupportedOperationException.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAtInternal and setDoubleAtInternal have no effect on a given column.
void	removeColumn(int columnIndex) Removes a column from the model.
void	removeRow(int rowIndex) This method throws an UnsupportedOperationException.
void	removeRows(int rowIndex, int count) This method throws an UnsupportedOperationException.
void	setColumn(int i, IlvDataColumnInfo column) Replaces or adds a column.
void	setColumnCount(int columnCount) Sets the number of columns in the model.
void	setColumns(List<IlvDataColumnInfo> columns) Sets the list of columns.
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	setPathProperty(String name) Sets the name of the special property denoting the tree path from tree root to the given object.
void	setPathValueProperty(String name) Sets the property used to compute the special property denoting the tree path.
void	setPathValueSeparator(String separator) Sets the separator used to compute the special property denoting the tree path.
void	setRowCount(int rowCount) This method throws an UnsupportedOperationException.
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.flat.list.IlvBasicFlatListModel

addColumn, addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns

Methods inherited from class ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

addFlatListModelListener, convertToDouble, endBatch, removeFlatListModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreeListToFlatListModel

public IlvTreeListToFlatListModel(IlvTreeListModel model,
                                  int depth)

Creates a model backed by a given TreeModel, with zero columns.

Parameters:

model - A TreeModel.

depth - A depth limit; use Integer.MAX_VALUE to use the entire model.

IlvTreeListToFlatListModel

public IlvTreeListToFlatListModel(IlvTreeListModel model,
                                  int depth,
                                  int eventsMaskHint)

Creates a model backed by a given TreeModel, with zero columns.

Parameters:

model - A TreeModel.

depth - A depth limit; use Integer.MAX_VALUE to use the entire model.

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

IlvTreeListToFlatListModel

public IlvTreeListToFlatListModel(IlvTreeListModel model,
                                  int depth,
                                  IlvDataColumnInfo[] columns)

Creates a model backed by a given TreeModel, with the given columns.

Parameters:

model - A TreeModel.

depth - A depth limit; use Integer.MAX_VALUE to use the entire model.

columns - The initial list of columns.

IlvTreeListToFlatListModel

public IlvTreeListToFlatListModel(IlvTreeListModel model,
                                  int depth,
                                  IlvDataColumnInfo[] columns,
                                  int eventsMaskHint)

Creates a model backed by a given TreeModel, with the given columns.

Parameters:

model - A TreeModel.

depth - A depth limit; use Integer.MAX_VALUE to use the entire model.

columns - The initial list of columns.

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

getRowCount

public int getRowCount()

Returns the number of rows.

firePathColumnDataChanged

public void firePathColumnDataChanged()

Notifies the listeners that all values in the path column may have changed.

getPathProperty

public String getPathProperty()

Returns the name of the special property denoting the tree path from tree root to the given object.

See Also:

setPathProperty(java.lang.String), computePathValue(javax.swing.tree.TreePath)

setPathProperty

public void setPathProperty(String name)

Sets the name of the special property denoting the tree path from tree root to the given object.

The default value is "path".

See Also:

getPathProperty(), computePathValue(javax.swing.tree.TreePath)

computePathValue

public Object computePathValue(TreePath path)

Returns the value of the special property denoting the tree path from tree root to the given object.

In the default implementation, this method returns a string constructed by concatenating the values of the pathValueProperty of each tree node in the tree path, separated by pathValueSeparator.

This method can be overridden in a subclass. The subclass is then responsible for calling firePathColumnDataChanged() whenever some result of computePathValue changes.

See Also:

getPathProperty(), setPathProperty(java.lang.String), getPathValueProperty(), setPathValueProperty(java.lang.String), getPathValueSeparator(), setPathValueSeparator(java.lang.String)

getPathValueProperty

public String getPathValueProperty()

Returns the property used to compute the special property denoting the tree path.

See Also:

setPathValueProperty(java.lang.String), computePathValue(javax.swing.tree.TreePath)

setPathValueProperty

public void setPathValueProperty(String name)

Sets the property used to compute the special property denoting the tree path.

The argument can be a column name, or the special token "%string", denoting the string representation of the tree node, or "%index", denoting the index of the tree node in its parent children list.

The default value is "%string".

See Also:

getPathValueProperty(), computePathValue(javax.swing.tree.TreePath)

getPathValueSeparator

public String getPathValueSeparator()

Returns the separator used to compute the special property denoting the tree path.

See Also:

setPathValueSeparator(java.lang.String), computePathValue(javax.swing.tree.TreePath)

setPathValueSeparator

public void setPathValueSeparator(String separator)

Sets the separator used to compute the special property denoting the tree path.

The default value is "/".

See Also:

getPathValueSeparator(), computePathValue(javax.swing.tree.TreePath)

getObjects

public List getObjects()

Returns the objects in this model.

Returns:

An unmodifiable list.

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.

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

Returns true if setValueAtInternal and setDoubleAtInternal have no effect on a given column.

Overrides:

isColumnComputed in class IlvBasicFlatListModel

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 currently returns BEFORE_COLUMN_REMOVED_MASK, intersected with the eventsMaskHint constructor argument. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvFlatListModel

Overrides:

getSupportedEventsMask in class IlvBasicFlatListModel

See Also:

IlvFlatListModel.BEFORE_DATA_CHANGE_MASK, IlvFlatListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatListModel.BEFORE_COLUMN_REMOVED_MASK

getPath

public TreePath getPath(Object object)

Returns the path in the underlying tree model from the root to the given object.

setRowCount

public void setRowCount(int rowCount)

This method throws an UnsupportedOperationException.

addRow

public void addRow()

This method throws an UnsupportedOperationException.

addRow

public void addRow(Object[] rowData)

This method throws an UnsupportedOperationException.

insertRow

public void insertRow(int rowIndex)

This method throws an UnsupportedOperationException.

insertRows

public void insertRows(int rowIndex,
                       int count)

This method throws an UnsupportedOperationException.

insertRow

public void insertRow(int rowIndex,
                      Object[] rowData)

This method throws an UnsupportedOperationException.

removeRow

public void removeRow(int rowIndex)

This method throws an UnsupportedOperationException.

removeRows

public void removeRows(int rowIndex,
                       int count)

This method throws an UnsupportedOperationException.

setColumnCount

public void setColumnCount(int columnCount)

Description copied from class: IlvBasicFlatListModel

Sets the number of columns in the model. If the new size is greater than the current size, new columns are added to the end of the model. If the new size is less than the current size, all columns at index columnCount and greater are discarded.

Overrides:

setColumnCount in class IlvBasicFlatListModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatListModel

Adds a column to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount()

column - The metainformation of this column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         Object[] data)

Description copied from class: IlvBasicFlatListModel

Adds a column with given data to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount().

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getObjects().size() elements. Not used if the column is a computed column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         double[] data)

Description copied from class: IlvBasicFlatListModel

Adds a column with given data to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - the new column desired index, must be >= 0 and <= getColumnCount().

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getObjects().size() elements. Not used if the column is a computed column.

removeColumn

public void removeColumn(int columnIndex)

Description copied from class: IlvBasicFlatListModel

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The column index, must be >= 0 and < getColumnCount().

setColumns

public void setColumns(List<IlvDataColumnInfo> columns)

Description copied from class: IlvBasicFlatListModel

Sets the list of columns.

Overrides:

setColumns in class IlvBasicFlatListModel

Parameters:

columns - A list of IlvDataColumnInfo.

setColumn

public void setColumn(int i,
                      IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatListModel

Replaces or adds a column. This is equivalent to removeColumn(i) followed by insertColumn(i, column).

Overrides:

setColumn in class IlvBasicFlatListModel

column - An IlvDataColumnInfo.

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.

Overrides:

dispose in class IlvBasicFlatListModel

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

Overrides:

disconnect in class IlvBasicFlatListModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvBasicFlatListModel