com.ihr.xbrl.om.rstable

Interface IRSTableTableModel

public interface IRSTableTableModel

Classes implementing this interface are normally TableModels that represent information in the GUI.

The idea is that the API can indicate the GUI the creation of a fact in a specific cell using the metadata on that cell.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
XBRLFactItem	createFactAt(int row, int column, net.sf.saxon.s9api.XdmValue value) Creates a fact with the metadata that corresponds with the cell indicated by row and column.
boolean	deleteFactAt(int row, int column) Delete an XBRLFact reported on the indicated cell if any exists.
void	fireFormTableCellUpdated(int row, int col) This is the same method from the AbstractTableModel.
void	fireTableDataChangedOnEvent(java.lang.String event, int sourceRow, int sourceColumn, int z) This is fired by the TableManager when the init event has changed values in the table.

Method Detail

createFactAt

XBRLFactItem createFactAt(int row,
                          int column,
                          net.sf.saxon.s9api.XdmValue value)
                   throws RSTableActionException

Creates a fact with the metadata that corresponds with the cell indicated by row and column. Coordinates are given in the table model space. If a fact already exists, that fact value is compared with proposed value. If they are different the existing fact value is modified. Otherwise existing value remains and no action is executed at all

Parameters:

row - the row

column - the column

value - the value

Returns:

the XBRL fact item

Throws:

RSTableActionException - the RS table action exception

deleteFactAt

boolean deleteFactAt(int row,
                     int column)
              throws RSTableActionException

Delete an XBRLFact reported on the indicated cell if any exists. Returns true if a fact has been deleted or false if the instance remains unchanged. Coordinates are given in the table model space

Parameters:

row - the row

column - the column

Returns:

true if fact deleted

Throws:

RSTableActionException - the RS table action exception

fireTableDataChangedOnEvent

void fireTableDataChangedOnEvent(java.lang.String event,
                                 int sourceRow,
                                 int sourceColumn,
                                 int z)

This is fired by the TableManager when the init event has changed values in the table.

Parameters:

event - the event

sourceRow - the source row

sourceColumn - the source column

z - the z

fireFormTableCellUpdated

void fireFormTableCellUpdated(int row,
                              int col)

This is the same method from the AbstractTableModel. It might be required to transform the row and col parameters from the form table model to the table model

Parameters:

row - the row

col - the col