com.ihr.xbrl.om.table.layout

Class CellHeader

java.lang.Object

com.ihr.xbrl.om.table.layout.CellHeader

Direct Known Subclasses:

OpenCellHeader

public class CellHeader
extends java.lang.Object

The Class CellHeader.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static CellHeader	blankCellHeader The blank cell header.

Constructor Summary

Constructors

Constructor and Description
CellHeader(Group group, XBRLStructuralNode nu, CellHeader parent, OpenCellHeader openCellParent, EffectiveBreakdown effectiveBreakdown, int openNodeValueIndex) Instantiates a new cell header.

Method Summary

Modifier and Type	Method and Description
void	addChildren(CellHeader cellHeader) Adds the children.
static java.lang.String	buildLabel(CellHeader root, CellHeader header) Creates a combined label concatenating labels from root CellHeader to the indicated CellHeader.
static java.util.List<java.lang.String>	buildLabelParts(CellHeader root, CellHeader header) Builds the label parts.
void	clear() Clear.
CellHeader	findAspect(Aspect<?> aspect, java.util.Map<CellHeader,java.util.Map<java.lang.Object,Aspect<?>>> byAspectCell) Find aspect.
AspectsConsolidator	getAccessConsolidator() Gets the access consolidator.
java.util.Iterator<AspectAndDistanceToLeaf>	getAspects(java.lang.String tag) Returns the consolidated aspects from this cell header and up to the first cell header.
java.util.Collection<CellHeader>	getChildren() Gets the children.
int	getColNumber() Access to the absolute column number after dealing with horizontal span and cells in the left of this cell.
int	getDistanceToLeaf() Gets the distance to leaf.
Group	getGroup() Gets the group.
int	getIndexNumber() For open nodes, this is a relative number starting from 0 that indicates this column index relaive to the parent.
java.lang.String	getLabel() Returns a proper label for the cell based on the cell type and the aspects linked with this cell along with the parameters set in the DTS such as preferred languages.
CellHeader	getNextSibling() Returns the next cell header that is sibling of this cell header.
OpenCellHeader	getOpenCellHeader() If this cell is child of an open cell header, this method returns the open cell header cell.
int	getOpenCellsCountInSpan() Return the number of cells in a span that are open cells.
CellHeader	getParent() Gets the parent.
CellHeader	getRoot() Obtains the root node of the cell header.
int	getRowNumber() Access to the absolute row number after dealing with vertical in previous cells.
int	getSpan() Gets the span.
XBRLStructuralNode	getTableStructuralNode() Gets the table structural node.
java.util.Set<java.lang.String>	getTagSelector() Gets the tag selector.
int	getUse() Returns a proper value for the fact use in respect to time.
boolean	hasRollUp() this method returns true if this cell has a descendant roll up cell.
boolean	isAsClosed() RS Extension to access the surrounding node and see if openAspect nodes shall be considered closed.
boolean	isConceptAbstract() Returns true if the surrounding element in the structural node comes from an item that is abstract.
boolean	isLeaf() Checks if is leaf.
boolean	isNegated() Checks if is negated.
boolean	isNet() Checks if is net.
boolean	isOpen() Returns true when this cell header represents an open node.
boolean	isRollUp() Checks if is roll up.
boolean	isRollUpPositionLeft() Returns true if this cell has a roll up cell on the left.
boolean	isRollUpPositionRight() Returns true if this cell has a roll up cell on the right.
boolean	isTitle() A cell is title when it contains children in a group that is not the group of this cell.
boolean	isTotal() Checks if is total.
boolean	isUsable() Returns true if the surrounding element in the structural node provides a new row or column with values that will be reported.
void	resetDistanceToLeaf() Reset distance to lead for all aspects.
int	setRowColumnNumber(int rowNumber, int columnNumber) Sets the row column number.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

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

Field Detail

blankCellHeader

public static CellHeader blankCellHeader

The blank cell header.

Constructor Detail

CellHeader

public CellHeader(Group group,
                  XBRLStructuralNode nu,
                  CellHeader parent,
                  OpenCellHeader openCellParent,
                  EffectiveBreakdown effectiveBreakdown,
                  int openNodeValueIndex)

Instantiates a new cell header.

Parameters:

group - the group this cell belongs to

nu - the structural node this cell is derived from

parent - the parent cell header up in the hierarchy

openCellParent - if this node is part of an open breakdown, this is the OpenCellHeader that is the parent of this CellHeader

effectiveBreakdown - the effective breakdown

openNodeValueIndex - if the CellHeader comes from an open structural node, this is the index of the value to be used for this column

Method Detail

getRowNumber

public int getRowNumber()

Access to the absolute row number after dealing with vertical in previous cells. This might be a virtual cell in some cases.

Returns:

the rowNumber

getColNumber

public int getColNumber()

Access to the absolute column number after dealing with horizontal span and cells in the left of this cell.

Returns:

the colNumber

getIndexNumber

public int getIndexNumber()

For open nodes, this is a relative number starting from 0 that indicates this column index relaive to the parent. It is used to serve as an index in a matrix

