com.ihr.xbrl.om.table.structural

Class XBRLClosedStructuralNode

java.lang.Object

com.ihr.xbrl.om.table.structural.XBRLStructuralNode

com.ihr.xbrl.om.table.structural.XBRLClosedStructuralNode

All Implemented Interfaces:

StructuralNodeInterface

public class XBRLClosedStructuralNode
extends XBRLStructuralNode

The Class XBRLClosedStructuralNode.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLClosedStructuralNode(XBRLStructuralTable xTable, XBRLDefinitionNodeUse base, XBRLStructuralNode parent, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors, HasParentChildAttribute.ParentChildEnum parentChildValue) Instantiates a new XBRL closed structural node.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel(CellHeader cell) Gets the label.
int	getUse(CellHeader cell) Gets the use.
int	getValueCount() Gets the value count.
boolean	isAbstract() Checks if is abstract.
boolean	isConceptAbstract() Checks if is concept abstract.
boolean	isNegated() Checks if is negated.
boolean	isNet() Checks if is net.
boolean	isRollUp() this is set to true when this structural node is a roll-up node.
boolean	isTotal() Checks if is total.
boolean	isUsable() Checks if is usable.
java.lang.String	toString() To string.

Methods inherited from class com.ihr.xbrl.om.table.structural.XBRLStructuralNode

addChild, clear, create, create, createRollup, getAspects, getAspectsConsolidator, getBase, getConsolidatedAspects, getMergeTagSelector, getNodeAt, getNodeCount, getNodes, getParent, getTags, getTagSelector, isAsClosed, isLeaf, resetMergeTagSelector

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLClosedStructuralNode

public XBRLClosedStructuralNode(XBRLStructuralTable xTable,
                                XBRLDefinitionNodeUse base,
                                XBRLStructuralNode parent,
                                java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects,
                                java.lang.String mergeTagSelectors,
                                HasParentChildAttribute.ParentChildEnum parentChildValue)

Instantiates a new XBRL closed structural node.

Parameters:

xTable - the x table

base - the base

parent - the parent

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

parentChildValue - the parent child value

Method Detail

isRollUp

public boolean isRollUp()

this is set to true when this structural node is a roll-up node. roll-up nodes are either the first or the last child of its parent roll-up contributes no additional constraints

Overrides:

isRollUp in class XBRLStructuralNode

Returns:

true if this is a roll-up node.

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in class XBRLStructuralNode

Returns:

true, if is abstract

getValueCount

public int getValueCount()

Gets the value count.

Specified by:

getValueCount in class XBRLStructuralNode

Returns:

the value count

toString

public java.lang.String toString()

To string.

Overrides:

toString in class XBRLStructuralNode

Returns:

the string

getLabel

public java.lang.String getLabel(CellHeader cell)

Gets the label.

Specified by:

getLabel in class XBRLStructuralNode

Parameters:

cell - the cell

Returns:

the label

getUse

public int getUse(CellHeader cell)

Gets the use.

Specified by:

getUse in class XBRLStructuralNode

Parameters:

cell - the cell

Returns:

the use

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in class XBRLStructuralNode

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in class XBRLStructuralNode

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in class XBRLStructuralNode

Returns:

true, if is negated

isConceptAbstract

public boolean isConceptAbstract()

Checks if is concept abstract.

Specified by:

isConceptAbstract in class XBRLStructuralNode

Returns:

true, if is concept abstract

isUsable

public boolean isUsable()

Checks if is usable.

Specified by:

isUsable in class XBRLStructuralNode

Returns:

true, if is usable