fr.cnes.genius.table

Class GTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

fr.cnes.genius.table.GTableModel

All Implemented Interfaces:

Serializable, TableModel

public class GTableModel
extends AbstractTableModel

This class represents the table model for GTable widget.

Author:

jjct

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GTableModel.Format Format for the entry field.

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
GTableModel(boolean isDataEditable, int rowsNumber, int columnsNumber, GUnit headerUnit, GUnit dataUnit, double headerDefaultValue, double dataDefaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addColumn(int columnModelIndex, double headerValue) Adds a new blank column (with the default value) to the table model.
void	addColumn(int columnModelIndex, double[] newColumnValues, double headerValue) Adds a new column with values to the table model.
void	addRow(int rowModelIndex) Adds a new blank row (with the default value) to the table model.
void	addRow(int rowModelIndex, ArrayList<Double> newRowValuesList) Adds a new row with values to the table model.
void	deleteColumn(int columnModelIndex) Deletes a column from the table model.
void	deleteRow(int rowModelIndex) Deletes a row from the table model.
String	formatValue(int fracDigits, GTableModel.Format format, double value) Format the value to display according to the formatting options of the field.
int	getColumnCount()
String	getColumnName(int columnModelIndex)
GUnit	getDataCurrentUnit() Return the header current unit.
int	getDataFracDigits() Get the number of digits of the data values.
GUnit	getDataUnitInConfigFile() Get the unit of the data in the configuration file.
GUnit	getHeaderCurrentUnit() Return the header current unit.
int	getHeaderFracDigits() Get the number of digits of the header values.
GUnit	getHeaderUnitInConfigFile() Get the unit of the header in the configuration file.
ArrayList<Double>	getHeaderValues() Get the arrayList of header values.
int	getRowCount()
Object	getValueAt(int rowModelIndex, int columnModelIndex)
ArrayList<ArrayList<Double>>	getValues() Get the arayList of data values.
boolean	isCellEditable(int rowModelIndex, int columnModelIndex)
void	setColumnName(int columnModelIndex, Double newValue, String newUnitString) Sets the names of the column headers into the list of header names.
void	setDataDefaultValue(double defaultValue) Set the default value for the data cells.
void	setDataFormat(GTableModel.Format newFormat) Sets the format allowed for the field.
void	setDataFracDigits(int fracDigits) Set the number of digits of the data values.
void	setDataUnit(GUnit newUnit) Set the data unit.
void	setDataUnitInConfigFile(GUnit newUnit) Set the unit in the configuration file for the data.
void	setDataValue(int rowModelIndex, int columnModelIndex, Double newValue, String newUnitString) Set the value of the data for the cell identified by rowModelIndex and columnModelIndex.
void	setHeaderDefaultValue(double defaultValue) Set the default value for the header cells.
void	setHeaderFormat(GTableModel.Format newFormat) Sets the format allowed for the field.
void	setHeaderFracDigits(int fracDigits) Set the number of digits of the header values.
void	setHeaderUnit(GUnit newUnit) Set the header unit.
void	setHeaderUnitInConfigFile(GUnit newUnit) Set the unit in the configuration file for the header.
void	setValueAt(Object cellContents, int rowModelIndex, int columnModelIndex)

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GTableModel

public GTableModel(boolean isDataEditable,
                   int rowsNumber,
                   int columnsNumber,
                   GUnit headerUnit,
                   GUnit dataUnit,
                   double headerDefaultValue,
                   double dataDefaultValue)

Constructor.

Parameters:

isDataEditable - boolean flag that originally sets the table to editable if true or false, otherwise.

rowsNumber - the number of rows of the table model.

columnsNumber - the number of columns of the table model.

headerUnit - unit of the header.

dataUnit - unit of the data.

headerDefaultValue - default value for the header cells.

dataDefaultValue - default value for the data cells.

Method Detail

formatValue

public String formatValue(int fracDigits,
                          GTableModel.Format format,
                          double value)

Format the value to display according to the formatting options of the field.

Parameters:

fracDigits - number of fractional digits to format.

format - used to format the value, either NORMAL or SCIENTIFIC.

value - value to format.

Returns:

the formatted value.

getRowCount

public int getRowCount()

getColumnCount

public int getColumnCount()

getValueAt

public Object getValueAt(int rowModelIndex,
                         int columnModelIndex)

getColumnName

public String getColumnName(int columnModelIndex)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

isCellEditable

public boolean isCellEditable(int rowModelIndex,
                              int columnModelIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

setValueAt

public void setValueAt(Object cellContents,
                       int rowModelIndex,
                       int columnModelIndex)

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

setDataValue

public void setDataValue(int rowModelIndex,
                         int columnModelIndex,
                         Double newValue,
                         String newUnitString)
                  throws GArithmeticException

Set the value of the data for the cell identified by rowModelIndex and columnModelIndex.

Parameters:

rowModelIndex - index of the row in the model.

columnModelIndex - index of the column in the model.

newValue - new value.

newUnitString - unit of the new value, if null then use the current unit, if any.

Throws:

GArithmeticException - if newValue is NaN

setColumnName

public void setColumnName(int columnModelIndex,
                          Double newValue,
                          String newUnitString)
                   throws GArithmeticException

Sets the names of the column headers into the list of header names.

Parameters:

columnModelIndex - the index in the table model of the header to be named.

newValue - the value of the header.

newUnitString - unit of the newVale, if null the value is considered to be in the current units.

Throws:

GArithmeticException - if newValue is NaN

addRow

public void addRow(int rowModelIndex)

Adds a new blank row (with the default value) to the table model.

Parameters:

rowModelIndex - the index in the table model where to add the new row.

addRow

public void addRow(int rowModelIndex,
                   ArrayList<Double> newRowValuesList)

Adds a new row with values to the table model.

Parameters:

rowModelIndex - the index in the table model where to add the new row.

newRowValuesList - the arrayList containing the values of the new row.

addColumn

public void addColumn(int columnModelIndex,
                      double headerValue)

Adds a new blank column (with the default value) to the table model.

Parameters:

columnModelIndex - the index in the table model where to add the new column.

headerValue - the value of the header for the new column.

addColumn

public void addColumn(int columnModelIndex,
                      double[] newColumnValues,
                      double headerValue)

Adds a new column with values to the table model.

Parameters:

columnModelIndex - the index in the table model where to add the new column.

newColumnValues - the array containing the values of the new column.

headerValue - the value of the header for the new column.

deleteRow

public void deleteRow(int rowModelIndex)

Deletes a row from the table model.

Parameters:

rowModelIndex - the index in the table model of the row to be deleted.

deleteColumn

public void deleteColumn(int columnModelIndex)

Deletes a column from the table model.

Parameters:

columnModelIndex - the index in the table model of the column to be deleted.

setHeaderUnit

public void setHeaderUnit(GUnit newUnit)

Set the header unit.

Parameters:

newUnit - the new header unit.

setDataUnit

public void setDataUnit(GUnit newUnit)

Set the data unit.

Parameters:

newUnit - the new data unit.

setHeaderFormat

public void setHeaderFormat(GTableModel.Format newFormat)

Sets the format allowed for the field. If the format is NORMAL the value is formatted using the standard format. If the format is SCIENTIFIC the value is formatted using the scientific format.

Parameters:

newFormat - allowed for the field.

setDataFormat

public void setDataFormat(GTableModel.Format newFormat)

Sets the format allowed for the field. If the format is NORMAL the value is formatted using the standard format. If the format is SCIENTIFIC the value is formatted using the scientific format.

Parameters:

newFormat - allowed for the field.

setHeaderFracDigits

public void setHeaderFracDigits(int fracDigits)

Set the number of digits of the header values.

Parameters:

fracDigits - the number of digits of the header values.

getHeaderFracDigits

public int getHeaderFracDigits()

Get the number of digits of the header values.

Returns:

the number of digits of the header values.

setDataFracDigits

public void setDataFracDigits(int fracDigits)

Set the number of digits of the data values.

Parameters:

fracDigits - the number of digits of the data values.

getDataFracDigits

public int getDataFracDigits()

Get the number of digits of the data values.

Returns:

the number of digits of the data values.

setHeaderUnitInConfigFile

public void setHeaderUnitInConfigFile(GUnit newUnit)

Set the unit in the configuration file for the header.

Parameters:

newUnit - the unit in the configuration file for the header.

getHeaderUnitInConfigFile

public GUnit getHeaderUnitInConfigFile()

Get the unit of the header in the configuration file.

Returns:

the unit of the header in the configuration file.

getHeaderCurrentUnit

public GUnit getHeaderCurrentUnit()

Return the header current unit.

Returns:

the header current unit.

setDataUnitInConfigFile

public void setDataUnitInConfigFile(GUnit newUnit)

Set the unit in the configuration file for the data.

Parameters:

newUnit - the unit in the configuration file for the data.

getDataUnitInConfigFile

public GUnit getDataUnitInConfigFile()

Get the unit of the data in the configuration file.

Returns:

the unit of the data in the configuration file.

getDataCurrentUnit

public GUnit getDataCurrentUnit()

Return the header current unit.

Returns:

the header current unit.

getHeaderValues

public ArrayList<Double> getHeaderValues()

Get the arrayList of header values.

Returns:

the arrayList of header values.

getValues

public ArrayList<ArrayList<Double>> getValues()

Get the arayList of data values.

Returns:

the arrayList of data values.

setDataDefaultValue

public void setDataDefaultValue(double defaultValue)
                         throws GArithmeticException

Set the default value for the data cells.

Parameters:

defaultValue - the default value for the data cells.

Throws:

GArithmeticException - if defaultValue is NaN

setHeaderDefaultValue

public void setHeaderDefaultValue(double defaultValue)
                           throws GArithmeticException

Set the default value for the header cells.

Parameters:

defaultValue - the default value for the header cells.

Throws:

GArithmeticException - if defaultValue is NaN