com.ihr.xbrl.om.table.layout

Class XBRLTableLayout

java.lang.Object

javax.swing.table.AbstractTableModel

com.ihr.xbrl.om.table.layout.XBRLTableLayout

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel

public class XBRLTableLayout
extends javax.swing.table.AbstractTableModel

The table layout class contains an object model suitable for representation in a graphical view. It contains the effective breakdown for each axis and the headers (for rows and columns) also implements the elimination and expansion processes and resolves the relationship between data and the table cells. In the future, this class should implement a table model and other components to fully draw a table in the GUI

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XBRLTableLayout(XBRLStructuralTable structuralTable) Creates a new XBRLTableLayout from a structural table.

Method Summary

Modifier and Type	Method and Description
void	clear() Deprecated.
void	createModel(XMLFragment tableSet) Generates the table layout model from the table content.
Aspect<?>	getAspectOnCell(java.lang.Object identity, Cell cell) Returns the aspect instance for the cell received in the parameter.
Aspect<?>	getAspectOnCell(java.lang.Object identity, CellHeader och) Returns the aspect instance for the cell header received in the parameter.
java.util.Iterator<Axis>	getAxis() Returns an iterator on axis defined in this table.
Axis	getAxisOnCell(java.lang.Object identity, Cell cell) Returns the axis for the cell received in the parameter.
Cell	getCellAt(int rowIndex, int columnIndex) Access to the Cell object for specific rowIndex and columnIndex.
Axis	getCellAxis(XBRLTableResource node) Gets the cell axis.
int	getCellColumnIndentation(Cell cell) Returns the number of top-vertically cell headers.
CellHeader	getCellHeader(XBRLTableResource node) Find a table resource node in all the axis and returns the CellHeader where that node is linked with.
int	getCellRowIndentation(Cell cell) Returns the number of left-horizontally cell headers.
int	getColumnCount() Gets the column count.
java.util.Set<javax.xml.namespace.QName>	getConcepts() Returns a set of QNames for all concepts used in table rows or columns of the ZAxis.
FactsListClassifier	getFactsSelector() Gets the facts selector.
XBRLItem	getItemAt(int rowIndex, int columnIndex) Returns the XBRLItem for a specific cell indicated as a row and column if the cell contains a tuple, the result value is null.
int	getMissingAspects() At the end of the table layout process, the table is explored for missing aspects.
int	getNumZExcluded() Internal use only.
int	getNumZMissingCombinationsExcluded() Internal use only.
int	getRowCount() Gets the row count.
CompanyKey	getSelectedCompany() This method is required by the export to excel process but it shouldn't be here because a table might contains multiple companies in multiple rows.
XBRLStructuralTable	getStructuralTable() Access to the table structural model.
java.util.Collection<CellHeader>	getTableHeadersRoots(Axis axis) Access to the cell headers in the leftmost row or column.
int	getTotZMissingCombinations() Internal use only.
java.util.Collection<XBRLFact>	getValueAt(int rowIndex, int columnIndex) Obtains the value of a table cell.
CellHeader	getXLevelCell(int xLevel) Gets the x level cell.
java.util.Map<java.lang.String,java.lang.Integer>	getXLevelDefinitionNodeIds() Gets the x level definition node ids.
CellHeader	getYLevelCell(int yLevel) Gets the y level cell.
java.util.Map<java.lang.String,java.lang.Integer>	getYLevelDefinitionNodeIds() Gets the y level definition node ids.
int	getZLevel() Access to the current value of the zLevel on this table layout.
int	getZLevel(AxisSlice selectedObjects) Gets the z level.
CellHeader	getZLevelCell(int zLevel) Returns the CellHeader in the Z axis that corresponds with the indicated zLevel number.
java.util.Map<AxisSlice,java.lang.Integer>	getZLevelContent() Gets the axis level content.
java.util.Map<java.lang.String,java.lang.Integer>	getZLevelDefinitionNodeIds() Gets the z level definition node ids.
java.lang.String	getZLevelLabel(int zCombNumber) Gets the z level label.
int	getZLevels() Returns the maximum ZLevel number for this table layout.
boolean	isAxisDefined(Axis axis) Returns true if the table contains information for the axis indicated in the axis parameter.
boolean	isCellAt(int rowIndex, int columnIndex) Checks if there is a cell at the indicated rowIndex and columnIndex and returns true if the cell exists or false if the cell is out of the table.
boolean	isCellEditable(int rowIndex, int columnIndex) Checks if is cell editable.
void	layout(XBRLFactsList factsSource, EditorSource editorSource, OpenAspectValueResolver externalResolver) Prepares the table layout.
void	setNumZExcluded(int numZExcluded) Internal use only.
void	setNumZMissingCombinationsExcluded(int numZMissingCombinationsExcluded) Internal use only.
void	setTotZMissingCombinations(int totZMissingCombinations) Internal use only.
int	setZlevel(int zIndex) Sets the current zLevel to the value indicated in the zIndex parameter.

Methods inherited from class javax.swing.table.AbstractTableModel

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLTableLayout

public XBRLTableLayout(XBRLStructuralTable structuralTable)
                throws XTValidationException,
                       XFException

Creates a new XBRLTableLayout from a structural table. This is just the constructor. The layout is generated later in a call to the layout(XBRLFactsList, EditorSource, OpenAspectValueResolver) method

Parameters:

structuralTable - the structural table

Throws:

XTValidationException - the XT validation exception

XFException - the XF exception

Method Detail

getMissingAspects

public int getMissingAspects()

At the end of the table layout process, the table is explored for missing aspects. Actually the aspects explored are the Concept aspect, the Entity Identifier aspect and the Period aspect. If the aspect is not explicitly referenced in the table it is considered as an open aspect whose value will be provided by the GUI. At this time, the getMissingAspects() method returns a bitmap integer with missing aspects marked as 1

Returns:

the missing aspects

See Also:

CommonAspectRule

layout

public void layout(XBRLFactsList factsSource,
                   EditorSource editorSource,
                   OpenAspectValueResolver externalResolver)
            throws XFException,
                   XTValidationException

Prepares the table layout. This includes the expansion process and the process to prepare headers and cells The process might be fired when new values are added to the EditorSource in order to recreate the cells

Parameters:

factsSource - the source of facts for this layout. this is the same value used to build up this XBRLTableLayout instance

editorSource - if this is not null, this must be an instance of the EditorSource interface that might provide extra values to open dimensions

externalResolver - if this is not null, this class will be used to constrain the values of the selected dimensions in the Z axis

Throws:

XFException - the XF exception

XTValidationException - the XT validation exception

getStructuralTable

public XBRLStructuralTable getStructuralTable()

Access to the table structural model.

Returns:

the structuralTable

getAxis

public java.util.Iterator<Axis> getAxis()

Returns an iterator on axis defined in this table. The iterator order is undefined

Returns:

the axis iterator

isAxisDefined

public boolean isAxisDefined(Axis axis)

Returns true if the table contains information for the axis indicated in the axis parameter.

Parameters:

axis - the axis

Returns:

true, if is axis defined

getTableHeadersRoots

public java.util.Collection<CellHeader> getTableHeadersRoots(Axis axis)

Access to the cell headers in the leftmost row or column. From this point it shall be possible to traverse CellHeaders using getChildren on the returned CellHeader

Parameters:

axis - the axis

Returns:

the table headers roots

createModel

public void createModel(XMLFragment tableSet)
                 throws XTValidationException

Generates the table layout model from the table content. This call generates the model for the entire layout. The parent node is the tableSet element.

Parameters:

tableSet - this is a jdom Element that must be a tableSet

Throws:

XTValidationException - the XT validation exception

getAspectOnCell

public Aspect<?> getAspectOnCell(java.lang.Object identity,
                                 Cell cell)

Returns the aspect instance for the cell received in the parameter.

Parameters:

identity - the aspect identity, this is a code defined for every aspect and a QName for specific dimensions

cell - the cell

Returns:

the aspect on cell

getAspectOnCell

public Aspect<?> getAspectOnCell(java.lang.Object identity,
                                 CellHeader och)

Returns the aspect instance for the cell header received in the parameter.

Parameters:

identity - the aspect identity, this is a code defined for every aspect and a QName for specific dimensions

och - the och

Returns:

the aspect on cell

getAxisOnCell

public Axis getAxisOnCell(java.lang.Object identity,
                          Cell cell)

Returns the axis for the cell received in the parameter.

Parameters:

identity - the aspect identity, this is a code defined for every aspect and a QName for specific dimensions

cell - the cell

Returns:

the axis on cell

getFactsSelector

public FactsListClassifier getFactsSelector()

Gets the facts selector.

Returns:

the facts selector

getZLevels

public int getZLevels()

Returns the maximum ZLevel number for this table layout. The first one is always 1, the range is between 1 and the value returned by this method inclusive. If this method returns 0 this means the table has no ZAxis, no rows and no columns defined.

Returns:

integer

See Also:

getZLevel(), setZlevel(int)

getZLevelCell

public CellHeader getZLevelCell(int zLevel)

Returns the CellHeader in the Z axis that corresponds with the indicated zLevel number.

Parameters:

zLevel - the z level

Returns:

the z level cell

getXLevelCell

public CellHeader getXLevelCell(int xLevel)

Gets the x level cell.

Parameters:

xLevel - the x level

Returns:

the x level cell

getXLevelDefinitionNodeIds

public java.util.Map<java.lang.String,java.lang.Integer> getXLevelDefinitionNodeIds()

Gets the x level definition node ids.

Returns:

the x level definition node ids

getYLevelDefinitionNodeIds

public java.util.Map<java.lang.String,java.lang.Integer> getYLevelDefinitionNodeIds()

Gets the y level definition node ids.

Returns:

the y level definition node ids

getZLevelDefinitionNodeIds

public java.util.Map<java.lang.String,java.lang.Integer> getZLevelDefinitionNodeIds()

Gets the z level definition node ids.

Returns:

the z level definition node ids

