com.ihr.xbrl.om.table.definition

Class XBRLDefinitionNode

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLResource

com.ihr.xbrl.om.table.XBRLTableResource

com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, HasBreakdownTree, HasParentChildAttribute, HasTableProcessor, XBRLValidation, XBRLValueKey, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

Direct Known Subclasses:

XBRLClosedDefinitionNode, XBRLOpenDefinitionNode

public abstract class XBRLDefinitionNode
extends XBRLTableResource
implements HasBreakdownTree, HasParentChildAttribute

The Class XBRLDefinitionNode.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.table.HasParentChildAttribute

HasParentChildAttribute.ParentChildEnum

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	tagSelector This is the attribute name "tagSelector" represented as a QName.

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

log, nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

Fields inherited from class com.ihr.xbrl.om.XMLFragment

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface com.ihr.xbrl.om.table.HasParentChildAttribute

parentChilOrder

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLDefinitionNode(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Instantiates a new XBRL definition node.

Method Summary

Modifier and Type	Method and Description
abstract boolean	allowRollUps() Some nodes does not allow the creation of roll-up nodes. such as the aspect node.
java.util.Iterator<XBRLDefinitionNodeUse>	getBreakdownTree() Gets the breakdown tree.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
int	getNumberOfNodes() Gets the number of nodes.
HasParentChildAttribute.ParentChildEnum	getParentChildOrder() Gets the parent child order.
java.lang.String	getTagSelector() returns the value of the tagSelector attribute on this definition node if the tagSelector attribute is not present this method returns XBRLRuleNode.UNTAGGED_TAG_NAME which is a constant defined for no tag defined
boolean	hasChildNodes()
boolean	hasOpen() Checks for open.
abstract boolean	isAbstract() Returns true if this is a closed definition node and is abstract.
abstract boolean	isAsClosed() RS Extension to the Table Standard.
boolean	isLeaf() Checks if is leaf.
boolean	isOpen() Checks if is open.
boolean	isParentChildOrderDefined() Checks if is parent child order defined.
void	readDefinitionNodeSubTree() Read definition node sub tree.
void	resetTable() This method traverse all elements in the definition layer and cleans up all evaluated and cached resources so the table can be evaluated again. it is called by the API automatically each time a table in the tableSet is evaluated

Methods inherited from class com.ihr.xbrl.om.table.XBRLTableResource

getFPXPathCompiler, getProcessor, getXPath, isSpecificationVersion

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clear, clone, clone, equals, generateNode, getAttributes, getCode, getDTSBase, getFriendlyName, getFriendlyName, getFriendlyName, getParentXBRL, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isHashDependsOnAtribute, isOnValidation, isSimpleType, setCode, setComplexType, setDTSBase, setId, setRawParentXBRL, setRole, setRoleType, setSimpleType, setValue, validate

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

tagSelector

public static final javax.xml.namespace.QName tagSelector

This is the attribute name "tagSelector" represented as a QName.

Constructor Detail

XBRLDefinitionNode

public XBRLDefinitionNode(XBRLTableProcessor xbrlTableProcessor,
                          XBRLResource res)
                   throws XTValidationException

Instantiates a new XBRL definition node.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Throws:

XTValidationException - the XT validation exception

Method Detail

readDefinitionNodeSubTree

public void readDefinitionNodeSubTree()

Read definition node sub tree.

getBreakdownTree

public java.util.Iterator<XBRLDefinitionNodeUse> getBreakdownTree()

Gets the breakdown tree.

Specified by:

getBreakdownTree in interface HasBreakdownTree

Returns:

the vBreakdownTree

isLeaf

public boolean isLeaf()

Checks if is leaf.

Specified by:

isLeaf in interface HasBreakdownTree

Returns:

true, if is leaf

See Also:

HasBreakdownTree.getBreakdownTree()

getNumberOfNodes

public int getNumberOfNodes()

Gets the number of nodes.

Specified by:

getNumberOfNodes in interface HasBreakdownTree

Returns:

the number of nodes

hasOpen

public boolean hasOpen()

Checks for open.

Specified by:

hasOpen in interface HasBreakdownTree

Returns:

true, if successful

isOpen

public boolean isOpen()

Checks if is open.

Specified by:

isOpen in interface HasBreakdownTree

Returns:

true, if is open

getTagSelector

public java.lang.String getTagSelector()

returns the value of the tagSelector attribute on this definition node if the tagSelector attribute is not present this method returns XBRLRuleNode.UNTAGGED_TAG_NAME which is a constant defined for no tag defined

Returns:

XBRLRuleNode.UNTAGGED_TAG_NAME if no tagSelector attribute exists. The value of the tagSelector attribute if any exists

isParentChildOrderDefined

public boolean isParentChildOrderDefined()

Checks if is parent child order defined.

Specified by:

isParentChildOrderDefined in interface HasParentChildAttribute

Returns:

true, if is parent child order defined

getParentChildOrder

public HasParentChildAttribute.ParentChildEnum getParentChildOrder()

Gets the parent child order.

Specified by:

getParentChildOrder in interface HasParentChildAttribute

Returns:

the parent child order

isAsClosed

public abstract boolean isAsClosed()

RS Extension to the Table Standard. Open definition nodes can be considered closed in order to disallow the user to enter values when an RSTableOpenFilter is used to limit the available values

Returns:

true, if is as closed

isAbstract

public abstract boolean isAbstract()

Returns true if this is a closed definition node and is abstract.

Returns:

boolean value

allowRollUps

public abstract boolean allowRollUps()

Some nodes does not allow the creation of roll-up nodes. such as the aspect node. Others do allow.

Returns:

true, if successful

resetTable

public void resetTable()

This method traverse all elements in the definition layer and cleans up all evaluated and cached resources so the table can be evaluated again. it is called by the API automatically each time a table in the tableSet is evaluated

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl