ilog.views.sdm.swing

Class IlvSDMTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

ilog.views.sdm.swing.IlvSDMTableModel

All Implemented Interfaces:

SDMModelListener, SDMPropertyChangeListener, IlvSDMTableModelFilter, Serializable, EventListener, TableModel

public class IlvSDMTableModel
extends AbstractTableModel
implements SDMModelListener, SDMPropertyChangeListener, IlvSDMTableModelFilter

This class is an adapter that lets you create a Swing JTable data model from an SDM model. It allows you to display the objects of a model in a JTable as follows:

   IlvSDMModel SDMModel = ...;
   IlvSDMTableModel tableModel = 
     new IlvSDMTableModel(SDMModel);
   JTable table = new JTable(tableModel);
 

Since:

JViews 4.0

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Fields inherited from interface ilog.views.sdm.swing.IlvSDMTableModelFilter

_fromProperty, _idProperty, _toProperty

Constructor Summary

Constructors

Constructor and Description
IlvSDMTableModel(IlvSDMModel SDMModel, String tag) Creates a new SDM table model that describes the objects of an SDM model.

Method Summary

Modifier and Type	Method and Description
boolean	acceptObject(Object obj) Implementation of IlvSDMTableModelFilter.
boolean	acceptProperty(Object obj, String property) Implementation of IlvSDMTableModelFilter.
void	addProperty(String prop) Adds a new property (column).
void	adjustmentFinished(SDMModelEvent event) Invoked at the end of an adjustment sequence, when setAdjusting(false) is called on the model.
void	dataChanged(SDMModelEvent event) Invoked after the SDM model has changed in such a way that the SDM view must completely recreate its graphic objects.
Class	getColumnClass(int columnIndex) Returns the class of the column at the specified index.
int	getColumnCount() Returns the total number of properties of all the objects of the SDM model.
String	getColumnName(int column) Returns the name of the column-th property.
String	getColumnName(String property) Implementation of IlvSDMTableModelFilter.
int	getColumnOfProperty(String property) Returns the column index of the specified data object property in the table model.
IlvSDMTableModelFilter	getFilter() Returns the filter used to determine what objects and properties are displayed in the table.
String	getFilteringTag() Returns the tag used to filter the objects of the SDM model.
Object	getObject(int row) Returns the data object whose properties are displayed by the row-th row of this table model.
int	getRowCount() Returns the number of objects in the SDM model, including the objects contained in subobjects.
int	getRowOfObject(Object object) Returns the row index of the specified data object in the table model.
IlvSDMModel	getSDMModel() Returns the SDM model for which this table model is an adapter.
Object	getValueAt(int row, int column) Returns the value of the column-th property of the row-th object returned by the SDM model.
boolean	isCellEditable(int row, int column) Returns true if the underlying SDM model is editable.
boolean	isEditable(Object obj, String property) Implementation of IlvSDMTableModelFilter.
boolean	isEditionAllowed() Returns true if editing is allowed through this table model, and false otherwise.
void	linkDestinationChanged(SDMModelEvent event) Invoked after the destination node of a link has been changed.
void	linkSourceChanged(SDMModelEvent event) Invoked after the source node of a link has been changed.
void	objectAdded(SDMModelEvent event) Invoked after nodes or links have been added to the SDM model.
void	objectRemoved(SDMModelEvent event) Invoked after nodes or links have been removed from the SDM model.
void	propertyChanged(SDMPropertyChangeEvent event) Invoked after one or several properties of a data object have changed.
void	setEditionAllowed(boolean allowed) Allows or forbids editing through this table model.
void	setFilter(IlvSDMTableModelFilter filter) Sets the filter used to determine what objects and properties are displayed in the table.
void	setFilteringTag(String tag) Sets the tag used to filter the objects of the SDM model.
void	setSDMModel(IlvSDMModel SDMModel) Sets the SDM model for which this table model is an adapter.
void	setValueAt(Object value, int row, int column) Sets the value of the column-th property of the row-th object returned by the SDM model.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSDMTableModel

public IlvSDMTableModel(IlvSDMModel SDMModel,
                        String tag)

Creates a new SDM table model that describes the objects of an SDM model.

Parameters:

SDMModel - The SDM model whose objects are to be displayed in a Swing JTable.

tag - The initial filtering tag, or null to display all the objects.

Method Detail

setFilter

public void setFilter(IlvSDMTableModelFilter filter)

Sets the filter used to determine what objects and properties are displayed in the table.

Parameters:

filter - The new filter. If the filter is null, it is reset to the default filter, which is this table model instance, and which accepts all objects and properties by default.

getFilter

public IlvSDMTableModelFilter getFilter()

Returns the filter used to determine what objects and properties are displayed in the table. The default filter is this table model instance, which accepts all objects and properties by default.

setFilteringTag

public void setFilteringTag(String tag)

Sets the tag used to filter the objects of the SDM model. If tag is not null, only the objects with the specified tag will be displayed. If it is null, all the objects of the SDM model are displayed.

Parameters:

tag - The new tag.

getFilteringTag

public String getFilteringTag()

Returns the tag used to filter the objects of the SDM model.

setEditionAllowed

public void setEditionAllowed(boolean allowed)

Allows or forbids editing through this table model. A property of an object will be editable in the table if all the following conditions are true:

1. isEditionAllowed() returns true.
2. The underlying SDM model is editable.
3. The filter's isEditable(java.lang.Object, java.lang.String) method returns true for the object's property.

Parameters:

allowed - If true, allows the objects of this model to be edited.

isEditionAllowed

public boolean isEditionAllowed()

Returns true if editing is allowed through this table model, and false otherwise.

See Also:

setEditionAllowed(boolean)

getColumnCount

public int getColumnCount()

Returns the total number of properties of all the objects of the SDM model.

Specified by:

getColumnCount in interface TableModel

getRowCount

public int getRowCount()

Returns the number of objects in the SDM model, including the objects contained in subobjects.

Specified by:

getRowCount in interface TableModel

getValueAt

public Object getValueAt(int row,
                         int column)

Returns the value of the column-th property of the row-th object returned by the SDM model.

Specified by:

getValueAt in interface TableModel

Parameters:

row - The table row index.

column - The table column index.

getColumnName

public String getColumnName(int column)

Returns the name of the column-th property.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

Parameters:

column - The table column index.

getColumnClass

public Class getColumnClass(int columnIndex)

Returns the class of the column at the specified index.

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

Parameters:

columnIndex - The table column index.

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Returns true if the underlying SDM model is editable. If a filter is defined, this method returns the result of the filter's isEditable method.

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

Parameters:

row - The table row index.

column - The table column index.

setValueAt

public void setValueAt(Object value,
                       int row,
                       int column)

Sets the value of the column-th property of the row-th object returned by the SDM model.

This method assumes that the underlying SDM model is editable.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

Parameters:

value - The new property value.

row - The table row index.

column - The table column index.

setSDMModel

public void setSDMModel(IlvSDMModel SDMModel)

Sets the SDM model for which this table model is an adapter.

Parameters:

SDMModel - The new SDM model.

getSDMModel

public IlvSDMModel getSDMModel()

Returns the SDM model for which this table model is an adapter.

addProperty

public void addProperty(String prop)

Adds a new property (column).

Parameters:

prop - The new property.

objectAdded

public void objectAdded(SDMModelEvent event)

Invoked after nodes or links have been added to the SDM model.

Specified by:

objectAdded in interface SDMModelListener

Parameters:

event - The event.

objectRemoved

public void objectRemoved(SDMModelEvent event)

Invoked after nodes or links have been removed from the SDM model.

Specified by:

objectRemoved in interface SDMModelListener

Parameters:

event - The event.

dataChanged

public void dataChanged(SDMModelEvent event)

Invoked after the SDM model has changed in such a way that the SDM view must completely recreate its graphic objects.

Specified by:

dataChanged in interface SDMModelListener

Parameters:

event - The event.

adjustmentFinished

public void adjustmentFinished(SDMModelEvent event)

Invoked at the end of an adjustment sequence, when setAdjusting(false) is called on the model.

This implementation does nothing.

Specified by:

adjustmentFinished in interface SDMModelListener

Parameters:

event - The event.

linkSourceChanged

public void linkSourceChanged(SDMModelEvent event)

Invoked after the source node of a link has been changed.

Specified by:

linkSourceChanged in interface SDMModelListener

Parameters:

event - The event.

linkDestinationChanged

public void linkDestinationChanged(SDMModelEvent event)

Invoked after the destination node of a link has been changed.

Specified by:

linkDestinationChanged in interface SDMModelListener

Parameters:

event - The event.

propertyChanged

public void propertyChanged(SDMPropertyChangeEvent event)

Invoked after one or several properties of a data object have changed. This method can also be called when an arbitrary set of properties have changed: in that case, the property name and the old and new values contained in the event are null.

Specified by:

propertyChanged in interface SDMPropertyChangeListener

Parameters:

event - The event.

getObject

public Object getObject(int row)

Returns the data object whose properties are displayed by the row-th row of this table model.

Parameters:

row - The row index.

getRowOfObject

public int getRowOfObject(Object object)

Returns the row index of the specified data object in the table model.

Parameters:

object - The object from the SDM data model.

Returns:

A positive integer, or -1 if the object is not found or not displayed by this table model.

getColumnOfProperty

public int getColumnOfProperty(String property)

Returns the column index of the specified data object property in the table model.

Parameters:

property - The property name.

Returns:

A positive integer, or -1 if the property is not found.

acceptObject

public boolean acceptObject(Object obj)

Implementation of IlvSDMTableModelFilter. Returns true if the object tag matches the tag set by setFilteringTag(java.lang.String), or if no filtering tag has been set for this table model.

Specified by:

acceptObject in interface IlvSDMTableModelFilter

Parameters:

obj - The object tag.

acceptProperty

public boolean acceptProperty(Object obj,
                              String property)

Implementation of IlvSDMTableModelFilter. This method returns true.

Specified by:

acceptProperty in interface IlvSDMTableModelFilter

Parameters:

obj - The object from the SDM data model.

property - The property name.

getColumnName

public String getColumnName(String property)

Implementation of IlvSDMTableModelFilter. This method returns property.

Specified by:

getColumnName in interface IlvSDMTableModelFilter

Parameters:

property - The property name.

isEditable

public boolean isEditable(Object obj,
                          String property)

Implementation of IlvSDMTableModelFilter. Returns true if and only if the SDM model is editable.

Specified by:

isEditable in interface IlvSDMTableModelFilter

Parameters:

obj - The object from the SDM data model.

property - The property name.