com.ihr.xbrl.om.table.definition

Class XBRLRelationshipNode

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

com.ihr.xbrl.om.table.definition.XBRLClosedDefinitionNode

com.ihr.xbrl.om.table.definition.XBRLRelationshipNode

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, HasBreakdownTree, HasParentChildAttribute, HasTableProcessor, StaticCheck, 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:

XBRLConceptRelationshipNode, XBRLDimensionRelationshipNode

public abstract class XBRLRelationshipNode
extends XBRLClosedDefinitionNode
implements StaticCheck

The Class XBRLRelationshipNode.

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 inherited from class com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

tagSelector

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
XBRLRelationshipNode(XBRLTableProcessor xbrlTableProcessor, XBRLResource res) Instantiates a new XBRL relationship node.

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFormulaAxis(XBRLStructuralTable xbrlTable) Access to the resolved value for the formula axis.
abstract int	getGenerations(XBRLStructuralTable xbrlTable, RC_XFI_concept_relationshipsBase.Axis axis) Access to the resolved generations parameter
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
java.lang.String	getLinkrole(XBRLStructuralTable xbrlTable) Access to the resolved linkrole .
int	getNumberOfChildren()
abstract javax.xml.namespace.QName[]	getSources(XBRLStructuralTable xbrlTable) Access to the resolved QName sources.
boolean	hasChildNodes()
abstract XBRLStructuralNode[]	readDefinitionNodeSubTree(XBRLDefinitionNodeUse dnu, XBRLStructuralTable xbrlTable, java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects, java.lang.String mergeTagSelectors, HasParentChildAttribute.ParentChildEnum parentChild) This method is called while building the structural table instance.
void	staticCheck() Static check.

Methods inherited from class com.ihr.xbrl.om.table.definition.XBRLClosedDefinitionNode

allowRollUps, getParentChildOrder, isAsClosed, isParentChildOrderDefined

Methods inherited from class com.ihr.xbrl.om.table.definition.XBRLDefinitionNode

getBreakdownTree, getNumberOfNodes, getTagSelector, hasOpen, isAbstract, isLeaf, isOpen, readDefinitionNodeSubTree, resetTable

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

Constructor Detail

XBRLRelationshipNode

public XBRLRelationshipNode(XBRLTableProcessor xbrlTableProcessor,
                            XBRLResource res)
                     throws XTValidationException

Instantiates a new XBRL relationship node.

Parameters:

xbrlTableProcessor - the xbrl table processor

res - the res

Throws:

XTValidationException - the XT validation exception

Method Detail

getSources

public abstract javax.xml.namespace.QName[] getSources(XBRLStructuralTable xbrlTable)
                                                throws XTValidationException

Access to the resolved QName sources.

Parameters:

xbrlTable - the xbrl table

Returns:

the sources

Throws:

XTValidationException - the XT validation exception

getLinkrole

public java.lang.String getLinkrole(XBRLStructuralTable xbrlTable)
                             throws XTValidationException

Access to the resolved linkrole .

Parameters:

xbrlTable - the xbrl table

Returns:

the linkrole

Throws:

XTValidationException - the XT validation exception

getFormulaAxis

public java.lang.String getFormulaAxis(XBRLStructuralTable xbrlTable)
                                throws XTValidationException

Access to the resolved value for the formula axis.

Parameters:

xbrlTable - the xbrl table

Returns:

the formula axis

Throws:

XTValidationException - the XT validation exception

getGenerations

public abstract int getGenerations(XBRLStructuralTable xbrlTable,
                                   RC_XFI_concept_relationshipsBase.Axis axis)
                            throws XTValidationException

Access to the resolved generations parameter

Parameters:

xbrlTable - the xbrl table

axis - the axis

Returns:

the generations

Throws:

XTValidationException - the XT validation exception

staticCheck

public void staticCheck()
                 throws XTValidationException,
                        XFValidationException

Static check.

Specified by:

staticCheck in interface StaticCheck

Throws:

XTValidationException - the XT validation exception

XFValidationException - the XF validation exception

readDefinitionNodeSubTree

public abstract XBRLStructuralNode[] readDefinitionNodeSubTree(XBRLDefinitionNodeUse dnu,
                                                               XBRLStructuralTable xbrlTable,
                                                               java.util.Map<java.lang.String,java.util.Map<java.lang.Object,AspectAndDistanceToLeaf>> mergeAspects,
                                                               java.lang.String mergeTagSelectors,
                                                               HasParentChildAttribute.ParentChildEnum parentChild)
                                                        throws XTValidationException

This method is called while building the structural table instance. It is required to process all incoming parameters and read the network.

Parameters:

dnu - the dnu

xbrlTable - the xbrl table

mergeAspects - the merge aspects

mergeTagSelectors - the merge tag selectors

parentChild - the parent child

Returns:

the XBRL structural node[]

Throws:

XTValidationException - the XT validation exception

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