com.ihr.xbrl.om.table.structural

Class XBRLStructuralNode

java.lang.Object

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

All Implemented Interfaces:

StructuralNodeInterface

Direct Known Subclasses:

XBRLClosedRelationshipStructuralNode, XBRLClosedStructuralNode, XBRLOpenStructuralNode

public abstract class XBRLStructuralNode
extends java.lang.Object
implements StructuralNodeInterface

This is the implementation class for the StructuralNodeInterface interface. Every element in a table header is represented with an instance of this class

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLStructuralNode(XBRLDefinitionNodeUse base, XBRLStructuralNode parent, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors) Creates an instance of a TableStructuralNode and collects all aspects indicated in the definition node indicated in the base parameter.

Method Summary

Modifier and Type	Method and Description
boolean	addChild(XBRLStructuralNode child) Append a new children to this tree node.
void	clear() Clear.
static XBRLStructuralNode[]	create(XBRLDefinitionNodeUse dnu, XBRLStructuralNode parent, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors, XBRLStructuralTable xbrlTable, HasParentChildAttribute.ParentChildEnum parentChildValue) Factory method to create either an open structural node or a closed structural node depending on the definition node.
static XBRLStructuralNode	create(XBRLDefinitionNodeUse dnu, XBRLStructuralNode parent, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors, XBRLStructuralTable xbrlTable, RelationshipGraphNode.Node<?> node) Creates the.
static XBRLStructuralNode	createRollup(XBRLStructuralTable xTable, XBRLStructuralNode parent, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors, HasParentChildAttribute.ParentChildEnum parentChildValue) Factory method to create a roll-up structural node.
java.util.Iterator<AspectAndDistanceToLeaf>	getAspects(java.lang.String tag) Allows to iterate all aspects on this node.
AspectsConsolidator	getAspectsConsolidator() Gets the aspects consolidator.
XBRLDefinitionNodeUse	getBase() Access to the XBRLDefinitionNodeUse element that is the source of this TableStructuralNode.
java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>>	getConsolidatedAspects() Gets the consolidated aspects.
abstract java.lang.String	getLabel(CellHeader cell) Returns a label that represents the structural node.
java.lang.String	getMergeTagSelector() Gets the merge tag selector.
XBRLStructuralNode	getNodeAt(int index) Gets the node at.
int	getNodeCount() Gets the node count.
java.util.Iterator<XBRLStructuralNode>	getNodes() Gets the nodes.
XBRLStructuralNode	getParent() Gets the parent.
java.util.Iterator<java.lang.String>	getTags() Gets the tags.
java.util.HashSet<java.lang.String>	getTagSelector() if a tag selector exists in the surrounding definition node.
abstract int	getUse(CellHeader cell) RS Extension, returns the right value from FactUseItem to indicate FactUseItem.BEGINNING, FactUseItem.END or FactUse.NORMAL.
abstract int	getValueCount() Returns the number of nodes for this structural node at this level (does not count children nodes) For closed nodes, the returned value is most likely 1.
abstract boolean	isAbstract() Returns true if this is a rule node and it is marked as abstract.
boolean	isAsClosed() RS Extension to turn closed an open node.
abstract boolean	isConceptAbstract() Used in the GUI, returns true if the concept is abstract.
boolean	isLeaf() Checks if is leaf.
abstract boolean	isNegated() Used in the GUI, returns true if the label matches a concept label for any of the negated roles.
abstract boolean	isNet() Used in the GUI, returns true if the label matches a concept label for any of the net roles.
boolean	isRollUp() Returns true if this structural node is a roll-up node.
abstract boolean	isTotal() Used in the GUI, returns true if the label matches a concept label for any of the total roles.
abstract boolean	isUsable() Used in the GUI, returns true when the concept is a non abstract primary item or the dimension member is usable=true.
void	resetMergeTagSelector() Reset merge tag selector.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLStructuralNode

public XBRLStructuralNode(XBRLDefinitionNodeUse base,
                          XBRLStructuralNode parent,
                          java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects,
                          java.lang.String mergeTagSelectors)

Creates an instance of a TableStructuralNode and collects all aspects indicated in the definition node indicated in the base parameter.

Parameters:

base - the XBRLDefinitionNodeUse that is the source of this TableStructuralNode

parent - the parent TableStructuralNode to allow navigation up on the tree. This is null for root nodes

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

Method Detail

getConsolidatedAspects

public java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> getConsolidatedAspects()

Gets the consolidated aspects.

Returns:

the consolidated aspects

getTags

public java.util.Iterator<java.lang.String> getTags()

Gets the tags.

Returns:

the tags

getAspects

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

Allows to iterate all aspects on this node. If no aspects are defined this returns an empty iterator

Parameters:

tag - the tag

Returns:

Iterator on all aspects

getParent

public XBRLStructuralNode getParent()

Gets the parent.

Specified by:

getParent in interface StructuralNodeInterface

Returns:

the parent

getBase

public XBRLDefinitionNodeUse getBase()

Access to the XBRLDefinitionNodeUse element that is the source of this TableStructuralNode. It is null if the node is not generated from a definition node, for example is roll up nodes.

Returns:

XBRLDefinitionNodeUse base XBRL Resource

addChild

public boolean addChild(XBRLStructuralNode child)

Append a new children to this tree node.

Parameters:

child - node to add at the end of the collection

Returns:

boolean if the node was added

isLeaf

public boolean isLeaf()

Checks if is leaf.

Specified by:

isLeaf in interface StructuralNodeInterface

Returns:

true, if is leaf

isRollUp

public boolean isRollUp()

Returns true if this structural node is a roll-up node.

Returns:

boolean value

getLabel

public abstract java.lang.String getLabel(CellHeader cell)

Returns a label that represents the structural node. This label will be used in the user interface so the label shall consider user preferences set in the DTSContainer. The cell parameter can provide required information to know the cell position or value index on open nodes

Parameters:

cell - the cell

Returns:

the label

getUse

public abstract int getUse(CellHeader cell)

RS Extension, returns the right value from FactUseItem to indicate FactUseItem.BEGINNING, FactUseItem.END or FactUse.NORMAL.

Parameters:

cell - the cell

Returns:

the use

isAbstract

public abstract boolean isAbstract()

Returns true if this is a rule node and it is marked as abstract.

Returns:

boolean value

getNodes

public java.util.Iterator<XBRLStructuralNode> getNodes()

Gets the nodes.

Specified by:

getNodes in interface StructuralNodeInterface

Returns:

the nodes

getNodeAt

public XBRLStructuralNode getNodeAt(int index)

Gets the node at.

Specified by:

getNodeAt in interface StructuralNodeInterface

Parameters:

index - the index

Returns:

the node at

getNodeCount

public int getNodeCount()

Gets the node count.

Specified by:

getNodeCount in interface StructuralNodeInterface

Returns:

the node count

create

public static XBRLStructuralNode[] create(XBRLDefinitionNodeUse dnu,
                                          XBRLStructuralNode parent,
                                          java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects,
                                          java.lang.String mergeTagSelectors,
                                          XBRLStructuralTable xbrlTable,
                                          HasParentChildAttribute.ParentChildEnum parentChildValue)
                                   throws XTValidationException

Factory method to create either an open structural node or a closed structural node depending on the definition node.

Parameters:

dnu - definition node

parent - is the parent of this structural node or null for root nodes

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

xbrlTable - the xbrl table

parentChildValue - the parent child value

Returns:

the XBRL structural node[]

Throws:

XTValidationException - the XT validation exception

create

public static XBRLStructuralNode create(XBRLDefinitionNodeUse dnu,
                                        XBRLStructuralNode parent,
                                        java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects,
                                        java.lang.String mergeTagSelectors,
                                        XBRLStructuralTable xbrlTable,
                                        RelationshipGraphNode.Node<?> node)

Creates the.

Parameters:

dnu - the dnu

parent - the parent

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

xbrlTable - the xbrl table

node - the node

Returns:

the XBRL structural node

createRollup

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

Factory method to create a roll-up structural node.

Parameters:

xTable - the x table

parent - the parent

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

parentChildValue - the parent child value

Returns:

the XBRL structural node

getValueCount

public abstract int getValueCount()

Returns the number of nodes for this structural node at this level (does not count children nodes) For closed nodes, the returned value is most likely 1. There might be exceptions if the concept is abstract. In that case, the returned value might be 0 For open nodes, the returned value depends on the number of values that bind to the node definition and table filters

Returns:

the value count

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

getTagSelector

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

if a tag selector exists in the surrounding definition node. The value is added to the hashSet

Returns:

the tag selector

resetMergeTagSelector

public void resetMergeTagSelector()

Reset merge tag selector.

getMergeTagSelector

public java.lang.String getMergeTagSelector()

Gets the merge tag selector.

Returns:

the merge tag selector

clear

public void clear()

Clear.

Specified by:

clear in interface StructuralNodeInterface

getAspectsConsolidator

public AspectsConsolidator getAspectsConsolidator()

Gets the aspects consolidator.

Returns:

the aspects consolidator

isTotal

public abstract boolean isTotal()

Used in the GUI, returns true if the label matches a concept label for any of the total roles.

Returns:

true, if is total

isNet

public abstract boolean isNet()

Used in the GUI, returns true if the label matches a concept label for any of the net roles.

Returns:

true, if is net

isNegated

public abstract boolean isNegated()

Used in the GUI, returns true if the label matches a concept label for any of the negated roles.

Returns:

true, if is negated

isConceptAbstract

public abstract boolean isConceptAbstract()

Used in the GUI, returns true if the concept is abstract.

Returns:

true, if is concept abstract

isUsable

public abstract boolean isUsable()

Used in the GUI, returns true when the concept is a non abstract primary item or the dimension member is usable=true.

Returns:

true, if is usable

isAsClosed

public boolean isAsClosed()

RS Extension to turn closed an open node.

Returns:

true, if is as closed