ilog.views.chart.datax.adapter

Class IlvTreeListToFlatTableModel

java.lang.Object

ilog.views.chart.datax.flat.table.IlvAbstractFlatTableModel

ilog.views.chart.datax.flat.table.IlvBasicFlatTableModel

ilog.views.chart.datax.flat.table.IlvDefaultFlatTableModel

ilog.views.chart.datax.adapter.IlvTreeListToFlatTableModel

All Implemented Interfaces:

IlvFlatTableModel, IlvDataConverter, IlvModelWithColumns, IlvBatchable, Cloneable

public class IlvTreeListToFlatTableModel
extends IlvDefaultFlatTableModel

This class implements an IlvFlatTableModel, 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.table.IlvFlatTableModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_ROWS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvTreeListToFlatTableModel(IlvTreeListModel model, int depth) Creates a model backed by a given TreeModel, with zero columns.
IlvTreeListToFlatTableModel(IlvTreeListModel model, int depth, IlvDataColumnInfo[] columns) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeListToFlatTableModel(IlvTreeListModel model, int depth, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeListToFlatTableModel(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.
protected ilog.views.chart.datax.flat.internal.storage.IlvColumnStorage	createColumnStorage(IlvDataColumnInfo storage) Creates the backing storage for column values.
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(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex, as a numeric value.
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 in the 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(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
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.
protected boolean	setDoubleAtInternal(double value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
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.
protected boolean	setValueAtInternal(Object value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setValueAt().

Methods inherited from class ilog.views.chart.datax.flat.table.IlvBasicFlatTableModel

addColumn, addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns, setDoubleAt, setValueAt

Methods inherited from class ilog.views.chart.datax.flat.table.IlvAbstractFlatTableModel

addFlatTableModelListener, convertToDouble, endBatch, removeFlatTableModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreeListToFlatTableModel

public IlvTreeListToFlatTableModel(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.

IlvTreeListToFlatTableModel

public IlvTreeListToFlatTableModel(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

IlvTreeListToFlatTableModel

public IlvTreeListToFlatTableModel(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.

IlvTreeListToFlatTableModel

public IlvTreeListToFlatTableModel(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 in the model.

Valid row indices range from 0 to getRowCount()-1 (inclusive).

Specified by:

getRowCount in interface IlvFlatTableModel

Overrides:

getRowCount in class IlvDefaultFlatTableModel

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)

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

Specified by:

getValueAt in interface IlvFlatTableModel

Overrides:

getValueAt in class IlvDefaultFlatTableModel

getDoubleAt

public double getDoubleAt(int rowIndex,
                          int columnIndex)

Returns the value for the cell at columnIndex and rowIndex, as a numeric value.

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.

Specified by:

getDoubleAt in interface IlvFlatTableModel

Overrides:

getDoubleAt in class IlvDefaultFlatTableModel

setValueAtInternal

protected boolean setValueAtInternal(Object value,
                                     int rowIndex,
                                     int columnIndex,
                                     boolean forReal)

Does the equivalent of a setValueAt(). Instead of notifying it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, indicating whether the given value is different from the previous one.

Overrides:

setValueAtInternal in class IlvDefaultFlatTableModel

setDoubleAtInternal

protected boolean setDoubleAtInternal(double value,
                                      int rowIndex,
                                      int columnIndex,
                                      boolean forReal)

Does the equivalent of a setDoubleAt(). Instead of notifying it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, indicating whether the given value is different from the previous one.

Overrides:

setDoubleAtInternal in class IlvDefaultFlatTableModel

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

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

Overrides:

isColumnComputed in class IlvBasicFlatTableModel

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 IlvFlatTableModel

Overrides:

getSupportedEventsMask in class IlvDefaultFlatTableModel

See Also:

IlvFlatTableModel.BEFORE_DATA_CHANGE_MASK, IlvFlatTableModel.BEFORE_ROWS_REMOVED_MASK, IlvFlatTableModel.BEFORE_COLUMN_REMOVED_MASK

setRowCount

public void setRowCount(int rowCount)

This method throws an UnsupportedOperationException.

Overrides:

setRowCount in class IlvDefaultFlatTableModel

Parameters:

rowCount - The new number of rows.

addRow

public void addRow()

This method throws an UnsupportedOperationException.

Overrides:

addRow in class IlvDefaultFlatTableModel

addRow

public void addRow(Object[] rowData)

This method throws an UnsupportedOperationException.

Overrides:

addRow in class IlvDefaultFlatTableModel

Parameters:

rowData - The initial data of this row, must be an array of getColumnCount() elements.

insertRow

public void insertRow(int rowIndex)

This method throws an UnsupportedOperationException.

Overrides:

insertRow in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The new row desired index, must be >= 0 and <= getRowCount().

insertRows

public void insertRows(int rowIndex,
                       int count)

This method throws an UnsupportedOperationException.

Overrides:

insertRows in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The first new row desired index, must be >= 0 and <= getRowCount().

count - The number of rows to be inserted.

insertRow

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

This method throws an UnsupportedOperationException.

Overrides:

insertRow in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The new row desired index, must be >= 0 and <= getRowCount().

rowData - The initial data of this row, must be an array of getColumnCount() elements.

removeRow

public void removeRow(int rowIndex)

This method throws an UnsupportedOperationException.

Overrides:

removeRow in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The row index, must be >= 0 and < getRowCount().

removeRows

public void removeRows(int rowIndex,
                       int count)

This method throws an UnsupportedOperationException.

Overrides:

removeRows in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The first old row index, must be >= 0 and <= getRowCount() - count.

count - The number of rows to be removed.

createColumnStorage

protected ilog.views.chart.datax.flat.internal.storage.IlvColumnStorage createColumnStorage(IlvDataColumnInfo storage)

Description copied from class: IlvBasicFlatTableModel

Creates the backing storage for column values. This method can return null if the methods getValueAt and getDoubleAt do not need backing store.

Overrides:

createColumnStorage in class IlvBasicFlatTableModel

setColumnCount

public void setColumnCount(int columnCount)

Description copied from class: IlvBasicFlatTableModel

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 IlvBasicFlatTableModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatTableModel

Adds a column to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatTableModel

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: IlvBasicFlatTableModel

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

Overrides:

insertColumn in class IlvBasicFlatTableModel

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 getRowCount() elements. Unused if the column is a computed column.

insertColumn

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

Description copied from class: IlvBasicFlatTableModel

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

Overrides:

insertColumn in class IlvBasicFlatTableModel

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 getRowCount() elements. Unused if the column is a computed column.

removeColumn

public void removeColumn(int columnIndex)

Description copied from class: IlvBasicFlatTableModel

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicFlatTableModel

Parameters:

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

setColumns

public void setColumns(List<IlvDataColumnInfo> columns)

Description copied from class: IlvBasicFlatTableModel

Sets the list of columns.

Overrides:

setColumns in class IlvBasicFlatTableModel

Parameters:

columns - A list of IlvDataColumnInfo.

setColumn

public void setColumn(int i,
                      IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatTableModel

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

Overrides:

setColumn in class IlvBasicFlatTableModel

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 IlvBasicFlatTableModel

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 IlvBasicFlatTableModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultFlatTableModel