Package hec.model

Class AbstractDataListTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

rma.swing.table.AbstractRmaTableModel

hec.model.AbstractDataListTableModel

All Implemented Interfaces:

Serializable, TableModel, RmaTableModelInterface

public abstract class AbstractDataListTableModel
extends AbstractRmaTableModel

The AbstractDataListTable model provied a default implementation to display and edit a data list in a RmaJTable/JTable. The model wraps around a datalist object. When a cell is rendered by the table, the model gets a data object from the data list and places it into a editing buffer. The contents of the buffer is not saved until the programmer calls the commit method on the model. Blank rows are displayed by DataObjects with no names. Changes to the table are as follows, (1) If the name is blank and the id is undefined, it must be a blank row. (2) If the name is filled and the id is undefined, it is a new object (3) If the name is filled and the id is defined, it is an update.

Since:

1 February 2001

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_committingTable
protected boolean	m_commitImmediatly
protected int	m_currentEditRow
protected CommonDataList	m_dataList
protected List	m_objects
protected Component	m_parentComponent
protected List	m_tempObjects

Fields inherited from class rma.swing.table.AbstractRmaTableModel

m_columnNames, m_displayUnitSystem, m_gmtOffset, m_unitSystem

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Fields inherited from interface rma.swing.table.RmaTableModelInterface

UNDEF_COLUMN_PARAM_ID

Constructor Summary

Constructors

Constructor	Description
AbstractDataListTableModel()
AbstractDataListTableModel(CommonDataList dl)
AbstractDataListTableModel(DataList dl)

Method Summary

Modifier and Type	Method	Description
void	addColumn(String str)	add a column to the table with the header colName
void	addColumn(String colName, Vector data)	add a column to the table with header columnName and data ColumnData
void	addRow()
protected void	addRow(List tempList)
void	addRow(Vector data)	add a row to the table with data in the Vector newRow
void	clearAll()	remove all data from the table
void	clearEdits()	Clears all of the edits by removing everything from the edit buffer.
protected void	clearList(List tempList, List objectsList)
boolean	commitDataObject(DataObject dobj)	Commits a particular object to the data list.
void	commitImmediatly(boolean ci)	This allows for the model to commit whenever it gets a setValueAt() call from the table.
boolean	commitTable()	Commits all objects in the editing buffer.
void	deleteRow(int row)	Deletes a row from the editing buffer.
int	firstIndexOf(String match, int index, boolean wrap, boolean wholeWord, boolean caseSensitive)	Returns the index of an object in this list using a string match.
Class	getColumnClass(int columnIndex)
int	getColumnCount()	The method returns the number of columns in the table.
String	getColumnName(int column)	Returns a String array of column names.
int	getColumnParameter(int col)	Returns the parameter for a given column.
Vector	getDataVector()	return the table data in a vector
Vector	getRow(int row)	get the row of data at rowNum and return in a Vector
int	getRowCount()	Returns the number of rows that are in the editing buffer.
int	getUnitSystem()	returns the unit system for this data.
Object	getValueAt(int rowIndex, int columnIndex)	Returns the value for a particular row and column in the data model.
void	insertRow(int row, Vector data)	insert a row in the table at Row row with data rowData
boolean	isCellEditable(int rowIndex, int columnIndex)	Returns true if the cell at rowIndex and columnIndex is editable.
boolean	isValidRecord(DataObject dobj)	Tests to see if the data object is a valid.
int	lastIndexOf(String match, int index, boolean wholeWord, boolean caseSensitive)	Iterating from rear to front, returns the first occurance of an object in this list using a string match.
void	setColEnabled(boolean enabled, int col)	the the Column col enabled or disabled
void	setColumnClass(int col, Class cls)	st the column col's class to be cls
void	setColumnNames(String[] colNames)
void	setColumnNames(Vector colNames)
void	setColumnParameters(int[] params)
void	setParentComponent(Component c)	Allows the user to set the parent table or any component that uses this model.
void	setRowEnabled(boolean enabled, int row)	set the Row row enabled or disabled
void	setValueAt(Object aValue, int rowIndex, int columnIndex)	This does nothing.
boolean	uniqueNameInEditBuffer(String name)

Methods inherited from class rma.swing.table.AbstractRmaTableModel

getDisplayUnitSystem, getGmtOffset, insertRows, resetRowEnabled, setDisplayUnitsSystem, setUnitSystem

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

Methods inherited from interface rma.swing.table.RmaTableModelInterface

setCellEnabled

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, removeTableModelListener

Field Details

_committingTable

protected boolean _committingTable

m_dataList

protected CommonDataList m_dataList

m_objects

protected List m_objects

m_tempObjects

protected List m_tempObjects

m_commitImmediatly

protected boolean m_commitImmediatly

m_parentComponent

protected Component m_parentComponent

m_currentEditRow

protected int m_currentEditRow

Constructor Details

AbstractDataListTableModel

public AbstractDataListTableModel()

AbstractDataListTableModel

public AbstractDataListTableModel(CommonDataList dl)

AbstractDataListTableModel

public AbstractDataListTableModel(DataList dl)

Method Details

getColumnCount

public int getColumnCount()

The method returns the number of columns in the table. This is defines by the values in the column names array (m_columnNames)

Specified by:

getColumnCount in interface TableModel

Overrides:

getColumnCount in class AbstractRmaTableModel

getRowCount

public int getRowCount()

Returns the number of rows that are in the editing buffer. If an object has not been rendered, it is represented by a NULL value in the buffer. This is included in the row count.

Specified by:

getRowCount in interface TableModel

Overrides:

getRowCount in class AbstractRmaTableModel

Returns:

the row count.

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Returns the value for a particular row and column in the data model. The default implementation returns NULL. This method showl be overridden

Specified by:

getValueAt in interface TableModel

Overrides:

getValueAt in class AbstractRmaTableModel

Parameters:

rowIndex -

columnIndex -

Returns:

NULL

setValueAt

public void setValueAt(Object aValue,
 int rowIndex,
 int columnIndex)

This does nothing. Should be overridden to provide the correct implementation.

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractRmaTableModel

Parameters:

aValue -

rowIndex -

columnIndex -

firstIndexOf

public int firstIndexOf(String match,
 int index,
 boolean wrap,
 boolean wholeWord,
 boolean caseSensitive)

Returns the index of an object in this list using a string match.

Parameters:

match - The string to match.

index - The index to start the search at.

wrap - When the end of the model is reached do we wrap to the front?

wholeWord - Whether to match only whole words or not.

caseSensitive - Is the match case sensitive?

Returns:

the index of the first object that matches the search criteria; returns -1 if no object matches the search criteria.

lastIndexOf

public int lastIndexOf(String match,
 int index,
 boolean wholeWord,
 boolean caseSensitive)

Iterating from rear to front, returns the first occurance of an object in this list using a string match.

Parameters:

match - The string to match.

index - The index to start the search at.

wholeWord - Whether to match only whole words or not.

caseSensitive - Is the match case sensitive?

Returns:

the index of the last object that matches the search criteria; returns -1 if no object matches the search criteria.

getColumnName

public String getColumnName(int column)

Returns a String array of column names.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractRmaTableModel

Parameters:

column -

getColumnClass

public Class getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractRmaTableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Returns true if the cell at rowIndex and columnIndex is editable. Otherwise, setValueAt() on the cell will not change the value of that cell.

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractRmaTableModel

Parameters:

rowIndex - the row whose value is to be looked up

columnIndex - the column whose value is to be looked up

Returns:

true if the cell is editable.

See Also:

• setValueAt(java.lang.Object, int, int)

addColumn

public void addColumn(String str)

Description copied from interface: RmaTableModelInterface

add a column to the table with the header colName

Specified by:

addColumn in interface RmaTableModelInterface

Overrides:

addColumn in class AbstractRmaTableModel

addColumn

public void addColumn(String colName,
 Vector data)

Description copied from interface: RmaTableModelInterface

add a column to the table with header columnName and data ColumnData

Specified by:

addColumn in interface RmaTableModelInterface

Overrides:

addColumn in class AbstractRmaTableModel

addRow

public void addRow()

addRow

protected void addRow(List tempList)

addRow

public void addRow(Vector data)

Description copied from interface: RmaTableModelInterface

add a row to the table with data in the Vector newRow

Specified by:

addRow in interface RmaTableModelInterface

Overrides:

addRow in class AbstractRmaTableModel

setColumnNames

public void setColumnNames(Vector colNames)

Specified by:

setColumnNames in interface RmaTableModelInterface

Overrides:

setColumnNames in class AbstractRmaTableModel

setColumnNames

public void setColumnNames(String[] colNames)

Specified by:

setColumnNames in interface RmaTableModelInterface

Overrides:

setColumnNames in class AbstractRmaTableModel

setColumnParameters

public void setColumnParameters(int[] params)

Specified by:

setColumnParameters in interface RmaTableModelInterface

Overrides:

setColumnParameters in class AbstractRmaTableModel

getColumnParameter

public int getColumnParameter(int col)

Description copied from class: AbstractRmaTableModel

Returns the parameter for a given column. If no parameter is defined -1 is returned. The parameter ID returned can be decoded with the hec.data.Parameter class.

Specified by:

getColumnParameter in interface RmaTableModelInterface

Overrides:

getColumnParameter in class AbstractRmaTableModel

getUnitSystem

public int getUnitSystem()

returns the unit system for this data. The value is retrieved from the DataList which this object is wrapped around

Specified by:

getUnitSystem in interface RmaTableModelInterface

Overrides:

getUnitSystem in class AbstractRmaTableModel

deleteRow

public void deleteRow(int row)

Deletes a row from the editing buffer. If an object exists in the buffer it is deleted from the datalist. This method is called from the table, so the buffer should not have a null value because it should have been rendered

Specified by:

deleteRow in interface RmaTableModelInterface

Overrides:

deleteRow in class AbstractRmaTableModel

Parameters:

row -

setRowEnabled

public void setRowEnabled(boolean enabled,
 int row)

Description copied from interface: RmaTableModelInterface

set the Row row enabled or disabled

Specified by:

setRowEnabled in interface RmaTableModelInterface

Overrides:

setRowEnabled in class AbstractRmaTableModel

setColEnabled

public void setColEnabled(boolean enabled,
 int col)

Description copied from interface: RmaTableModelInterface

the the Column col enabled or disabled

Specified by:

setColEnabled in interface RmaTableModelInterface

Overrides:

setColEnabled in class AbstractRmaTableModel

setColumnClass

public void setColumnClass(int col,
 Class cls)

Description copied from interface: RmaTableModelInterface

st the column col's class to be cls

Specified by:

setColumnClass in interface RmaTableModelInterface

Overrides:

setColumnClass in class AbstractRmaTableModel

clearAll

public void clearAll()

Description copied from interface: RmaTableModelInterface

remove all data from the table

Specified by:

clearAll in interface RmaTableModelInterface

Overrides:

clearAll in class AbstractRmaTableModel

getRow

public Vector getRow(int row)

Description copied from interface: RmaTableModelInterface

get the row of data at rowNum and return in a Vector

Specified by:

getRow in interface RmaTableModelInterface

Overrides:

getRow in class AbstractRmaTableModel

insertRow

public void insertRow(int row,
 Vector data)

Description copied from interface: RmaTableModelInterface

insert a row in the table at Row row with data rowData

Specified by:

insertRow in interface RmaTableModelInterface

Overrides:

insertRow in class AbstractRmaTableModel

getDataVector

public Vector getDataVector()

Description copied from interface: RmaTableModelInterface

return the table data in a vector

Specified by:

getDataVector in interface RmaTableModelInterface

Overrides:

getDataVector in class AbstractRmaTableModel

commitImmediatly

public void commitImmediatly(boolean ci)

This allows for the model to commit whenever it gets a setValueAt() call from the table. The particular implementation of the commit is left to the sub-class.

Parameters:

ci -

commitTable

public boolean commitTable()

Commits all objects in the editing buffer. If the object has a non-blank name but no ID it is added to the datalist. If it has a non-blank name and a valid id the object is updated.

commitDataObject

public boolean commitDataObject(DataObject dobj)

Commits a particular object to the data list.

Parameters:

dobj -

setParentComponent

public void setParentComponent(Component c)

Allows the user to set the parent table or any component that uses this model. It is used for displaying messages to the user to get information about transaction rules.

uniqueNameInEditBuffer

public boolean uniqueNameInEditBuffer(String name)

isValidRecord

public boolean isValidRecord(DataObject dobj)

Tests to see if the data object is a valid. This method will return false if the object is either null, or its ID is undefined and its name is equal to "". Returns true if it is, other wise false.

clearEdits

public void clearEdits()

Clears all of the edits by removing everything from the edit buffer.

clearList

protected void clearList(List tempList,
 List objectsList)