com.ihr.xbrl.om.rstable

Class RSTableManager

java.lang.Object

com.ihr.xbrl.om.rstable.RSTableManager

public class RSTableManager
extends java.lang.Object

This class will work in coordination with a Table represented in the GUI (or virtually represented in a GUI) and handles the methods required to execute the actions. This class sends events to the GUI when the cells are calculated or grey out as a response to a table action.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log The log.

Constructor Summary

Constructors

Constructor and Description
RSTableManager(IRSTableTableModel tModel, XBRLTableLayout tLayout, XBRLInstance instance, EditorSource editorSource, OpenAspectValueResolver externalResolver) Instantiates a new RS table manager.

Method Summary

Modifier and Type	Method and Description
void	endTableAction() Free resources used working with the rs table processor.
void	fireTableActionEvent(java.lang.String event, int sourceRow, int sourceColumn, int z, XBRLFact fact, XBRLValidationReport validationReport) Process the events associated to the sourceRow and sourceColumn.
java.lang.String	getCurrentTableID() Access to the ID of the current table.
com.ihr.xbrl.om.rstable.RowColZ	getTestCell() Access the cell under evaluation from within the GetCelLValueFunction class implementing t:c(...)
XBRLValidationReport	initTableAction() Init resources to work with the rs table processor for this XBRLTable and process "init" event.
boolean	isDisabled(int row, int col, int z) Returns true if the target cell is disabled as the result of a disable table action.
boolean	isValueTarget(int row, int col, int z) Returns true if the target cell is calculated via a value table action.
void	setProcessorEnabled(boolean newValue) Allows applications (mainly GUI applications) to disable this processor.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

The log.

Constructor Detail

RSTableManager

public RSTableManager(IRSTableTableModel tModel,
                      XBRLTableLayout tLayout,
                      XBRLInstance instance,
                      EditorSource editorSource,
                      OpenAspectValueResolver externalResolver)

Instantiates a new RS table manager.

Parameters:

tModel - the t model

tLayout - the t layout

instance - the instance

editorSource - the editor source

externalResolver - the external resolver

Method Detail

setProcessorEnabled

public void setProcessorEnabled(boolean newValue)

Allows applications (mainly GUI applications) to disable this processor.

Parameters:

newValue - the new processor enabled

Since:

3.1.1

initTableAction

public XBRLValidationReport initTableAction()

Init resources to work with the rs table processor for this XBRLTable and process "init" event.

Returns:

XBRLValidationReport

getCurrentTableID

public java.lang.String getCurrentTableID()

Access to the ID of the current table.
If the <table> resource has no ID this method returns an string created and maintained locally.

Returns:

string, id for the table

getTestCell

public com.ihr.xbrl.om.rstable.RowColZ getTestCell()

Access the cell under evaluation from within the GetCelLValueFunction class implementing t:c(...) XPath function

Returns:

instance of RowColZ

fireTableActionEvent

public void fireTableActionEvent(java.lang.String event,
                                 int sourceRow,
                                 int sourceColumn,
                                 int z,
                                 XBRLFact fact,
                                 XBRLValidationReport validationReport)

Process the events associated to the sourceRow and sourceColumn.

Parameters:

event - the event

sourceRow - the row of the cell that fires the event. Use -1 to indicate no cell generated the event

sourceColumn - the column of the cell that fires the event. Use -1 to indicate no cell generated the event

z - the z

fact - the fact to be used in the action value

validationReport - the validation report

endTableAction

public void endTableAction()

Free resources used working with the rs table processor.

isDisabled

public boolean isDisabled(int row,
                          int col,
                          int z)

Returns true if the target cell is disabled as the result of a disable table action.

Parameters:

row - coordinate in XBRL table model

col - coordinate in XBRL table model

z - the z

Returns:

true, if is disabled

isValueTarget

public boolean isValueTarget(int row,
                             int col,
                             int z)

Returns true if the target cell is calculated via a value table action.

Parameters:

row - coordinate in XBRL table model

col - coordinate in XBRL table model

z - the z

Returns:

true, if is value target