getYLevelCell

public CellHeader getYLevelCell(int yLevel)

Gets the y level cell.

Parameters:

yLevel - the y level

Returns:

the y level cell

getRowCount

public int getRowCount()

Gets the row count.

Returns:

the row count

getColumnCount

public int getColumnCount()

Gets the column count.

Returns:

the column count

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Checks if is cell editable.

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

Parameters:

rowIndex - the row index

columnIndex - the column index

Returns:

true, if is cell editable

setZlevel

public int setZlevel(int zIndex)

Sets the current zLevel to the value indicated in the zIndex parameter. If the table layout contains multiple tables, this value establish the value of the z axis that selects the proper slice and applies to all calls to getCellAt, getItemAt and other methods that accepts row index and column index. Z levels are numbered starting from 1

Parameters:

zIndex - the new zlevel

Returns:

the int

getZLevel

public int getZLevel()

Access to the current value of the zLevel on this table layout.

Returns:

integer representing the index of current z level

getCellAt

public Cell getCellAt(int rowIndex,
                      int columnIndex)

Access to the Cell object for specific rowIndex and columnIndex. First rowIndex and first columnIndex is 1.

Parameters:

rowIndex - the row index

columnIndex - the column index

Returns:

the cell at

isCellAt

public boolean isCellAt(int rowIndex,
                        int columnIndex)

Checks if there is a cell at the indicated rowIndex and columnIndex and returns true if the cell exists or false if the cell is out of the table.

Parameters:

rowIndex - the row index

columnIndex - the column index

Returns:

true if there is such cell in the table model

getValueAt

public java.util.Collection<XBRLFact> getValueAt(int rowIndex,
                                                 int columnIndex)

Obtains the value of a table cell. Note first cell and first column is numbered starting from 1 not from 0

Parameters:

rowIndex - the row index

columnIndex - the column index

Returns:

the value at

See Also:

TableModel.getValueAt(int, int)

getItemAt

public XBRLItem getItemAt(int rowIndex,
                          int columnIndex)

Returns the XBRLItem for a specific cell indicated as a row and column if the cell contains a tuple, the result value is null.

Parameters:

rowIndex - the row index

columnIndex - the column index

Returns:

the item at

getConcepts

public java.util.Set<javax.xml.namespace.QName> getConcepts()

Returns a set of QNames for all concepts used in table rows or columns of the ZAxis. The set is updated during the layout process.

Returns:

the concepts

getSelectedCompany

public CompanyKey getSelectedCompany()

This method is required by the export to excel process but it shouldn't be here because a table might contains multiple companies in multiple rows.

Returns:

the selected company

getZLevel

public int getZLevel(AxisSlice selectedObjects)

Gets the z level.

Parameters:

selectedObjects - the selected objects

Returns:

the z level

getZLevelContent

public java.util.Map<AxisSlice,java.lang.Integer> getZLevelContent()

Gets the axis level content.

Returns:

the axis level content

getZLevelLabel

public java.lang.String getZLevelLabel(int zCombNumber)

Gets the z level label.

Parameters:

zCombNumber - the z comb number

Returns:

the z level label

clear

@Deprecated
public void clear()

Deprecated.

This method shall be called only from the structural table and when no uses of this XBRLTableLayout remain referenced. Use

 getStructuralTable().resetLayout()
 

instead of calling clear on this class Clear.

setNumZExcluded

public void setNumZExcluded(int numZExcluded)

Internal use only.

Parameters:

numZExcluded - the new num Z excluded

getNumZExcluded

public int getNumZExcluded()

Internal use only.

Returns:

the num Z excluded

setNumZMissingCombinationsExcluded

public void setNumZMissingCombinationsExcluded(int numZMissingCombinationsExcluded)

Internal use only.

Parameters:

numZMissingCombinationsExcluded - the new num Z missing combinations excluded

getNumZMissingCombinationsExcluded

public int getNumZMissingCombinationsExcluded()

Internal use only.

Returns:

the num Z missing combinations excluded

getTotZMissingCombinations

public int getTotZMissingCombinations()

Internal use only.

Returns:

the tot Z missing combinations

setTotZMissingCombinations

public void setTotZMissingCombinations(int totZMissingCombinations)

Internal use only.

Parameters:

totZMissingCombinations - the new tot Z missing combinations

getCellColumnIndentation

public int getCellColumnIndentation(Cell cell)

Returns the number of top-vertically cell headers. For UI indentation purposes.

Parameters:

cell - the cell

Returns:

the cell column indentation

getCellHeader

public CellHeader getCellHeader(XBRLTableResource node)

Find a table resource node in all the axis and returns the CellHeader where that node is linked with.

Parameters:

node - the node

Returns:

the cell header

getCellRowIndentation

public int getCellRowIndentation(Cell cell)

Returns the number of left-horizontally cell headers. For UI indentation purposes.

Parameters:

cell - the cell

Returns:

the cell row indentation

getCellAxis

public Axis getCellAxis(XBRLTableResource node)

Gets the cell axis.

Parameters:

node - the node

Returns:

the cell axis