Returns:

relative

getTableStructuralNode

public XBRLStructuralNode getTableStructuralNode()

Gets the table structural node.

Returns:

the Definition node Use

getParent

public CellHeader getParent()

Gets the parent.

Returns:

the parent

getGroup

public Group getGroup()

Gets the group.

Returns:

the group

getRoot

public CellHeader getRoot()

Obtains the root node of the cell header.

Returns:

CellHeader

isLeaf

public boolean isLeaf()

Checks if is leaf.

Returns:

true, if is leaf

addChildren

public void addChildren(CellHeader cellHeader)

Adds the children.

Parameters:

cellHeader - the cell header

getSpan

public int getSpan()

Gets the span.

Returns:

the span

getOpenCellsCountInSpan

public int getOpenCellsCountInSpan()

Return the number of cells in a span that are open cells.
This method is used to adjust the conformance suite model output because our API allows to create cells in the GUI and that expands the span by one

Returns:

the open cells count in span

getOpenCellHeader

public OpenCellHeader getOpenCellHeader()

If this cell is child of an open cell header, this method returns the open cell header cell.

Returns:

the open cell header

getChildren

public java.util.Collection<CellHeader> getChildren()

Gets the children.

Returns:

the children

setRowColumnNumber

public int setRowColumnNumber(int rowNumber,
                              int columnNumber)

Sets the row column number.

Parameters:

rowNumber - the row number

columnNumber - the column number

Returns:

the int

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

getTagSelector

public java.util.Set<java.lang.String> getTagSelector()

Gets the tag selector.

Returns:

the tag selector

findAspect

public CellHeader findAspect(Aspect<?> aspect,
                             java.util.Map<CellHeader,java.util.Map<java.lang.Object,Aspect<?>>> byAspectCell)

Find aspect.

Parameters:

aspect - the aspect

byAspectCell - (optional) if not null, this hashtable will be set so the cell header can be used to locate the aspect later

Returns:

the cell header

getAspects

public java.util.Iterator<AspectAndDistanceToLeaf> getAspects(java.lang.String tag)

Returns the consolidated aspects from this cell header and up to the first cell header.

Parameters:

tag - the tag

Returns:

the aspects

isRollUp

public boolean isRollUp()

Checks if is roll up.

Returns:

true, if is roll up

getLabel

public java.lang.String getLabel()

Returns a proper label for the cell based on the cell type and the aspects linked with this cell along with the parameters set in the DTS such as preferred languages.

Returns:

the label

getNextSibling

public CellHeader getNextSibling()

Returns the next cell header that is sibling of this cell header.

Returns:

the next sibling

getUse

public int getUse()

Returns a proper value for the fact use in respect to time. this is a constant to indicate END, BEGGINING or NORMAL

Returns:

the use

isTitle

public boolean isTitle()

A cell is title when it contains children in a group that is not the group of this cell.

Returns:

true, if is title

isOpen

public boolean isOpen()

Returns true when this cell header represents an open node.

Returns:

true, if is open

hasRollUp

public boolean hasRollUp()

this method returns true if this cell has a descendant roll up cell.

Returns:

true, if successful

isRollUpPositionLeft

public boolean isRollUpPositionLeft()

Returns true if this cell has a roll up cell on the left.

Returns:

true, if is roll up position left

isRollUpPositionRight

public boolean isRollUpPositionRight()

Returns true if this cell has a roll up cell on the right.

Returns:

true, if is roll up position right

buildLabel

public static java.lang.String buildLabel(CellHeader root,
                                          CellHeader header)

Creates a combined label concatenating labels from root CellHeader to the indicated CellHeader.

Parameters:

root - the root

header - the axis header

Returns:

the string

buildLabelParts

public static java.util.List<java.lang.String> buildLabelParts(CellHeader root,
                                                               CellHeader header)

Builds the label parts.

Parameters:

root - the root

header - the header

Returns:

the array list

clear

public void clear()

Clear.

getAccessConsolidator

public AspectsConsolidator getAccessConsolidator()

Gets the access consolidator.

Returns:

the access consolidator

getDistanceToLeaf

public int getDistanceToLeaf()

Gets the distance to leaf.

Returns:

the distance to leaf

resetDistanceToLeaf

public void resetDistanceToLeaf()

Reset distance to lead for all aspects.

isTotal

public boolean isTotal()

Checks if is total.

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Returns:

true, if is negated

isConceptAbstract

public boolean isConceptAbstract()

Returns true if the surrounding element in the structural node comes from an item that is abstract.

Note, dimension members that are abstract returns true but they might provide a column in a table representation.

Returns:

true, if is concept abstract

See Also:

isUsable()

isUsable

public boolean isUsable()

Returns true if the surrounding element in the structural node provides a new row or column with values that will be reported.

If the surrounding member is a primary item usability is resolved using the abstract attribute.

if the surrounding member is a dimension member. usability is resolved as true.

Returns:

true, if is usable

isAsClosed

public boolean isAsClosed()

RS Extension to access the surrounding node and see if openAspect nodes shall be considered closed.

Returns:

true, if is as closed