XBRLInstanceRootNode

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
      - com.ihr.xbrl.om.instance.XBRLInstanceRootNode

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLFactsList, 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
```
public class XBRLInstanceRootNode
extends XBRLDocumentRootNode
implements XBRLFactsList
```
We have split the XBRLInstance class into the XBRLInstance derived from XBRLDocument and the XBRLInstance root node that is an XMLFragment.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`XBRLInstanceRootNode.ForEachContext` Class with method to be called for each context in the instance.
`static interface`	`XBRLInstanceRootNode.ForEachFact` Class with method to be called for each fact in the instance.
`static interface`	`XBRLInstanceRootNode.ForEachUnit` Class with method to be called for each unit in the instance.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(int index, XBRLFact fact)` Adds the.
`boolean`	`add(XBRLFact fact)` Adds the.
`void`	`addArcroleRef(XBRLArcroleRef newArcroleRef)` Adds the arcrole ref.
`void`	`addChild(XMLFragment newChild)` Adds the child.
`boolean`	`addContext(XBRLContext ctx)` Adds a new context to the instance document.
`void`	`addFootnoteLinkbase(FootnoteLinkbase newFootnoteLinkbase)` Adds a footnote linkbase.
`void`	`addLinkbaseRef(XBRLLinkbaseRef newLinkbaseRef)` Adds the linkbase ref.
`void`	`addRoleRef(XBRLRoleRef newRoleRef)` Adds the roleRef.
`void`	`addSchemaRef(XBRLSchemaRef newSchemaRef)` Adds the schema ref.
`boolean`	`addUnit(XBRLUnit unit)` Adds a unit to the XBRL report.
`void`	`addXBRLDocument(XBRLDocument doc, XBRLRoleAndArcroleTypes roleOrArcrole)` Attach a new XBRLDocument directly in the instance regardless it is already somewhere under the wood of the DTS.
`void`	`addXBRLDocumentIfNotInDTS(XBRLDocument doc, XBRLRoleAndArcroleTypes roleOrArcrole)` Attach a new XBRLDocument to the instance document using a linkbaseRef or schemaRef only if the document is not already in the set of documents that can be discovered from this instance document existing DTS entries.
`void`	`clear()` Clear.
`void`	`clearDTSReferences()` Removes all schemas, linkbases, roleRefs, arcroleRefs etc in the DTS of this instance document.
`XBRLInstanceRootNode`	`clone()` Clone.
`XBRLInstanceRootNode`	`clone(DTSContainer dts)` Clone.
`void`	`copyHistory(XBRLInstanceRootNode instanceRootNode)` Copy history.
`void`	`forEachContext(XBRLInstanceRootNode.ForEachContext lambda)` Locks the instance document and executes the `lambda` function on each one of the XBRLContexts in the instance
`void`	`forEachContextUnsafe(XBRLInstanceRootNode.ForEachContext lambda)` Executes the `lambda` function on each one of the XBRLContexts in the instance but does not lock the instance document for modifications.
`void`	`forEachFact(XBRLInstanceRootNode.ForEachFact lambda)` Locks the instance document and executes the `lambda` function on each one of the XBRLFacts in the instance
`void`	`forEachFactUnsafe(XBRLInstanceRootNode.ForEachFact lambda)` Executes the `lambda` function on each one of the XBRLFacts in the instance (at root level.
`void`	`forEachUnit(XBRLInstanceRootNode.ForEachUnit lambda)` Locks the instance document and executes the `lambda` function on each one of the XBRLUnits in the instance
`void`	`forEachUnitUnsafe(XBRLInstanceRootNode.ForEachUnit lambda)` Executes the `lambda` function on each one of the XBRLUnit in the instance but does not lock the instance document for modifications.
`XBRLInstanceRootNode`	`generateRootNode()` Generate root node.
`XBRLFact`	`get(int index)` Gets the.
`java.util.Iterator<XBRLArcroleRef>`	`getArcroleRefs()` Obtains an iterator over link:arcroleRef on this instance .
`XBRLContext`	`getContextById(java.lang.String id)` Obtains a context from the context limbo using the context id.
`XBRLContext`	`getContextCompatible(XBRLContext otherContext)` Returns an existing context that is c-equal to the context passed in as the parameter.
`java.util.Iterator<XBRLContext>`	`getContexts()` Access to all contexts in the XBRL Instance including contexts in the limbo (not in the instance but) in the scope of the instance.
`java.util.Iterator<java.net.URI>`	`getDTSs()` Obtains an iterator over the URIs of files that are in the DTS of this instance document.
`XBRLFact`	`getFact(net.sf.saxon.s9api.XdmNode factNode)` Deprecated.
`java.util.Iterator<XBRLFact>`	`getFacts()` This method is the same as `iterator()`.
`net.sf.saxon.tree.linked.NodeImpl`	`getFirstChild()`
`XBRLInstance`	`getInstance()` Gets the single instance of XBRLInstanceRootNode.
`java.util.Iterator<XBRLFactItem>`	`getItems()` Gets the items.
`java.util.Iterator<XBRLFactItem>`	`getItems(XBRLItem itemFrom)` Gets the items.
`java.util.Iterator<XBRLFactItem>`	`getItemsSg(XBRLItem itemFrom)` Gets the items sg.
`net.sf.saxon.tree.linked.NodeImpl`	`getLastChild()`
`java.util.Iterator<XBRLLinkbaseRef>`	`getLinkbaseRefs()` Obtains an iterator over link:linkbaseRef on this instance .
`int`	`getNumberOfChildren()`
`int`	`getNumberOfContexts()` Returns the number of contexts in this instance document.
`int`	`getNumberOfItems()` Gets the number of items.
`int`	`getNumberOfTuples()` Gets the number of tuples.
`int`	`getNumberOfUnits()` Returns the number of units in this instance document.
`XMLFragment`	`getParentXBRL()` Gets the parent XBRL.
`java.util.Iterator<XBRLRoleRef>`	`getRoleRefs()` Obtains an iterator over link:roleRef on this instance .
`java.util.Iterator<XBRLSchemaRef>`	`getSchemaRefs()` Obtains an iterator over link:schemaRef on this instance .
`java.util.Iterator<XBRLFactTuple>`	`getTuples()` Gets the tuples.
`java.util.Iterator<XBRLFactTuple>`	`getTuples(XBRLTuple tupleFrom)` Gets the tuples.
`java.util.Iterator<XBRLFactTuple>`	`getTuplesSg(XBRLTuple tupleFrom)` Gets the tuples sg.
`XBRLUnit`	`getUnitById(java.lang.String id)` Obtains an unit from the units limbo using the unit id.
`XBRLUnit`	`getUnitCompatible(XBRLUnit otherUnit)` Returns an existing unit that is u-equal to the unit passed in as the parameter.
`java.util.Iterator<XBRLUnit>`	`getUnits()` Access to all units in the XBRL Instance.
`java.util.Iterator<java.net.URI>`	`getXBRLDocuments(XBRLDocument.XBRLDocumentType type)` Returns an iterator over documents included in the DTS by this instance that are of the specified type.
`boolean`	`hasChildNodes()`
`int`	`hashCode()` Hash code.
`int`	`indexOf(XBRLFact fact)` Index of.
`int`	`indexOf(XBRLFact fact, int index)` Index of.
`java.util.Iterator<XBRLFact>`	`iterator()` Iterator.
`java.util.Iterator<XBRLFact>`	`iterator2()` Iterator 2.
`static XBRLInstanceRootNode`	`make(DTSContainer container)` Make.
`boolean`	`remove(java.util.Set<XBRLFact> facts)` Removes the.
`boolean`	`remove(XBRLFact fact)` Removes the.
`void`	`removeArcroleRef(XBRLArcroleRef arcroleRef)` Remove roleRef.
`void`	`removeChild(XMLFragment child)` Removes the child.
`boolean`	`removeContext(XBRLContext ctx)` Removes a context from the instance document.
`boolean`	`removeFact(XBRLFact fact)` Removes the fact from the node tree.
`boolean`	`removeFacts(java.util.Set<XBRLFact> facts)` Removes the set of facts from the node tree.
`void`	`removeFootnoteLinkbase(FootnoteLinkbase linkbase)` Removes the footnote linkbase.
`void`	`removeLinkbaseRef(XBRLLinkbaseRef linkbaseRef)` Remove linkbase ref.
`void`	`removeRoleRef(XBRLRoleRef roleRef)` Remove roleRef.
`void`	`removeSchemaRef(XBRLSchemaRef schemaRef)` Remove schema ref.
`boolean`	`removeUnit(XBRLUnit unit)` Removes an unit from the instance document.
`void`	`removeXBRLDocument(XBRLDocument doc)` Detach an XBRLDocument from the set of XBRLDocuments to include in this instance's DTS.
`void`	`setInstance(XBRLInstance instance)` Sets the instance.
`void`	`setOptimizations(boolean optimizations)` This flag sets how the process of generating the XML nodes will work either removing unused contexts or keeping all generated contexts there during a call to generateDocNode.
`void`	`setParent(XBRLFactsList parent)` Sets the parent.
`int`	`size()` Size.

Methods inherited from class com.ihr.xbrl.om.XBRLDocumentRootNode
addExtendedLink, changeExtendedLink, checkRoleType, generateNode, getContainerDocumentURI, getExtendedLinks, getExtendedLinks, getRootDocument, removeExtendedLink, removeExtendedLinks, setExtendedLinks, setRootDocument

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, 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, 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, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isHashDependsOnAtribute, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, 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
equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.om.instance.XBRLFactsList
equals, getContainer, getDocument, getXPath, getXPathToRoot

- Method Detail
  - make
```
public static XBRLInstanceRootNode make(DTSContainer container)
```
    Make.
    
    Parameters:
    
    container - the container
    
    Returns:
    
    the XBRL instance root node
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Specified by:
    
    hashCode in interface XBRLFactsList
    
    Specified by:
    
    hashCode in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    hashCode in class XMLFragment
    
    Returns:
    
    the int
  - add
```
public void add(int index,
                XBRLFact fact)
```
    Adds the.
    
    Specified by:
    
    add in interface XBRLFactsList
    
    Parameters:
    
    index - the index
    
    fact - the fact
  - add
```
public boolean add(XBRLFact fact)
```
    Adds the.
    
    Specified by:
    
    add in interface XBRLFactsList
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    true, if successful
  - addChild
```
public void addChild(XMLFragment newChild)
```
    Adds the child.
    
    Overrides:
    
    addChild in class XMLFragment
    
    Parameters:
    
    newChild - the new child
  - addArcroleRef
```
public void addArcroleRef(XBRLArcroleRef newArcroleRef)
```
    Adds the arcrole ref.
    
    Parameters:
    
    newArcroleRef - the new arcroleRef
  - addRoleRef
```
public void addRoleRef(XBRLRoleRef newRoleRef)
```
    Adds the roleRef.
    
    Parameters:
    
    newRoleRef - the new roleRef
  - removeArcroleRef
```
public void removeArcroleRef(XBRLArcroleRef arcroleRef)
```
    Remove roleRef.
    
    Parameters:
    
    arcroleRef - the arcrole ref
  - removeLinkbaseRef
```
public void removeLinkbaseRef(XBRLLinkbaseRef linkbaseRef)
```
    Remove linkbase ref.
    
    Parameters:
    
    linkbaseRef - the linkbase ref
  - removeFootnoteLinkbase
```
public void removeFootnoteLinkbase(FootnoteLinkbase linkbase)
```
    Removes the footnote linkbase.
    
    Parameters:
    
    linkbase - the linkbase
  - removeRoleRef
```
public void removeRoleRef(XBRLRoleRef roleRef)
```
    Remove roleRef.
    
    Parameters:
    
    roleRef - the roleRef
  - removeSchemaRef
```
public void removeSchemaRef(XBRLSchemaRef schemaRef)
```
    Remove schema ref.
    
    Parameters:
    
    schemaRef - the schema ref
  - addLinkbaseRef
```
public void addLinkbaseRef(XBRLLinkbaseRef newLinkbaseRef)
```
    Adds the linkbase ref.
    
    Parameters:
    
    newLinkbaseRef - the new linkbaseRef
  - addFootnoteLinkbase
```
public void addFootnoteLinkbase(FootnoteLinkbase newFootnoteLinkbase)
```
    Adds a footnote linkbase. Note, the API can create footnote linkbases automatically by adding fact-footnote relationships to facts
    
    Parameters:
    
    newFootnoteLinkbase - the new fotnote linkbase
  - addSchemaRef
```
public void addSchemaRef(XBRLSchemaRef newSchemaRef)
```
    Adds the schema ref.
    
    Parameters:
    
    newSchemaRef - the new schemaRef
  - addContext
```
public boolean addContext(XBRLContext ctx)
                   throws XBRLInconsistentDTSException
```
    Adds a new context to the instance document. Normally contexts are added automatically when a fact is added to a container. This method is here to add contexts to an instance document that are not associated to any fact. The method raises an XBRLInconsistentDTSException if the instance will have two contexts for the same ID This method does not compare the contexts for s_equality. Two s_equal contexts with different IDs may exist in an instance document.
    
    Parameters:
    
    ctx - the ctx
    
    Returns:
    
    true if the context is new false if the context already exists
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - getRoleRefs
```
public java.util.Iterator<XBRLRoleRef> getRoleRefs()
```
    Obtains an iterator over link:roleRef on this instance .
    
    Returns:
    
    the role refs
  - getSchemaRefs
```
public java.util.Iterator<XBRLSchemaRef> getSchemaRefs()
```
    Obtains an iterator over link:schemaRef on this instance .
    
    Returns:
    
    the schema refs
  - getLinkbaseRefs
```
public java.util.Iterator<XBRLLinkbaseRef> getLinkbaseRefs()
```
    Obtains an iterator over link:linkbaseRef on this instance .
    
    Returns:
    
    the linkbase refs
  - getArcroleRefs
```
public java.util.Iterator<XBRLArcroleRef> getArcroleRefs()
```
    Obtains an iterator over link:arcroleRef on this instance .
    
    Returns:
    
    the arcrole refs
  - addUnit
```
public boolean addUnit(XBRLUnit unit)
                throws XBRLInconsistentDTSException
```
    Adds a unit to the XBRL report. Units might not be serialized to the instance if they are not used by facts. Unused units are keep in the units limbo until they are used by facts
    
    Parameters:
    
    unit - the XBRLunit to be added
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - addXBRLDocument
```
public void addXBRLDocument(XBRLDocument doc,
                            XBRLRoleAndArcroleTypes roleOrArcrole)
```
    Attach a new XBRLDocument directly in the instance regardless it is already somewhere under the wood of the DTS. The document to be attached MUST have a URI
    
    Parameters:
    
    doc - the new XBRLTaxonomy or XBRLLinkbase to attach
    
    roleOrArcrole - XBRLRoleAndArcroleTypes can be null and is null for taxonomy and linkbase documents
    
    See Also:
    
    addXBRLDocumentIfNotInDTS(XBRLDocument, XBRLRoleAndArcroleTypes)
  - addXBRLDocumentIfNotInDTS
```
public void addXBRLDocumentIfNotInDTS(XBRLDocument doc,
                                      XBRLRoleAndArcroleTypes roleOrArcrole)
```
    Attach a new XBRLDocument to the instance document using a linkbaseRef or schemaRef only if the document is not already in the set of documents that can be discovered from this instance document existing DTS entries.
    The document to attach MUST have a URI. The roleOrArcrole parameter may be null and is null in if the doc parameter is a taxonomy schema.
    
    Parameters:
    
    doc - the new XBRLTaxonomy or XBRLLinkbase to attach
    
    roleOrArcrole - XBRLRoleAndArcroleTypes, optional
    
    See Also:
    
    addXBRLDocument(XBRLDocument, XBRLRoleAndArcroleTypes)
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Clear.
    
    Specified by:
    
    clear in interface XBRLFactsList
    
    Overrides:
    
    clear in class XBRLDocumentRootNode
    
    Throws:
    
    java.lang.Throwable - the throwable
  - clearDTSReferences
```
public void clearDTSReferences()
```
    Removes all schemas, linkbases, roleRefs, arcroleRefs etc in the DTS of this instance document. This also removes all fact items in the instance but does not removes contexts and units.
  - clone
```
public XBRLInstanceRootNode clone()
```
    Clone.
    
    Overrides:
    
    clone in class XMLFragment
    
    Returns:
    
    the XBRL instance root node
  - clone
```
public XBRLInstanceRootNode clone(DTSContainer dts)
```
    Clone.
    
    Overrides:
    
    clone in class XMLFragment
    
    Parameters:
    
    dts - the dts
    
    Returns:
    
    the XBRL instance root node
  - removeContext
```
public boolean removeContext(XBRLContext ctx)
```
    Removes a context from the instance document.
    The context should not have fact items in this instance document before it is removed.
    All facts in the instance document using this context will be removed from the instance
    
    Parameters:
    
    ctx - the ctx
    
    Returns:
    
    true if the context was deleted false if the context was not in the instance
  - removeUnit
```
public boolean removeUnit(XBRLUnit unit)
```
    Removes an unit from the instance document. The unit must not be used by items in this instance document before it is removed. An XBRLInconsistentOperationException is thrown if this happens
    
    Parameters:
    
    unit - the unit
    
    Returns:
    
    true if the unit was removed, false if the unit was not in the instance
  - removeXBRLDocument
```
public void removeXBRLDocument(XBRLDocument doc)
```
    Detach an XBRLDocument from the set of XBRLDocuments to include in this instance's DTS.
    
    Parameters:
    
    doc - the XBRLTaxonomy or XBRLLinkbase to detach
  - generateRootNode
```
public XBRLInstanceRootNode generateRootNode()
                                      throws XBRLSerializationException
```
    Generate root node.
    
    Returns:
    
    the XBRL instance root node
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
  - get
```
public XBRLFact get(int index)
```
    Gets the.
    
    Specified by:
    
    get in interface XBRLFactsList
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the XBRL fact
  - getFact
```
@Deprecated
public XBRLFact getFact(net.sf.saxon.s9api.XdmNode factNode)
```
    Deprecated.
    
    This function access to a fact item by its surrounding XdmNode. This function is used inside the formula processor in order to accelerate access to high level objects while working with low level Saxon API. At this stage, the use of this method is only possible for instance documents obtained from the serialized form (XML files).
    
    Parameters:
    
    factNode - as key to obtain the XBRLFact
    
    Returns:
    
    XBRLFact
  - getContextCompatible
```
public XBRLContext getContextCompatible(XBRLContext otherContext)
```
    Returns an existing context that is c-equal to the context passed in as the parameter.
    
    Parameters:
    
    otherContext - the other context
    
    Returns:
    
    the context compatible
    
    Since:
    
    2.8.5
  - getContexts
```
public java.util.Iterator<XBRLContext> getContexts()
```
    Access to all contexts in the XBRL Instance including contexts in the limbo (not in the instance but) in the scope of the instance. If the instance document has been created from an external file this function may return duplicate XBRL Contexts in the iterator. If the XBRL Instance has been created from the API, the API already eliminates duplicate contexts automatically.
    Note that the serialization process will eliminate duplicate contexts automatically if they exists.
    
    Returns:
    
    Iterator over all XBRL contexts in the instance.
  - forEachContext
```
public void forEachContext(XBRLInstanceRootNode.ForEachContext lambda)
```
    Locks the instance document and executes the lambda function on each one of the XBRLContexts in the instance
    
    Parameters:
    
    lambda - instance of ForEachContext interface
  - forEachFact
```
public void forEachFact(XBRLInstanceRootNode.ForEachFact lambda)
```
    Locks the instance document and executes the lambda function on each one of the XBRLFacts in the instance
    
    Parameters:
    
    lambda - instance of ForEachFact interface
  - forEachUnit
```
public void forEachUnit(XBRLInstanceRootNode.ForEachUnit lambda)
```
    Locks the instance document and executes the lambda function on each one of the XBRLUnits in the instance
    
    Parameters:
    
    lambda - instance of ForEachUnit interface
  - forEachContextUnsafe
```
public void forEachContextUnsafe(XBRLInstanceRootNode.ForEachContext lambda)
```
    Executes the lambda function on each one of the XBRLContexts in the instance but does not lock the instance document for modifications.
    This code can be used during the validation process when in multi-thread validation another thread has already locked the instance document
    
    Parameters:
    
    lambda - instance of ForEachContext interface
  - forEachFactUnsafe
```
public void forEachFactUnsafe(XBRLInstanceRootNode.ForEachFact lambda)
```
    Executes the lambda function on each one of the XBRLFacts in the instance (at root level. This method does not enter recursively into tuple content) but does not lock the instance document for modifications.
    This code can be used during the validation process when in multi-thread validation another thread has already locked the instance document
    
    Parameters:
    
    lambda - instance of ForEachFact interface
  - forEachUnitUnsafe
```
public void forEachUnitUnsafe(XBRLInstanceRootNode.ForEachUnit lambda)
```
    Executes the lambda function on each one of the XBRLUnit in the instance but does not lock the instance document for modifications.
    This code can be used during the validation process when in multi-thread validation another thread has already locked the instance document
    
    Parameters:
    
    lambda - instance of ForEachUnit interface
  - getDTSs
```
public java.util.Iterator<java.net.URI> getDTSs()
                                         throws XBRLValidationException
```
    Obtains an iterator over the URIs of files that are in the DTS of this instance document.
    
    Returns:
    
    Iterator
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getInstance
```
public XBRLInstance getInstance()
```
    Gets the single instance of XBRLInstanceRootNode.
    
    Specified by:
    
    getInstance in interface XBRLFactsList
    
    Returns:
    
    single instance of XBRLInstanceRootNode
  - getFacts
```
public java.util.Iterator<XBRLFact> getFacts()
```
    This method is the same as iterator().
    
    Returns:
    
    Iterator of XBRLFact
    
    See Also:
    
    iterator()
  - getItems
```
public java.util.Iterator<XBRLFactItem> getItems()
```
    Gets the items.
    
    Specified by:
    
    getItems in interface XBRLFactsList
    
    Returns:
    
    the items
  - getItems
```
public java.util.Iterator<XBRLFactItem> getItems(XBRLItem itemFrom)
```
    Gets the items.
    
    Specified by:
    
    getItems in interface XBRLFactsList
    
    Parameters:
    
    itemFrom - the item from
    
    Returns:
    
    the items
  - getItemsSg
```
public java.util.Iterator<XBRLFactItem> getItemsSg(XBRLItem itemFrom)
```
    Gets the items sg.
    
    Specified by:
    
    getItemsSg in interface XBRLFactsList
    
    Parameters:
    
    itemFrom - the item from
    
    Returns:
    
    the items sg
  - getNumberOfContexts
```
public int getNumberOfContexts()
```
    Returns the number of contexts in this instance document.
    
    Returns:
    
    Integer value
  - getNumberOfItems
```
public int getNumberOfItems()
```
    Gets the number of items.
    
    Specified by:
    
    getNumberOfItems in interface XBRLFactsList
    
    Returns:
    
    the number of items
  - getNumberOfTuples
```
public int getNumberOfTuples()
```
    Gets the number of tuples.
    
    Specified by:
    
    getNumberOfTuples in interface XBRLFactsList
    
    Returns:
    
    the number of tuples
  - getNumberOfUnits
```
public int getNumberOfUnits()
```
    Returns the number of units in this instance document.
    
    Returns:
    
    Integer value
  - getParentXBRL
```
public XMLFragment getParentXBRL()
```
    Gets the parent XBRL.
    
    Specified by:
    
    getParentXBRL in interface XBRLFactsList
    
    Overrides:
    
    getParentXBRL in class XMLFragment
    
    Returns:
    
    the parent XBRL
  - getTuples
```
public java.util.Iterator<XBRLFactTuple> getTuples()
```
    Gets the tuples.
    
    Specified by:
    
    getTuples in interface XBRLFactsList
    
    Returns:
    
    the tuples
  - getTuples
```
public java.util.Iterator<XBRLFactTuple> getTuples(XBRLTuple tupleFrom)
```
    Gets the tuples.
    
    Specified by:
    
    getTuples in interface XBRLFactsList
    
    Parameters:
    
    tupleFrom - the tuple from
    
    Returns:
    
    the tuples
  - getTuplesSg
```
public java.util.Iterator<XBRLFactTuple> getTuplesSg(XBRLTuple tupleFrom)
```
    Gets the tuples sg.
    
    Specified by:
    
    getTuplesSg in interface XBRLFactsList
    
    Parameters:
    
    tupleFrom - the tuple from
    
    Returns:
    
    the tuples sg
  - getUnitCompatible
```
public XBRLUnit getUnitCompatible(XBRLUnit otherUnit)
```
    Returns an existing unit that is u-equal to the unit passed in as the parameter.
    
    Parameters:
    
    otherUnit - the other unit
    
    Returns:
    
    the unit compatible
    
    Since:
    
    2.8.5
  - getUnits
```
public java.util.Iterator<XBRLUnit> getUnits()
```
    Access to all units in the XBRL Instance. If the instance document has been created from an external file this function may return duplicate XBRL Units in the iterator. If the XBRL Instance has been created from the API, the API already eliminates duplicate units automatically.
    Note that the serialization process will eliminate duplicate units automatically if they exists.
    
    Returns:
    
    Iterator over all XBRL units in the instance.
  - getXBRLDocuments
```
public java.util.Iterator<java.net.URI> getXBRLDocuments(XBRLDocument.XBRLDocumentType type)
```
    Returns an iterator over documents included in the DTS by this instance that are of the specified type.
    
    Parameters:
    
    type - can be XBRLDocument.TAXONOMY or XBRLDocument.LINKBASE
    
    Returns:
    
    Iterator
  - indexOf
```
public int indexOf(XBRLFact fact)
```
    Index of.
    
    Specified by:
    
    indexOf in interface XBRLFactsList
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    the int
  - indexOf
```
public int indexOf(XBRLFact fact,
                   int index)
```
    Index of.
    
    Specified by:
    
    indexOf in interface XBRLFactsList
    
    Parameters:
    
    fact - the fact
    
    index - the index
    
    Returns:
    
    the int
  - iterator
```
public java.util.Iterator<XBRLFact> iterator()
```
    Iterator.
    
    Specified by:
    
    iterator in interface XBRLFactsList
    
    Returns:
    
    the iterator
  - remove
```
public boolean remove(XBRLFact fact)
```
    Removes the.
    
    Specified by:
    
    remove in interface XBRLFactsList
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    true, if successful
  - remove
```
public boolean remove(java.util.Set<XBRLFact> facts)
```
    Removes the.
    
    Specified by:
    
    remove in interface XBRLFactsList
    
    Parameters:
    
    facts - the facts
    
    Returns:
    
    true, if successful
  - removeChild
```
public void removeChild(XMLFragment child)
```
    Removes the child.
    
    Overrides:
    
    removeChild in class XMLFragment
    
    Parameters:
    
    child - the child
  - removeFact
```
public boolean removeFact(XBRLFact fact)
```
    Removes the fact from the node tree. This method is for internal API use. Use the remove(XBRLFact) method instead
    
    Specified by:
    
    removeFact in interface XBRLFactsList
    
    Parameters:
    
    fact - the fact
    
    Returns:
    
    true, if successful
  - removeFacts
```
public boolean removeFacts(java.util.Set<XBRLFact> facts)
```
    Removes the set of facts from the node tree. This method is for internal API use. Use the #remove(Set) method instead
    
    Specified by:
    
    removeFacts in interface XBRLFactsList
    
    Parameters:
    
    facts - the set of facts
    
    Returns:
    
    true, if successful
    
    Since:
    
    3.2.0
  - setInstance
```
public void setInstance(XBRLInstance instance)
```
    Sets the instance.
    
    Parameters:
    
    instance - the new instance
  - setOptimizations
```
public void setOptimizations(boolean optimizations)
```
    This flag sets how the process of generating the XML nodes will work either removing unused contexts or keeping all generated contexts there during a call to generateDocNode. The default value is to work with optimizations disabled so the API will not remove elements created by the API. When it is time to save the instance on disk it may be appropriate to set this to true.
    
    Parameters:
    
    optimizations - the new optimizations
  - setParent
```
public void setParent(XBRLFactsList parent)
```
    Sets the parent.
    
    Specified by:
    
    setParent in interface XBRLFactsList
    
    Parameters:
    
    parent - the new parent
  - size
```
public int size()
```
    Size.
    
    Specified by:
    
    size in interface XBRLFactsList
    
    Returns:
    
    the int
  - iterator2
```
public java.util.Iterator<XBRLFact> iterator2()
```
    Iterator 2.
    
    Specified by:
    
    iterator2 in interface XBRLFactsList
    
    Returns:
    
    the iterator
  - getContextById
```
public XBRLContext getContextById(java.lang.String id)
```
    Obtains a context from the context limbo using the context id.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    XBRLContext that is know as indicated in the id. Note the id might not be equal
  - getUnitById
```
public XBRLUnit getUnitById(java.lang.String id)
```
    Obtains an unit from the units limbo using the unit id.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    XBRLUnit that is know as indicated in the id. Note the id might not be equal
  - copyHistory
```
public void copyHistory(XBRLInstanceRootNode instanceRootNode)
```
    Copy history.
    
    Parameters:
    
    instanceRootNode - the instance root node
  - 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

Class XBRLInstanceRootNode

Nested Class Summary

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

Field Summary

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

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

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

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.ihr.xbrl.om.instance.XBRLFactsList

Method Detail

make

hashCode

add

add

addChild

addArcroleRef

addRoleRef

removeArcroleRef

removeLinkbaseRef

removeFootnoteLinkbase

removeRoleRef

removeSchemaRef

addLinkbaseRef

addFootnoteLinkbase

addSchemaRef

addContext

getRoleRefs

getSchemaRefs

getLinkbaseRefs

getArcroleRefs

addUnit

addXBRLDocument

addXBRLDocumentIfNotInDTS

clear

clearDTSReferences

clone

clone

removeContext

removeUnit

removeXBRLDocument

generateRootNode

get

getFact

getContextCompatible

getContexts

forEachContext

forEachFact

forEachUnit

forEachContextUnsafe

forEachFactUnsafe

forEachUnitUnsafe

getDTSs

getInstance

getFacts

getItems

getItems

getItemsSg

getNumberOfContexts

getNumberOfItems

getNumberOfTuples

getNumberOfUnits

getParentXBRL

getTuples

getTuples

getTuplesSg

getUnitCompatible

getUnits

getXBRLDocuments

indexOf

indexOf

iterator

remove

remove

removeChild

removeFact