com.ihr.xbrl.om

Class XBRLDocumentRootNode

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.XBRLDocumentRootNode

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, 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:

MapperRootNode, XBRLInstanceRootNode, XBRLLinkbaseRootNode, XBRLTaxonomyRootNode

public abstract class XBRLDocumentRootNode
extends XMLFragment

This interface is implemented by objects that are the root nodes of an XBRLDocument. This is actually three types of nodes the root of an XBRLInstance (xbrli:xbrl), the root of a linkbase (link:linkbase) or the root of a schema (xs:schema). This node is also an XMLFragment

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>

Field Summary

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 net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLDocumentRootNode(DTSContainer dts, javax.xml.namespace.QName nodename) Instantiates a new XBRL document root node.

Method Summary

Modifier and Type	Method and Description
boolean	addExtendedLink(XBRLExtendedLink newExtendedLink) Adds the extended link.
void	changeExtendedLink(XBRLExtendedLink linkOld, XBRLExtendedLink linkNew) Change extended link key.
void	checkRoleType(XBRLRoleType roleType, java.net.URI txURI) Check role type.
void	clear() Clear.
XBRLDocumentRootNode	generateNode() Generate node.
java.net.URI	getContainerDocumentURI() Returns the document URI from the surrounding root document.
java.util.Iterator<XBRLExtendedLink>	getExtendedLinks() Returns an iterator over all extended links on this container.The container may be an XBRLInstance, an XBRLTaxonomy or an XBRLLinkbase.
java.util.Iterator<XBRLExtendedLink>	getExtendedLinks(XBRLRoleType role) Returns an iterator over all extended links on this container filtered by the specific role type indicated in the role parameter.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLDocument	getRootDocument() Gets the root document.
boolean	hasChildNodes()
void	removeExtendedLink(XBRLExtendedLink link) Removes the extended link.
void	removeExtendedLinks() Removes the extended links.
void	setExtendedLinks(java.util.LinkedHashSet<XBRLExtendedLink> extendedLinks) The SAX parser calls this method to set collected extended links on the parent document and speed up DTS loading.
void	setRootDocument(XBRLDocument rootDocument) Sets the root document.

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, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, clone, clone, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equals, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFriendlyName, getFriendlyName, getFriendlyName, 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, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, hashCode, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isHashDependsOnAtribute, 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, setId, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, 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

XBRLDocumentRootNode

public XBRLDocumentRootNode(DTSContainer dts,
                            javax.xml.namespace.QName nodename)

Instantiates a new XBRL document root node.

Parameters:

dts - the dts

nodename - the nodename

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

getExtendedLinks

public java.util.Iterator<XBRLExtendedLink> getExtendedLinks()

Returns an iterator over all extended links on this container.The container may be an XBRLInstance, an XBRLTaxonomy or an XBRLLinkbase.

Returns:

Iterator<XBRLExtendedLink> instance

getExtendedLinks

public java.util.Iterator<XBRLExtendedLink> getExtendedLinks(XBRLRoleType role)

Returns an iterator over all extended links on this container filtered by the specific role type indicated in the role parameter. If the container may be an XBRLInstance, an XBRLTaxonomy or an XBRLLinkbase.

Parameters:

role - the XBRLRoleType for filtering

Returns:

Iterator<XBRLExtendedLink> instance

changeExtendedLink

public void changeExtendedLink(XBRLExtendedLink linkOld,
                               XBRLExtendedLink linkNew)

Change extended link key.

Parameters:

linkOld - the link old

linkNew - the link new

checkRoleType

public void checkRoleType(XBRLRoleType roleType,
                          java.net.URI txURI)
                   throws DTSDiscoveryException

Check role type.

Parameters:

roleType - the role type

txURI - the tx uri

Throws:

DTSDiscoveryException - the DTS discovery exception

addExtendedLink

public boolean addExtendedLink(XBRLExtendedLink newExtendedLink)

Adds the extended link.

Parameters:

newExtendedLink - the new extended link

Returns:

true, if successful

removeExtendedLink

public void removeExtendedLink(XBRLExtendedLink link)

Removes the extended link.

Parameters:

link - the link

setExtendedLinks

public void setExtendedLinks(java.util.LinkedHashSet<XBRLExtendedLink> extendedLinks)

The SAX parser calls this method to set collected extended links on the parent document and speed up DTS loading.

Parameters:

extendedLinks - the new extended links

getRootDocument

public XBRLDocument getRootDocument()

Gets the root document.

Returns:

the rootDocument

setRootDocument

public void setRootDocument(XBRLDocument rootDocument)

Sets the root document.

Parameters:

rootDocument - the rootDocument to set

generateNode

public final XBRLDocumentRootNode generateNode()
                                        throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XBRL document root node

Throws:

XBRLSerializationException - the XBRL serialization exception

getContainerDocumentURI

public java.net.URI getContainerDocumentURI()

Returns the document URI from the surrounding root document.

Overrides:

getContainerDocumentURI in class XMLFragment

Returns:

absolute document URI

removeExtendedLinks

public void removeExtendedLinks()

Removes the extended links.

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