XMLFragment

java.lang.Object
- net.sf.saxon.tree.linked.NodeImpl
- - net.sf.saxon.tree.linked.ElementImpl
  - - com.ihr.xbrl.om.XMLFragment

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:

BaseElem, MapperAnchor, MapperCompany, MapperContextBase, MapperContexts, MapperDataSources, MapperDocumentation, MapperDts, MapperFact, MapperFacts, MapperFile, MapperInstance, MapperPeriodBase, MapperScheme, MapperSection, MapperSource, MapperUnits, XBRLContext, XBRLDefinition, XBRLDimensionsContainer, XBRLDocumentation, XBRLDocumentRootNode, XBRLEntity, XBRLFact, XBRLIdentifier, XBRLImport, XBRLInclude, XBRLMeasure, XBRLPeriod, XBRLRoleAndArcroleTypes, XBRLUnit, XBRLUsedOn, XLinkElement, XMLAnnotation, XMLAppInfo, XMLElementDefinition
```
public class XMLFragment
extends net.sf.saxon.tree.linked.ElementImpl
implements java.io.Serializable, javax.xml.namespace.NamespaceContext, XBRLRelationshipPoint, java.lang.Cloneable, HasChangeHashSupport, HasDTSContainer
```
This is the bottom class of almost every object on this API that represents a node in an XML document.
Methods of this class allows to execute XPath expressions using this node as the context for the XPath expressions. Other methods allows to obtain the XPointers in different formats. Other set of methods keeps track of XLink relationships between the nodes.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`XMLFragment.NodeNameIterator<T extends XMLFragment>` A node name iterator to retrieve all children XMLFragments that are whose node name matches.
`static class`	`XMLFragment.NodeTypeIterator<T extends XMLFragment>` A node type iterator to retrieve all instances of a specific class that are child of a indicated node.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`ADD_NAMESPACE_INHERIT` The Constant ADD_NAMESPACE_INHERIT.
`static javax.xml.namespace.QName`	`baseQName` The Constant baseQName.
`static int`	`CONCEPT_LABEL` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`CONCEPT_QNAME` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`EASY_TO_READ` Implemented for contexts, returns a text representation of the context period and optional dimensions.
`static int`	`ELEMENT_LABEL` if the element has an element-label relationship use it before any other label.
`static EmptyIterator<XBRLRelationship>`	`EMPTYRELATIONSHIPSITERATORINSTANCE` Implements an empty Iterator over relationships returned when there are no relationships to iterate over.
`static EmptyIterator<XMLFragment>`	`EMPTYXMLFRAGMENTITERATORINSTANCE` Implements an empty Iterator over XMLFragments returned when there are no XMLFragments to iterate over.
`static int`	`FACT_CONCEPT_DATATYPE` Includes the fact data type in the fact friendly name string.
`static int`	`FACT_CONCEPT_LABEL` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`FACT_QNAME` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`FACT_VALUE` Includes only the fact value.
`static int`	`HIDE_COMMON_ACCURACY` Implemented on XBRLFactNumeric to hide d(0) and d(INF) p(INF) and all other suffixes that makes the number fully readable.
`static javax.xml.namespace.QName`	`idQName` This is the name of the attribute id defined here for convenience the id QName is in the no namespace and has no prefix.
`static javax.xml.namespace.QName`	`langQName` The Constant langQName.
`static javax.xml.namespace.QName`	`nil` The Constant nil.
`static int`	`NO_POSITION` Constant used to indicate formatting options for the friendly name of an object.
`static java.util.Comparator<XBRLRelationship>`	`OrderComparator` class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly.
`static java.util.Comparator<XBRLRelationship>`	`OrderComparator2` class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly.
`static java.util.Comparator<XBRLRelationship>`	`OrderComparatorReverse` The Constant OrderComparatorReverse.
`static int`	`PERIOD_BOP` Includes the period value on XBRLPeriod instances.
`static int`	`PERIOD_TYPE` Includes the period type description after the period value.
`static int`	`PERIOD_VALUE` Includes the period value on XBRLPeriod instances.
`static int`	`RELATIONSHIP_TYPE` if the element is a relationship this generates a string of type "presentation relationship" where "presentation" is generated from the arc type and other possibilities are recognized as well.
`static int`	`RESOURCE_TYPE` if the element is a resource this generates a string of type "footnote" generated from the well known resource types.
`static int`	`SHORT_TEXT` for resources, this returns the resource text, the id, the xlink:label or the node name in that order.
`static int`	`SOURCE_DOCUMENT` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`XPATH` Constant used to indicate formatting options for the friendly name of an object.
`static int`	`XPOINTER` Constant used to indicate formatting options for the friendly name of an object.

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
`XMLFragment(DTSContainer dts)` Creates a new XMLFragment object in a DTS.
`XMLFragment(DTSContainer dts, javax.xml.namespace.QName nodeName)` Instantiates a new XML fragment.
`XMLFragment(DTSContainer dts, java.lang.String nodeName)` Instantiates a new XML fragment.
`XMLFragment(DTSContainer dts, java.lang.String nodeName, net.sf.saxon.om.NamespaceBinding namespace)` Instantiates a new XML fragment.
`XMLFragment(DTSContainer dts, java.lang.String nodeName, java.lang.String namespaceURI)` Instantiates a new XML fragment.
`XMLFragment(DTSContainer dts, java.lang.String nodeName, java.lang.String prefix, java.lang.String namespaceURI)` Instantiates a new XML fragment.
`XMLFragment(DTSContainer newDTS, XMLFragment other)` Copy all properties from the other object but sets the DTS to a new one.
`XMLFragment(XMLFragment other)` Copy constructor for an XMLFragment.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.value.AnyURIValue uriValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.value.AtomicValue atomicValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, boolean booleanValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.value.BooleanValue booleanValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, javax.xml.namespace.QName qnameValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.value.QNameValue qnameValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.type.SimpleType type, net.sf.saxon.om.GroundedValue gValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, java.lang.String strValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, net.sf.saxon.value.StringValue strValue)` Adds the attribute.
`boolean`	`addAttribute(javax.xml.namespace.QName attrName, java.net.URI uriValue)` Adds the attribute.
`boolean`	`addAttribute(net.sf.saxon.type.SchemaType schemaType, java.lang.String attrName, java.lang.String attrValue, java.lang.String attrPrefix, java.lang.String attrNamespace)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.value.BooleanValue booleanValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.value.DecimalValue decimalValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.value.DoubleValue doubleValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.value.IntegerValue integerValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, javax.xml.namespace.QName qnValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.value.QNameValue qnValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, net.sf.saxon.type.SimpleType type, net.sf.saxon.om.GroundedValue gValue)` Adds the attribute.
`boolean`	`addAttribute(java.lang.String attrName, java.lang.String attrValue)` Adds the attribute.
`boolean`	`addAttribute(XBRLAttribute attr)` Adds the attribute.
`void`	`addChild(XMLFragment f)` Adds a child XMLFragment to this XMLFragment.
`void`	`addChildArray(XMLFragment[] childArray)` Adds an array of XMLFragment to this XMLFragment.
`void`	`addChildAt(XMLFragment f, int pos)` Adds a child XMLFragment to this XMLFragment at index position.
`static void`	`addChildNode(net.sf.saxon.tree.linked.NodeImpl nodeParent, net.sf.saxon.tree.linked.NodeImpl childNode)` Adds a child node to the node.
`static void`	`addChildNodeArray(XMLFragment nodeParent, XMLFragment[] childArray)` Adds an array of XMLFragment to the parent node.
`static void`	`addChildNodeAt(XMLFragment nodeParent, net.sf.saxon.tree.linked.NodeImpl childNode, int index)` Adds a child node to the node at index position.
`void`	`addChildNodeInBatch(XMLFragment childNode)` Adds the child node in batch.
`void`	`addComment(java.lang.String commentValue)` Adds the comment.
`boolean`	`addFromRelationship(XBRLRelationship rel)` Adds the from relationship.
`void`	`addNamespace(net.sf.saxon.om.NamespaceBinding ns)` Adds a namespace declaration that will be in the scope of namespaces declared in this node.
`void`	`addNamespace(java.lang.String prefix, java.lang.String uri)` Adds a new namespace and prefix to this object's namespace context.
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Adds the property change listener.
`boolean`	`addToRelationship(XBRLRelationship rel)` Adds the to relationship.
`void`	`changeBase(DTSBase oldBase, DTSBase newBase)` This object is informed that a DTSBase is going to be deleted.
`static void`	`checkBase(boolean relativize, java.net.URI base)` For internal use only.
`boolean`	`childExists(net.sf.saxon.tree.linked.NodeImpl node)` Returns true if the child node exists.
`void`	`clear()` Frees-up used memory This method should not be invoqued on live objects in the DTS.
`XMLFragment`	`clone()` Clone.
`XMLFragment`	`clone(DTSContainer newDTS)` Clone.
`void`	`commitBatch()` Commit batch.
`void`	`copy(net.sf.saxon.event.Receiver out, int copyOptions, int locationId)` This is a copy of the copy method in the ElementImpl class except that it is able to skip the attributes that shall not be included in output element because they are added during XML Schema validation Copy this node to a given outputter (supporting xsl:copy-of).
`static net.sf.saxon.tree.linked.CommentImpl`	`createComment(java.lang.String commentValue)` Creates a comment node from a String.
`boolean`	`delAttribute(javax.xml.namespace.QName attributeQName)` Removes an attribute from the attributes defined for this XMLFragment.
`boolean`	`delAttribute(java.lang.String attributeName)` Del attribute.
`void`	`delete()` Delete.
`boolean`	`equals(java.lang.Object other)` Equals.
`static boolean`	`equalXdmValues(net.sf.saxon.s9api.XdmValue val, net.sf.saxon.s9api.XdmValue val2, AtomicComparerHelper ach)` Compares two XdmValue objects and returns true if both are the same atomicValues or the same XML nodes.
`<T> T`	`findFirstNodeOfClass(java.util.Collection<java.lang.Class<? extends XMLFragment>> nodeSeq)` This method finds a node using a sequence of node classes.
`int`	`findPosition(java.util.Collection<java.lang.Class<? extends XMLFragment>> nodeSeq)` This method finds the position of the child node on this node after searching for nodes in the nodeSeq sequence.
`void`	`firePropertyChangeEvent(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)` Fire property change event.
`static java.lang.String`	`generateId()` Generates a new unique ID that can be used during the serialization of objects.
`XBRLLocator`	`generateLocatorToNode(XMLFragment parent)` Generate locator pointing to this node.
`XMLFragment`	`generateNode()` Serializes to a XMLFragment the representation of the properties of this Information Item This method should be called from classes derived from this class
`static java.lang.String`	`generatePrefix(java.lang.String namespace)` Returns a prefix that is created automatically and bounds it to the namespace.
`java.util.Iterator<XBRLAttribute>`	`getAllAttributes()` Access to all attributes defined in this XMLFragment without any filter to remove attributes that belongs to a parent class in the class hierarchy.
`XBRLAttribute`	`getAttribute(javax.xml.namespace.QName attributeName)` Obtains an XBRLAttribute object that is defined in this XMLFragment or null if not found.
`net.sf.saxon.value.AtomicValue`	`getAttributeAtomicValue(javax.xml.namespace.QName attributeName)` Gets the attribute atomic value.
`boolean`	`getAttributeBooleanValue(javax.xml.namespace.QName attributeName, boolean _default)` Returns a boolean value of the attribute indicated. if the attribute does not exists, the default value is returned
`net.sf.saxon.om.GroundedValue`	`getAttributeGroundedValue(javax.xml.namespace.QName attributeName)` Gets the attribute atomic sequence.
`javax.xml.namespace.QName`	`getAttributeQNameValue(javax.xml.namespace.QName attributeName)` Returns a QName Value object with the value of the attribute on this node.
`java.util.Iterator<XBRLAttribute>`	`getAttributes()` Access to attributes defined in this node.
`java.lang.String`	`getAttributeValue(javax.xml.namespace.QName attributeName)` Returns a String with the value of the attribute on this node.
`java.net.URI`	`getBase()` Search for an attribute called xml:base on this node and returns a resolved URI considering the content of the xml:base in ancestor nodes and the document URI.
`java.net.URI`	`getBase(java.net.URI base)` Search for an attribute called xml:base on this node if set, then resolves the base URI against that attribute and returns the resulting URI.
`boolean`	`getBooleanValue()` If the value is a Boolean type value then Boolean value is extracted and returned as a boolean.
`java.util.Collection<net.sf.saxon.om.NodeInfo>`	`getChildren()` Returns all children nodes of current node in a Collection.
`java.lang.String`	`getChildStringValue()` This is similar to getStringValue().
`net.sf.saxon.Configuration`	`getConfiguration()` Must override this method in order to access the surrounding configuration on a node that has no parent document but DTSContainer attached.
`DTSContainer`	`getContainer()` Returns the DTS Container object.
`java.net.URI`	`getContainerDocumentURI()` Try to obtain this document URI.
`net.sf.saxon.s9api.XdmNode`	`getDocument()` Returns the surrounding XML Node.
`XMLFragment`	`getElement(javax.xml.namespace.QName nodeName)` Gets the element.
`XMLFragment`	`getElement(java.lang.String nodeName, java.lang.String namespace)` Gets the element.
`java.util.Iterator<XMLFragment>`	`getElements()` For complex type resources this returns an iterator with all children XML fragments This method may be overwriten by other classes in the hierarchy.
`net.sf.saxon.tree.linked.NodeImpl`	`getFirstChild()`
`XMLFragment`	`getFirstChildNoComment()` NodeImpl contains an useful method called getFirstChild but that method returns NodeImpl and might return a comment instead of just Elements.
`static java.lang.String`	`getFragment(java.lang.String href)` Returns the fragment part of an href.
`java.lang.String`	`getFriendlyName()` Returns a string description that represents the element content in a form that users can understand.
`java.lang.String`	`getFriendlyName(int modifiers)` Returns a string description that represents the element content in a form that users can understand.
`java.lang.String`	`getFriendlyName(int modifiers, LabelsProvider lp)` Returns a string description that represents the element content in a form that users can understand.
`java.util.Iterator<XBRLRelationship>`	`getFromRelationships()` Returns the relationship objects that contains this element in the source of the relationship.
`java.util.Collection<XBRLRelationship>`	`getFromRelationships(java.util.Comparator<XBRLRelationship> comparator)` Returns the relationship objects that contains this element in the source of the relationship.
`java.util.Iterator<XBRLRelationship>`	`getFromRelationships(int arcrole)` Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
`java.util.Collection<XBRLRelationship>`	`getFromRelationships(int arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
`java.util.Iterator<XBRLRelationship>`	`getFromRelationships(int arcrole, DTSBase base)` Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
`java.util.Collection<XBRLRelationship>`	`getFromRelationships(int arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base.
`java.util.Iterator<XBRLRelationship>`	`getFromRelationships(XBRLArcroleType arcrole)` Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
`java.util.Collection<XBRLRelationship>`	`getFromRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
`java.util.Iterator<XBRLRelationship>`	`getFromRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
`java.util.Collection<XBRLRelationship>`	`getFromRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base.
`java.lang.String`	`getId()` Access to the element's id.
`java.util.List<net.sf.saxon.om.NamespaceBinding>`	`getInScopeNamespaces()` Returns a list of namespaces defined in scope of current element, means, this method explore namespace declarations up to the root element and collects all them in the returned list.
`java.lang.String`	`getLang()` Returns the value of the xml:lang attribute on this node or on a parent node Returns null if not specified on this or any parent node.
`net.sf.saxon.tree.linked.NodeImpl`	`getLastChild()`
`XMLFragment`	`getLastChildNoComment()` NodeImpl contains an useful method called getLastChild but that method returns NodeImpl and might return a comment instead of just Elements.
`net.sf.saxon.om.NamePool`	`getNamePool()` Gets the saxonica name pool of the node.
`net.sf.saxon.om.NamespaceBinding`	`getNamespaceBinding()` Gets the namespace binding.
`java.lang.String`	`getNamespaceURI(java.lang.String prefix)` Returns the namespace URI for the specified prefix as defined in this node.
`XMLFragment`	`getNextSiblingNoComment()` NodeImpl contains an useful method called getNextSibling but that method returns NodeImpl and might return a comment instead of just Elements.
`javax.xml.namespace.QName`	`getNodeName()` Returns this node's name as a QName.
`XMLFragment`	`getNthElement(int index)` Gets the nth child XMLFragment node from this node (numbering from 0).
`int`	`getNumberOfChildren()`
`int`	`getNumberOfElements()` Returns the number of children elements that are instances of XMLFragment.
`int`	`getNumberOfFromRelationships()` Returns the number of relationships this fragment is in its source.
`int`	`getNumberOfToRelationships()` Returns the number of relationships this fragment is in its target.
`java.lang.String`	`getOrGenerateId()` Obtain the id for this XMLFragment. if not set then this method will create one unique ID and will set it as the ID for this XMLFragment.
`XBRLDocument`	`getParentDocument()` Access to the parent document for this node.
`XMLFragment`	`getParentXBRL()` The parent XMLFragment node of this XMLFragment node.
`java.lang.String`	`getPrefix(java.lang.String namespaceURI)` Returns the prefix String associated to the given URI as defined in this node.
`java.util.Iterator<java.lang.String>`	`getPrefixes(java.lang.String namespaceURI)` Gets the prefixes.
`java.util.Set<java.beans.PropertyChangeListener>`	`getPropertyChangeListeners(java.lang.String propertyName)` Returns a set of PropertyChangeListeners registered for the corresponding propertyName.
`javax.xml.namespace.QName`	`getQNameValue()` Returns this XMLFragment value as a QName If the value is a QName type value the QName is extracted and returned as a QName.
`java.util.Iterator<DTSBase>`	`getRelationshipsBases()` Returns an iterator over all DTSBases this object has relationships from.
`java.util.Iterator<XBRLRelationshipsChainLink>`	`getRelationshipsChain(DTSBase base, javax.xml.namespace.QName type)` Process all relationships this item is source and returns an iterator over all XBRLRelationshipsChainLink(s).
`java.util.Iterator<javax.xml.namespace.QName>`	`getRelationshipTypes(DTSBase base)` Returns an iterator over all QNames of relationship types that exists in a specific base.
`static java.lang.String`	`getStaticNamespace(java.lang.String prefix)` Returns the namespace URI for a prefix.
`java.lang.String`	`getStringValue()` Returns a string representation of the value of this XMLFragment if value is null the function returns null.
`java.lang.String`	`getToolTipText()` Returns a small text with HTML code that can be represented in a tool tip with information about this XMLFragment.
`java.util.Iterator<XBRLRelationship>`	`getToRelationships()` Returns the relationship objects that contains this element in the target of the relationship.
`java.util.Collection<XBRLRelationship>`	`getToRelationships(java.util.Comparator<XBRLRelationship> comparator)` Returns the relationship objects that contains this element in the target of the relationship.
`java.util.Iterator<XBRLRelationship>`	`getToRelationships(int arcrole)` Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
`java.util.Collection<XBRLRelationship>`	`getToRelationships(int arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
`java.util.Iterator<XBRLRelationship>`	`getToRelationships(int arcrole, DTSBase base)` Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
`java.util.Collection<XBRLRelationship>`	`getToRelationships(int arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base.
`java.util.Iterator<XBRLRelationship>`	`getToRelationships(XBRLArcroleType arcrole)` Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
`java.util.Collection<XBRLRelationship>`	`getToRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
`java.util.Iterator<XBRLRelationship>`	`getToRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
`java.util.Collection<XBRLRelationship>`	`getToRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base.
`net.sf.saxon.s9api.XdmValue`	`getValue()` Returns the value of this node.
`XPathOnXMLFragment`	`getXPath()` Returns an instance of a class where it is possible to evaluate XPath expressions using current fragment as XPath context.
`static java.lang.String`	`getXPathFromXPointer(java.lang.String fragment)` Converts an URI Fragment of the form element(1/2/3/4) or #element(1/2/3/4) into an XPath expression that shall return the indicated node when evaluated.
`net.sf.saxon.om.NamespaceResolver`	`getXPathNamespaceContext()` Access to the NamespaceResolver attached to this XMLFragment.
`java.lang.String`	`getXPathToRoot()` Returns an XPath 2.0 expression to locate this document's node starting at this document's root This function updates the local namespace context if nodes in the path requires new namespaces to be declared.
`java.lang.String`	`getXPointerElementScheme()` generates an XPointer of the form document-uri#element(/n/m/...) pointing to the node that is the nodeInfo of this fragment
`static java.lang.String`	`getXPointerElementScheme(net.sf.saxon.om.NodeInfo ni)` generates an XPointer of the form element(/n/m/...) pointing to the node that is the nodeInfo of this fragment This is a very slow function and the use is discouraged except for producing logs when the log is necessary.
`java.lang.String`	`getXPointerShorthandScheme()` generates an XPointer of the form document-uri#id pointing to the node that is the nodeInfo of this fragment returns null if the element does not have an ID.
`java.lang.String`	`getXPointerXPath2Scheme()` generates an XPointer of the form //xbrli:xbrl/tx:Revenues that locates the node Revenues that exists as the first child of the root element of an XBRL instance document.
`boolean`	`hasChildNodes()`
`int`	`hashCode()` Hash code.
`void`	`initialise(net.sf.saxon.om.NodeName elemName, net.sf.saxon.type.SchemaType elementType, net.sf.saxon.tree.util.AttributeCollectionImpl atts, net.sf.saxon.om.NodeInfo parent, int sequenceNumber)` Initialise.
`static java.lang.String`	`internalToString(DTSContainer dts, net.sf.saxon.tree.linked.NodeImpl node)` Provides a text representation of this XMLFragment.
`boolean`	`isAttribute(javax.xml.namespace.QName attributeName)` Returns true if the attribute is defined on this node.
`boolean`	`isChangeHashEnabled()` Checks if is change hash enabled.
`boolean`	`isDead()` Returns true if the clear method has been called on this object.
`boolean`	`isEmpty()` Returns true when this XMLFragment has no children XMLFragments.
`boolean`	`isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)` returns true if the hashCode depends on this attribute name.
`boolean`	`isNamespaceDefined(net.sf.saxon.om.NamespaceBinding ns)` Checks if the namespace in the parameter is defined in this node available namespaces and the prefix matches.
`boolean`	`isNil()` Return true if the fact is nil it MUST contain a @xsi:nil attribute with value = true.
`static void`	`moveNamespacesUp(XMLFragment root, XMLFragment elem, boolean remove)` Deprecated.
`boolean`	`objEquals(java.lang.Object other)` Access to the equals method on the Object object in the class hierarchy.
`int`	`objHashCode()` Access to the hashCode form this object.
`void`	`reindex(int newIndex)` Re sets index number of all children nodes There is a bug in saxonica when elements are deleted from a node.
`void`	`removeChild(XMLFragment f)` Removes an XMLFragment from the list of children elements of this resource.
`static void`	`removeChildNode(net.sf.saxon.tree.linked.NodeImpl nodeParent, net.sf.saxon.tree.linked.NodeImpl childNode)` Removes a child node from the list of children elements of this resource.
`boolean`	`removeFromRelationship(XBRLRelationship rel)` Removes the from relationship.
`void`	`removeNamespace(net.sf.saxon.om.NamespaceBinding oldNs)` Removes the namespace.
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Removes the property change listener.
`boolean`	`removeToRelationship(XBRLRelationship rel)` Removes the to relationship.
`void`	`replace(XMLFragment node)` Replaces this fragment in the XML tree with another node.
`void`	`replaceChild(XMLFragment oldFragment, XMLFragment newFragment)` Replaces a child fragment with a new child fragment.
`void`	`replaceStringValue(java.lang.CharSequence stringValue)` Better use setValue(...).
`void`	`resetElements()` Removes all child nodes from this node and resets the cached hash if the call to `isChangeHashEnabled()` returns true.
`java.net.URI`	`resolveHRef(java.net.URI href)` Resolves an HRef by returning the absolute URI of the document pointed to by the href.
`static boolean`	`s_equal2_xp2(net.sf.saxon.om.Item node1, net.sf.saxon.om.Item node2, boolean bIncludeIdAttributes, DTSContainer dts, AtomicComparerHelper ach)` Resolves s_equal2 comparison of the two nodes.
`boolean`	`s_equal2_xp2(java.lang.Object other)` Resolves s_equal2 comparison of this node against the other node. using XPath 2.0 rules
`static boolean`	`s_equal2(net.sf.saxon.om.Item item1, net.sf.saxon.om.Item item2)` Compares two Item instances for equality.
`static boolean`	`s_equal2(net.sf.saxon.om.Item node1, net.sf.saxon.om.Item node2, boolean bIncludeIdAttributes, DTSContainer dts, AtomicComparerHelper ach)` Resolves s_equal2 comparison of the two nodes.
`boolean`	`s_equal2(java.lang.Object other)` Resolves s_equal2 comparison of this node against the other node.
`static boolean`	`s_equal2(net.sf.saxon.om.Sequence item1, net.sf.saxon.om.Sequence item2)` Compares two Item instances for equality.
`void`	`setAttributeList(net.sf.saxon.om.AttributeCollection atts)` Sets the attribute list.
`void`	`setAttributes(java.util.Set<XBRLAttribute> attributeSet)` Adds or replaces the attributes of this object with attributes in the set received as a parameter to this method.
`void`	`setBase(java.net.URI uri)` Sets an attribute called xml:base on this node or changes the value of that node if it exists.
`void`	`setChildrenClone(DTSContainer newDTS, java.util.Collection<net.sf.saxon.om.NodeInfo> childrenVector)` Sets the children clone.
`void`	`setDirty()` Sets the document is dirty and the XML nodes must be rebuild on the next call to updateXML.
`void`	`setElements(java.util.Iterator<XMLFragment> elementsIter)` Sets the elements.
`void`	`setId(java.lang.String id)` Sets the content of the id attribute of this element the ID MUST not have any space, but null is allowed and removes an id from an XML Fragment.
`void`	`setLang(java.lang.String lang)` Sets the language for this element.
`void`	`setModified(boolean value)` Sets a flag on the XBRLDocumentRootNode to indicate the document content has been edited.
`void`	`setNamespaceDeclarations(net.sf.saxon.om.NamespaceBinding[] namespaces, int namespacesUsed)` Sets the namespace declarations.
`void`	`setNamespaces(java.util.Collection<net.sf.saxon.om.NamespaceBinding> colNamespaces)` One by one add the namespaces in the collection received as a parameter.
`boolean`	`setNil(boolean newValue)` Sets the nil attribute to true or false according to the param value.
`void`	`setNodeName(javax.xml.namespace.QName nodeName)` Sets a new nodeName to this XMLFragment.
`boolean`	`setRawParentXBRL(XMLFragment parent)` Sets the parent of this node to the specific XMLFragment.
`void`	`setValue(net.sf.saxon.value.AtomicValue value)` Sets the value of this node as a AtomicValue.
`void`	`setValue(net.sf.saxon.s9api.QName value)` Sets the value of this node as a net.sf.saxon.s9api.QName.
`void`	`setValue(javax.xml.namespace.QName value)` Sets the value of this node as a javax.xml.namespace.QName.
`void`	`setValue(java.lang.String value)` Sets the value of this node.
`void`	`setValue(java.lang.String value, net.sf.saxon.type.BuiltInAtomicType type)` Sets the value of this node.
`void`	`setValue(net.sf.saxon.s9api.XdmAtomicValue value)` Sets the value of this node as a XdmAtomicValue.
`void`	`setValue(net.sf.saxon.s9api.XdmNode value)` Sets the value of this node as a XdmNode.
`void`	`setValue(net.sf.saxon.s9api.XdmValue value)` Sets the value of this node as a XdmValue.
`java.lang.String`	`toString()` Returns the XML representation of this object as an String.
`boolean`	`valueEquals(XMLFragment o)` Returns true if this elements' values is equal to the parameters' element value.
`static boolean`	`xEqual(net.sf.saxon.value.AtomicValue param1, net.sf.saxon.value.AtomicValue param2, boolean bXBRLSpecCompliant)` Performs the x-equality comparison of two strings as indicated in the XBRL 2.1 specification

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
  - ADD_NAMESPACE_INHERIT
```
public static final boolean ADD_NAMESPACE_INHERIT
```
    The Constant ADD_NAMESPACE_INHERIT.
    
    See Also:
    
    Constant Field Values
  - XPOINTER
```
public static final int XPOINTER
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - XPATH
```
public static final int XPATH
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - NO_POSITION
```
public static final int NO_POSITION
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - SOURCE_DOCUMENT
```
public static int SOURCE_DOCUMENT
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider)
  - CONCEPT_QNAME
```
public static final int CONCEPT_QNAME
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - CONCEPT_LABEL
```
public static final int CONCEPT_LABEL
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - FACT_QNAME
```
public static final int FACT_QNAME
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - FACT_CONCEPT_LABEL
```
public static final int FACT_CONCEPT_LABEL
```
    Constant used to indicate formatting options for the friendly name of an object.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - FACT_CONCEPT_DATATYPE
```
public static final int FACT_CONCEPT_DATATYPE
```
    Includes the fact data type in the fact friendly name string.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - SHORT_TEXT
```
public static final int SHORT_TEXT
```
    for resources, this returns the resource text, the id, the xlink:label or the node name in that order.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - ELEMENT_LABEL
```
public static final int ELEMENT_LABEL
```
    if the element has an element-label relationship use it before any other label.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - EASY_TO_READ
```
public static final int EASY_TO_READ
```
    Implemented for contexts, returns a text representation of the context period and optional dimensions.
    
    See Also:
    
    Constant Field Values
  - HIDE_COMMON_ACCURACY
```
public static final int HIDE_COMMON_ACCURACY
```
    Implemented on XBRLFactNumeric to hide d(0) and d(INF) p(INF) and all other suffixes that makes the number fully readable.
    
    See Also:
    
    Constant Field Values
  - FACT_VALUE
```
public static final int FACT_VALUE
```
    Includes only the fact value. Implemented on XBRLFactItem is used on XBRLAssertionResult
    
    See Also:
    
    Constant Field Values
  - RELATIONSHIP_TYPE
```
public static final int RELATIONSHIP_TYPE
```
    if the element is a relationship this generates a string of type "presentation relationship" where "presentation" is generated from the arc type and other possibilities are recognized as well.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - RESOURCE_TYPE
```
public static final int RESOURCE_TYPE
```
    if the element is a resource this generates a string of type "footnote" generated from the well known resource types.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - PERIOD_TYPE
```
public static final int PERIOD_TYPE
```
    Includes the period type description after the period value.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - PERIOD_VALUE
```
public static final int PERIOD_VALUE
```
    Includes the period value on XBRLPeriod instances.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - PERIOD_BOP
```
public static final int PERIOD_BOP
```
    Includes the period value on XBRLPeriod instances.
    
    See Also:
    
    getFriendlyName(int, LabelsProvider), Constant Field Values
  - idQName
```
public static final javax.xml.namespace.QName idQName
```
    This is the name of the attribute id defined here for convenience
    the id QName is in the no namespace and has no prefix.
  - nil
```
public static final javax.xml.namespace.QName nil
```
    The Constant nil.
  - langQName
```
public static final javax.xml.namespace.QName langQName
```
    The Constant langQName.
  - baseQName
```
public static final javax.xml.namespace.QName baseQName
```
    The Constant baseQName.
  - EMPTYRELATIONSHIPSITERATORINSTANCE
```
public static final EmptyIterator<XBRLRelationship> EMPTYRELATIONSHIPSITERATORINSTANCE
```
    Implements an empty Iterator over relationships returned when there are no relationships to iterate over.
  - EMPTYXMLFRAGMENTITERATORINSTANCE
```
public static final EmptyIterator<XMLFragment> EMPTYXMLFRAGMENTITERATORINSTANCE
```
    Implements an empty Iterator over XMLFragments returned when there are no XMLFragments to iterate over.
  - OrderComparator
```
public static final java.util.Comparator<XBRLRelationship> OrderComparator
```
    class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly.
  - OrderComparatorReverse
```
public static final java.util.Comparator<XBRLRelationship> OrderComparatorReverse
```
    The Constant OrderComparatorReverse.
  - OrderComparator2
```
public static final java.util.Comparator<XBRLRelationship> OrderComparator2
```
    class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly. If two relationships has the same value for the order attribute. this class falls back to use the comparison of xlink:to content of two relationships
- Constructor Detail
  - XMLFragment
```
public XMLFragment(DTSContainer dts)
```
    Creates a new XMLFragment object in a DTS.
    
    Parameters:
    
    dts - the dts
  - XMLFragment
```
public XMLFragment(XMLFragment other)
```
    Copy constructor for an XMLFragment. The new fragment constructed has a new DocumentImpl parent.
    
    Parameters:
    
    other - the other
  - XMLFragment
```
public XMLFragment(DTSContainer newDTS,
                   XMLFragment other)
```
    Copy all properties from the other object but sets the DTS to a new one. The new fragment constructed has a new DocumentImpl parent.
    
    Parameters:
    
    newDTS - the new dts, maybe null
    
    other - the other object
  - XMLFragment
```
public XMLFragment(DTSContainer dts,
                   java.lang.String nodeName,
                   net.sf.saxon.om.NamespaceBinding namespace)
```
    Instantiates a new XML fragment.
    
    Parameters:
    
    dts - the dts
    
    nodeName - the node name
    
    namespace - the namespace
  - XMLFragment
```
public XMLFragment(DTSContainer dts,
                   java.lang.String nodeName,
                   java.lang.String namespaceURI)
```
    Instantiates a new XML fragment.
    
    Parameters:
    
    dts - the dts
    
    nodeName - the node name
    
    namespaceURI - the namespace URI
  - XMLFragment
```
public XMLFragment(DTSContainer dts,
                   java.lang.String nodeName)
```
    Instantiates a new XML fragment.
    
    Parameters:
    
    dts - the dts
    
    nodeName - the node name
  - XMLFragment
```
public XMLFragment(DTSContainer dts,
                   java.lang.String nodeName,
                   java.lang.String prefix,
                   java.lang.String namespaceURI)
```
    Instantiates a new XML fragment.
    
    Parameters:
    
    dts - the dts
    
    nodeName - the node name
    
    prefix - the prefix
    
    namespaceURI - the namespace URI
  - XMLFragment
```
public XMLFragment(DTSContainer dts,
                   javax.xml.namespace.QName nodeName)
```
    Instantiates a new XML fragment.
    
    Parameters:
    
    dts - the dts
    
    nodeName - the node name
- Method Detail
  - childExists
```
public boolean childExists(net.sf.saxon.tree.linked.NodeImpl node)
```
    Returns true if the child node exists.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true if the child node exists
    
    See Also:
    
    findFirstNodeOfClass(Collection), findPosition(Collection)
  - addChildNodeAt
```
public static void addChildNodeAt(XMLFragment nodeParent,
                                  net.sf.saxon.tree.linked.NodeImpl childNode,
                                  int index)
```
    Adds a child node to the node at index position.
    
    Parameters:
    
    nodeParent - the parent node
    
    childNode - the node to add
    
    index - the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.
  - addChildNode
```
public static void addChildNode(net.sf.saxon.tree.linked.NodeImpl nodeParent,
                                net.sf.saxon.tree.linked.NodeImpl childNode)
```
    Adds a child node to the node.
    
    Parameters:
    
    nodeParent - the parent node
    
    childNode - the node to add
  - addChildNodeArray
```
public static void addChildNodeArray(XMLFragment nodeParent,
                                     XMLFragment[] childArray)
```
    Adds an array of XMLFragment to the parent node. This method has several limitations
    - Does not supports xml:base or events to update xlink:href values
    - Nodes can be added only at the end of the current nodes
    - Only work with XMLFragment or derived objects. Does not supports comments or processing instructions
    - addIdOfElement is not supported when parent document is not XBRLDocument
    Parameters:
    
    nodeParent - the node parent
    
    childArray - the child array
  - addChildNodeInBatch
```
public void addChildNodeInBatch(XMLFragment childNode)
```
    Adds the child node in batch.
    
    Parameters:
    
    childNode - the child node
  - commitBatch
```
public void commitBatch()
```
    Commit batch.
  - objHashCode
```
public int objHashCode()
```
    Access to the hashCode form this object.
    
    Returns:
    
    integer
  - objEquals
```
public boolean objEquals(java.lang.Object other)
```
    Access to the equals method on the Object object in the class hierarchy.
    
    Parameters:
    
    other - Object
    
    Returns:
    
    boolean
  - delete
```
public void delete()
```
    Delete.
    
    Specified by:
    
    delete in interface net.sf.saxon.om.MutableNodeInfo
    
    Overrides:
    
    delete in class net.sf.saxon.tree.linked.ElementImpl
  - getInScopeNamespaces
```
public java.util.List<net.sf.saxon.om.NamespaceBinding> getInScopeNamespaces()
```
    Returns a list of namespaces defined in scope of current element, means, this method explore namespace declarations up to the root element and collects all them in the returned list.
    Elements at the beginning of the list are "closer" to the node than element for same namespaces farther in the list. this might be important when dealing for multiple prefixes defined for the same namespace URI
    
    Returns:
    
    List of NamespaceBinding instanced
  - clone
```
public XMLFragment clone()
```
    Clone.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    the XML fragment
  - clone
```
public XMLFragment clone(DTSContainer newDTS)
```
    Clone.
    
    Parameters:
    
    newDTS - the new dts
    
    Returns:
    
    the XML fragment
  - getConfiguration
```
public net.sf.saxon.Configuration getConfiguration()
```
    Must override this method in order to access the surrounding configuration on a node that has no parent document but DTSContainer attached.
    
    Specified by:
    
    getConfiguration in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    getConfiguration in class net.sf.saxon.tree.linked.NodeImpl
    
    Returns:
    
    the configuration
  - getNamePool
```
public net.sf.saxon.om.NamePool getNamePool()
```
    Gets the saxonica name pool of the node.
    
    Specified by:
    
    getNamePool in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    getNamePool in class net.sf.saxon.tree.linked.NodeImpl
    
    Returns:
    
    the name pool
  - setChildrenClone
```
public void setChildrenClone(DTSContainer newDTS,
                             java.util.Collection<net.sf.saxon.om.NodeInfo> childrenVector)
```
    Sets the children clone.
    
    Parameters:
    
    newDTS - the new DTS
    
    childrenVector - the children vector
  - toString
```
public java.lang.String toString()
```
    Returns the XML representation of this object as an String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string
  - getFriendlyName
```
public java.lang.String getFriendlyName()
```
    Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.
    Remarks, this method may return very long names not suitable for user interface
    
    Returns:
    
    Non empty String. Internationalization is enabled
  - getFriendlyName
```
public java.lang.String getFriendlyName(int modifiers)
```
    Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.
    Remarks, this method may return very long names not suitable for user interface
    
    Parameters:
    
    modifiers - allows to modify the text representation
    
    Returns:
    
    Non empty String. Internationalization is enabled
  - getToolTipText
```
public java.lang.String getToolTipText()
```
    Returns a small text with HTML code that can be represented in a tool tip with information about this XMLFragment. This method shall be extended on specialized classes, the default implementation returns just the XML Fragment QName
    
    Returns:
    
    the XMLFragment QName to string
  - getFriendlyName
```
public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)
```
    Returns a string description that represents the element content in a form that users can understand. This method may be override by parent classes.
    This function accepts flags that are defined as constants in XMLFragment in order to modify the output.
    - XMLFragment.XPOINTER includes the element position in the source file using the XPointer specification. Note, if the document is created from objects the value may not be available
    - XMLFragment.XPATH includes the element position in the source file using XPATH. Note, if the document is created from objects the value may not be available
    - XMLFragment.NO_POSITION does not include the element position in the source file.
    - XMLFragment.CONCEPT_QNAME for XBRLItem, XBRLTuple and XMLElementDefinition.
    - XMLFragment.CONCEPT_LABEL for XBRLItem and XBRLTuple.
    - XMLFragment.FACT_QNAME for facts.
    - XMLFragment.FACT_CONCEPT_LABEL for facts.
    - XMLFragment.SHORT_TEXT for resources, returns the resource text, id or xlink:label
    - XMLFragment.EASY_TO_READ for contexts, returns the context date and dimensions in a user friendly text representation
    Parameters:
    
    modifiers - integer
    
    lp - the lp
    
    Returns:
    
    Non empty String. Internationalization is enabled
    
    Since:
    
    2.6.6
  - getXPathToRoot
```
public java.lang.String getXPathToRoot()
```
    Returns an XPath 2.0 expression to locate this document's node starting at this document's root This function updates the local namespace context if nodes in the path requires new namespaces to be declared.
    
    Returns:
    
    String
  - getContainerDocumentURI
```
public java.net.URI getContainerDocumentURI()
```
    Try to obtain this document URI.
    In case a document URI cannot be obtained the URI "file:///Unknown" is returned.
    
    Returns:
    
    the document URI if it can be obtained from this fragment.
  - generateLocatorToNode
```
public XBRLLocator generateLocatorToNode(XMLFragment parent)
                                  throws java.net.URISyntaxException
```
    Generate locator pointing to this node.
    
    Parameters:
    
    parent - the XMLFragment element that will be this node parent
    
    Returns:
    
    XBRLLocator
    
    Throws:
    
    java.net.URISyntaxException - the URI syntax exception
  - getDocument
```
public net.sf.saxon.s9api.XdmNode getDocument()
```
    Returns the surrounding XML Node. Objects inherited may replace this.
    
    Returns:
    
    XdmNode
  - internalToString
```
public static java.lang.String internalToString(DTSContainer dts,
                                                net.sf.saxon.tree.linked.NodeImpl node)
```
    Provides a text representation of this XMLFragment.
    This method can be used in the GUI or in error messages that shows a single XML fragment.
    
    Parameters:
    
    dts - the DTS that will be used to obtain parameters about the output format. If the dts parameter is null, the output format will use default values
    
    node - the node to represent
    
    Returns:
    
    the string
  - moveNamespacesUp
```
@Deprecated
public static void moveNamespacesUp(XMLFragment root,
                                                XMLFragment elem,
                                                boolean remove)
```
    Deprecated.
    
    Move namespaces up.
    
    Parameters:
    
    root - the root
    
    elem - the elem
    
    remove - the remove
  - copy
```
public void copy(net.sf.saxon.event.Receiver out,
                 int copyOptions,
                 int locationId)
          throws net.sf.saxon.trans.XPathException
```
    This is a copy of the copy method in the ElementImpl class except that it is able to skip the attributes that shall not be included in output element because they are added during XML Schema validation Copy this node to a given outputter (supporting xsl:copy-of).
    
    Specified by:
    
    copy in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    copy in class net.sf.saxon.tree.linked.ElementImpl
    
    Parameters:
    
    out - The outputter
    
    copyOptions - the copy options
    
    locationId - the location id
    
    Throws:
    
    net.sf.saxon.trans.XPathException - the x path exception
  - getContainer
```
public DTSContainer getContainer()
```
    Returns the DTS Container object.
    
    Specified by:
    
    getContainer in interface HasDTSContainer
    
    Returns:
    
    DTSContainer
  - getValue
```
public net.sf.saxon.s9api.XdmValue getValue()
```
    Returns the value of this node. This function should be overridden by objects in this API.
    When the XMLFragment data type is not simple type and is not mixed content and is not the empty content the getValue() returns null
    When the value is against the schema type, this method can fire a RuntimeException encapsulating an XPathException
    
    Returns:
    
    a net.sf.saxon.s9api.XdmValue or XdmEmptySequence if no value
  - getQNameValue
```
public javax.xml.namespace.QName getQNameValue()
```
    Returns this XMLFragment value as a QName If the value is a QName type value the QName is extracted and returned as a QName. If the value is UntypedAtomic and it contains a prefix:localname then the prefix is resolved to the namespace and a QName is returned.
    
    Returns:
    
    a javax.xml.namespace.QName QName
  - getBooleanValue
```
public boolean getBooleanValue()
```
    If the value is a Boolean type value then Boolean value is extracted and returned as a boolean.
    
    Returns:
    
    boolean
  - getChildStringValue
```
public java.lang.String getChildStringValue()
```
    This is similar to getStringValue(). The difference is that the text obtained is only from descendants nodes. The original scans any descendant nodes in document order and adds unwanted text in any cases.
    
    Returns:
    
    String the String
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns a string representation of the value of this XMLFragment if value is null the function returns null.
    
    Specified by:
    
    getStringValue in interface net.sf.saxon.om.Item
    
    Specified by:
    
    getStringValue in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    getStringValue in class net.sf.saxon.tree.linked.ElementImpl
    
    Returns:
    
    String the String
  - setValue
```
public void setValue(java.lang.String value)
```
    Sets the value of this node.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(java.lang.String value,
                     net.sf.saxon.type.BuiltInAtomicType type)
```
    Sets the value of this node.
    
    Parameters:
    
    value - the value
    
    type - the type
  - setValue
```
public void setValue(net.sf.saxon.s9api.QName value)
```
    Sets the value of this node as a net.sf.saxon.s9api.QName.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(javax.xml.namespace.QName value)
```
    Sets the value of this node as a javax.xml.namespace.QName.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(net.sf.saxon.s9api.XdmAtomicValue value)
```
    Sets the value of this node as a XdmAtomicValue.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(net.sf.saxon.s9api.XdmNode value)
```
    Sets the value of this node as a XdmNode.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(net.sf.saxon.s9api.XdmValue value)
```
    Sets the value of this node as a XdmValue.
    
    Parameters:
    
    value - the new value
  - setValue
```
public void setValue(net.sf.saxon.value.AtomicValue value)
```
    Sets the value of this node as a AtomicValue. This method may raise RuntimeException encapsulating an XPathException if the value is not according with the schema type
    
    Parameters:
    
    value - the new value
  - getNodeName
```
public javax.xml.namespace.QName getNodeName()
```
    Returns this node's name as a QName. The node name is also the value of the [Type] property on several objects in the infoset like [Linkbase type] [relationship type]
    
    Returns:
    
    the node name
  - setNodeName
```
public void setNodeName(javax.xml.namespace.QName nodeName)
```
    Sets a new nodeName to this XMLFragment.
    
    Parameters:
    
    nodeName - the new node name
  - initialise
```
public void initialise(net.sf.saxon.om.NodeName elemName,
                       net.sf.saxon.type.SchemaType elementType,
                       net.sf.saxon.tree.util.AttributeCollectionImpl atts,
                       net.sf.saxon.om.NodeInfo parent,
                       int sequenceNumber)
```
    Initialise.
    
    Overrides:
    
    initialise in class net.sf.saxon.tree.linked.ElementImpl
    
    Parameters:
    
    elemName - the elem name
    
    elementType - the element type
    
    atts - the atts
    
    parent - the parent
    
    sequenceNumber - the sequence number
  - getId
```
public java.lang.String getId()
```
    Access to the element's id. This is not part of the infoset
    
    Returns:
    
    the content of the id attribute or null if there is no id attribute
  - setId
```
public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException
```
    Sets the content of the id attribute of this element the ID MUST not have any space, but null is allowed and removes an id from an XML Fragment.
    This method may be overwritten by other classes that require storing an indexed table of elements and IDs in order to prevent duplicate IDs to exist
    
    Parameters:
    
    id - the new ID
    
    Throws:
    
    XBRLInconsistentDTSException - if the id is not lexicographically valid
  - getOrGenerateId
```
public java.lang.String getOrGenerateId()
```
    Obtain the id for this XMLFragment. if not set then this method will create one unique ID and will set it as the ID for this XMLFragment. IDs will be serialized later. If the XMLFragment is already part of an XBRLDocument this method can avoid duplicates at the creation time
    
    Returns:
    
    String
  - generateId
```
public static java.lang.String generateId()
```
    Generates a new unique ID that can be used during the serialization of objects.
    This method is thread safe
    
    Returns:
    
    String
  - resolveHRef
```
public java.net.URI resolveHRef(java.net.URI href)
```
    Resolves an HRef by returning the absolute URI of the document pointed to by the href. fragments are returned without changes
    
    Parameters:
    
    href - the href attribute content
    
    Returns:
    
    URI
  - getFragment
```
public static java.lang.String getFragment(java.lang.String href)
```
    Returns the fragment part of an href.
    
    Parameters:
    
    href - the href
    
    Returns:
    
    String
  - setNamespaceDeclarations
```
public void setNamespaceDeclarations(net.sf.saxon.om.NamespaceBinding[] namespaces,
                                     int namespacesUsed)
```
    Sets the namespace declarations.
    
    Overrides:
    
    setNamespaceDeclarations in class net.sf.saxon.tree.linked.ElementImpl
    
    Parameters:
    
    namespaces - the namespaces
    
    namespacesUsed - the namespaces used
  - getXPathNamespaceContext
```
public net.sf.saxon.om.NamespaceResolver getXPathNamespaceContext()
```
    Access to the NamespaceResolver attached to this XMLFragment.
    
    Returns:
    
    NamespaceResolver object
  - getXPath
```
public XPathOnXMLFragment getXPath()
```
    Returns an instance of a class where it is possible to evaluate XPath expressions using current fragment as XPath context.
    
    Returns:
    
    the x path
  - getAttributeGroundedValue
```
public net.sf.saxon.om.GroundedValue getAttributeGroundedValue(javax.xml.namespace.QName attributeName)
```
    Gets the attribute atomic sequence.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    the attribute atomic sequence
  - getAttributeAtomicValue
```
public net.sf.saxon.value.AtomicValue getAttributeAtomicValue(javax.xml.namespace.QName attributeName)
```
    Gets the attribute atomic value.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    the attribute atomic value
  - getAttributeValue
```
public java.lang.String getAttributeValue(javax.xml.namespace.QName attributeName)
```
    Returns a String with the value of the attribute on this node. null if the node does not have this attribute
    
    Parameters:
    
    attributeName - Attribute QName
    
    Returns:
    
    Value
  - isAttribute
```
public boolean isAttribute(javax.xml.namespace.QName attributeName)
```
    Returns true if the attribute is defined on this node.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    true, if is attribute
  - getAttributeQNameValue
```
public javax.xml.namespace.QName getAttributeQNameValue(javax.xml.namespace.QName attributeName)
```
    Returns a QName Value object with the value of the attribute on this node. null if the node does not have this attribute
    
    Parameters:
    
    attributeName - Attribute QName
    
    Returns:
    
    Value
  - getAttributeBooleanValue
```
public boolean getAttributeBooleanValue(javax.xml.namespace.QName attributeName,
                                        boolean _default)
```
    Returns a boolean value of the attribute indicated. if the attribute does not exists, the default value is returned
    
    Parameters:
    
    attributeName - the attribute name
    
    _default - the default
    
    Returns:
    
    boolean value
  - getAttribute
```
public XBRLAttribute getAttribute(javax.xml.namespace.QName attributeName)
```
    Obtains an XBRLAttribute object that is defined in this XMLFragment or null if not found.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    XBRLAttribute
  - getNamespaceURI
```
public java.lang.String getNamespaceURI(java.lang.String prefix)
```
    Returns the namespace URI for the specified prefix as defined in this node.
    
    Specified by:
    
    getNamespaceURI in interface javax.xml.namespace.NamespaceContext
    
    Parameters:
    
    prefix - the prefix
    
    Returns:
    
    the namespace uri
  - getPrefix
```
public java.lang.String getPrefix(java.lang.String namespaceURI)
```
    Returns the prefix String associated to the given URI as defined in this node. This method uses the statically defined prefixes which is not a good idea when a decision about adding a new namespace is resolved. In that case use getInScopeNamespaces() instead
    
    Specified by:
    
    getPrefix in interface javax.xml.namespace.NamespaceContext
    
    Parameters:
    
    namespaceURI - the namespace uri
    
    Returns:
    
    the prefix
  - addNamespace
```
public void addNamespace(java.lang.String prefix,
                         java.lang.String uri)
```
    Adds a new namespace and prefix to this object's namespace context. Prefixes and namespaces added are evailable for the evaluation of XPath 2.0 expressions
    
    Parameters:
    
    prefix - the prefix
    
    uri - the uri
  - getPrefixes
```
public java.util.Iterator<java.lang.String> getPrefixes(java.lang.String namespaceURI)
```
    Gets the prefixes.
    
    Specified by:
    
    getPrefixes in interface javax.xml.namespace.NamespaceContext
    
    Parameters:
    
    namespaceURI - the namespace URI
    
    Returns:
    
    the prefixes
  - getXPointerElementScheme
```
public java.lang.String getXPointerElementScheme()
```
    generates an XPointer of the form document-uri#element(/n/m/...) pointing to the node that is the nodeInfo of this fragment
    
    Returns:
    
    String
  - getXPointerElementScheme
```
public static java.lang.String getXPointerElementScheme(net.sf.saxon.om.NodeInfo ni)
```
    generates an XPointer of the form element(/n/m/...) pointing to the node that is the nodeInfo of this fragment This is a very slow function and the use is discouraged except for producing logs when the log is necessary.
    
    Parameters:
    
    ni - the ni
    
    Returns:
    
    String
  - getXPathFromXPointer
```
public static java.lang.String getXPathFromXPointer(java.lang.String fragment)
```
    Converts an URI Fragment of the form element(1/2/3/4) or #element(1/2/3/4) into an XPath expression that shall return the indicated node when evaluated.
    Note, the returned XPath expression is still using the node numbers, not the node names. In the previous example, the returned XPath expression is /*[1]/*[2]/*[3]/*[4]
    
    Parameters:
    
    fragment - the fragment
    
    Returns:
    
    String
  - getXPointerShorthandScheme
```
public java.lang.String getXPointerShorthandScheme()
```
    generates an XPointer of the form document-uri#id pointing to the node that is the nodeInfo of this fragment returns null if the element does not have an ID. Use an element scheme XPointer instead
    
    Returns:
    
    String
  - getXPointerXPath2Scheme
```
public java.lang.String getXPointerXPath2Scheme()
```
    generates an XPointer of the form //xbrli:xbrl/tx:Revenues that locates the node Revenues that exists as the first child of the root element of an XBRL instance document.
    Note, the use of this method is discouraged for hash codes or things like that because the XPath to obtain a node might change if another node with the same name is inserted before the current node. So this method shall be used only to show error messages when the document will not change.
    Note2, on very large documents this method might perform bad because in order to know if a node name is unique in the list of sibling nodes all other nodes must be explored.
    
    Returns:
    
    String, XPath expression
    
    Since:
    
    3.0.6
  - generatePrefix
```
public static java.lang.String generatePrefix(java.lang.String namespace)
```
    Returns a prefix that is created automatically and bounds it to the namespace.
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    String
  - getStaticNamespace
```
public static java.lang.String getStaticNamespace(java.lang.String prefix)
```
    Returns the namespace URI for a prefix. This methos search only the static defined namespaces and prefixes
    
    Parameters:
    
    prefix - String
    
    Returns:
    
    String
  - equals
```
public boolean equals(java.lang.Object other)
```
    Equals.
    
    Specified by:
    
    equals in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    equals in class net.sf.saxon.tree.linked.NodeImpl
    
    Parameters:
    
    other - the other
    
    Returns:
    
    true, if successful
  - valueEquals
```
public boolean valueEquals(XMLFragment o)
```
    Returns true if this elements' values is equal to the parameters' element value.
    
    Parameters:
    
    o - the o
    
    Returns:
    
    boolean
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Specified by:
    
    hashCode in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the int
  - setModified
```
public void setModified(boolean value)
```
    Sets a flag on the XBRLDocumentRootNode to indicate the document content has been edited.
    If this node is an instance of XBRLDocumentRootNode then the modified flag on the root XBRLDocument is set to the value parameter. If this node is an instance of the XMLFragment the event is forwarded up to the parent.
    NOTE: A modified document might not be in dirty status; setDirty() is called when the surrounding XML requires to be rebuild
    
    Parameters:
    
    value - boolean true to set the flag as Modified state or false to indicate not modified
  - s_equal2
```
public boolean s_equal2(java.lang.Object other)
```
    Resolves s_equal2 comparison of this node against the other node.
    
    Parameters:
    
    other - The other node (preferably an XMLFragment) that contains a non null NodeInfo document.
    
    Returns:
    
    boolean
  - s_equal2_xp2
```
public boolean s_equal2_xp2(java.lang.Object other)
```
    Resolves s_equal2 comparison of this node against the other node. using XPath 2.0 rules
    
    Parameters:
    
    other - The other node (preferably an XMLFragment) that contains a non null NodeInfo document.
    
    Returns:
    
    boolean
  - s_equal2
```
public static boolean s_equal2(net.sf.saxon.om.Item node1,
                               net.sf.saxon.om.Item node2,
                               boolean bIncludeIdAttributes,
                               DTSContainer dts,
                               AtomicComparerHelper ach)
```
    Resolves s_equal2 comparison of the two nodes. The XBRL Functions conformance suite and the XBRL Formula conformance suite are in contradiction regarding test cases using the xfi:fact_dimension_s_equal2 function. The Functions conformancre suite requires QNames to be compared as strings The Formula conformance suite requires QNames to be considered as QNames as indicted in test cases from Victor Morilla. That's the reason we have included a comment in the code to change the behavior of this function accordingly.
    
    Parameters:
    
    node1 - Item
    
    node2 - Item
    
    bIncludeIdAttributes - boolean when nodes are elements, if the elements have id attributes, they may or may not be skiped.
    
    dts - the DTSContainer under with the comparison is performed. Note this might be null when comparing XMLFragments that are out of a DTS in that case dts can be null and proc must not be null
    
    ach - the ach
    
    Returns:
    
    boolean
  - s_equal2_xp2
```
public static boolean s_equal2_xp2(net.sf.saxon.om.Item node1,
                                   net.sf.saxon.om.Item node2,
                                   boolean bIncludeIdAttributes,
                                   DTSContainer dts,
                                   AtomicComparerHelper ach)
```
    Resolves s_equal2 comparison of the two nodes. The XBRL Functions conformance suite and the XBRL Formula conformance suite are in contradiction regarding test cases using the xfi:fact_dimension_s_equal2 function. The Functions conformancre suite requires QNames to be compared as strings The Formula conformance suite requires QNames to be considered as QNames as indicted in test cases from Victor Morilla. That's the reason we have included a comment in the code to change the behavior of this function accordingly.
    
    Parameters:
    
    node1 - Item
    
    node2 - Item
    
    bIncludeIdAttributes - boolean when nodes are elements, if the elements have id attributes, they may or may not be skiped.
    
    dts - the DTSContainer under with the comparison is performed. Note this might be null when comparing XMLFragments that are out of a DTS in that case dts can be null and proc must not be null
    
    ach - the ach
    
    Returns:
    
    boolean
  - getFromRelationships
```
public java.util.Iterator<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole,
                                                                 DTSBase base)
```
    Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
    
    Specified by:
    
    getFromRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - the arcrole
    
    base - the base
    
    Returns:
    
    the from relationships
  - getFromRelationships
```
public java.util.Iterator<XBRLRelationship> getFromRelationships(int arcrole,
                                                                 DTSBase base)
```
    Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
    
    Specified by:
    
    getFromRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - the arcrole
    
    base - the base
    
    Returns:
    
    the from relationships
  - getFromRelationships
```
public java.util.Collection<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole,
                                                                   DTSBase base,
                                                                   java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    base - the role to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    2.7.2
  - getFromRelationships
```
public java.util.Collection<XBRLRelationship> getFromRelationships(int arcrole,
                                                                   DTSBase base,
                                                                   java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    base - the role to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    3.2.0
  - getFromRelationships
```
public java.util.Collection<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole,
                                                                   java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    2.8.5
  - getFromRelationships
```
public java.util.Collection<XBRLRelationship> getFromRelationships(int arcrole,
                                                                   java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    3.2.0
  - getToRelationships
```
public java.util.Collection<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole,
                                                                 DTSBase base,
                                                                 java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    base - the role to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    2.7.2
  - getToRelationships
```
public java.util.Collection<XBRLRelationship> getToRelationships(int arcrole,
                                                                 DTSBase base,
                                                                 java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    base - the role to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    3.2.0
  - getToRelationships
```
public java.util.Collection<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole,
                                                                 java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    2.8.5
  - getToRelationships
```
public java.util.Collection<XBRLRelationship> getToRelationships(int arcrole,
                                                                 java.util.Comparator<XBRLRelationship> comparator)
```
    Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    arcrole - the arcrole to filter
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection of XBRLRelationship
    
    Since:
    
    3.2.0
  - getFromRelationships
```
public java.util.Iterator<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole)
```
    Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
    
    Specified by:
    
    getFromRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - XBRLArcroleType
    
    Returns:
    
    Iterator<XBRLRelationship>
    
    Since:
    
    2.6.5
  - getFromRelationships
```
public java.util.Iterator<XBRLRelationship> getFromRelationships(int arcrole)
```
    Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
    
    Specified by:
    
    getFromRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - XBRLArcroleType code
    
    Returns:
    
    Iterator<XBRLRelationship>
    
    Since:
    
    3.2.0
  - getToRelationships
```
public java.util.Iterator<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole)
```
    Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
    
    Specified by:
    
    getToRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - XBRLArcroleType
    
    Returns:
    
    Iterator<XBRLRelationship>
    
    Since:
    
    2.6.5
  - getToRelationships
```
public java.util.Iterator<XBRLRelationship> getToRelationships(int arcrole)
```
    Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
    
    Specified by:
    
    getToRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - XBRLArcroleType
    
    Returns:
    
    Iterator<XBRLRelationship>
    
    Since:
    
    3.2.0
  - getFromRelationships
```
public java.util.Iterator<XBRLRelationship> getFromRelationships()
```
    Returns the relationship objects that contains this element in the source of the relationship.
    
    Specified by:
    
    getFromRelationships in interface XBRLRelationshipPoint
    
    Returns:
    
    Iterator<XBRLRelationship>
  - getFromRelationships
```
public java.util.Collection<XBRLRelationship> getFromRelationships(java.util.Comparator<XBRLRelationship> comparator)
```
    Returns the relationship objects that contains this element in the source of the relationship. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection<XBRLRelationship>
  - getNumberOfFromRelationships
```
public int getNumberOfFromRelationships()
```
    Returns the number of relationships this fragment is in its source.
    
    Specified by:
    
    getNumberOfFromRelationships in interface XBRLRelationshipPoint
    
    Returns:
    
    int
  - getToRelationships
```
public java.util.Iterator<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole,
                                                               DTSBase base)
```
    Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
    
    Specified by:
    
    getToRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - the arcrole
    
    base - the base
    
    Returns:
    
    the to relationships
  - getToRelationships
```
public java.util.Iterator<XBRLRelationship> getToRelationships(int arcrole,
                                                               DTSBase base)
```
    Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
    
    Specified by:
    
    getToRelationships in interface XBRLRelationshipPoint
    
    Parameters:
    
    arcrole - the arcrole
    
    base - the base
    
    Returns:
    
    the to relationships
  - getToRelationships
```
public java.util.Iterator<XBRLRelationship> getToRelationships()
```
    Returns the relationship objects that contains this element in the target of the relationship.
    
    Specified by:
    
    getToRelationships in interface XBRLRelationshipPoint
    
    Returns:
    
    the to relationships
  - getToRelationships
```
public java.util.Collection<XBRLRelationship> getToRelationships(java.util.Comparator<XBRLRelationship> comparator)
```
    Returns the relationship objects that contains this element in the target of the relationship. The result is ordered using the comparator object passed in as a parameter.
    
    Parameters:
    
    comparator - the compataror to order relationships
    
    Returns:
    
    Collection<XBRLRelationship>
  - getNumberOfToRelationships
```
public int getNumberOfToRelationships()
```
    Returns the number of relationships this fragment is in its target.
    
    Specified by:
    
    getNumberOfToRelationships in interface XBRLRelationshipPoint
    
    Returns:
    
    the number of to relationships
  - addFromRelationship
```
public boolean addFromRelationship(XBRLRelationship rel)
                            throws XBRLInconsistentDTSException
```
    Adds the from relationship.
    
    Specified by:
    
    addFromRelationship in interface XBRLRelationshipPoint
    
    Parameters:
    
    rel - the rel
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent DTS exception
  - addToRelationship
```
public boolean addToRelationship(XBRLRelationship rel)
                          throws XBRLInconsistentDTSException
```
    Adds the to relationship.
    
    Specified by:
    
    addToRelationship in interface XBRLRelationshipPoint
    
    Parameters:
    
    rel - the rel
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent DTS exception
  - removeFromRelationship
```
public boolean removeFromRelationship(XBRLRelationship rel)
                               throws XBRLInconsistentDTSException
```
    Removes the from relationship.
    
    Specified by:
    
    removeFromRelationship in interface XBRLRelationshipPoint
    
    Parameters:
    
    rel - the rel
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent DTS exception
  - removeToRelationship
```
public boolean removeToRelationship(XBRLRelationship rel)
                             throws XBRLInconsistentDTSException
```
    Removes the to relationship.
    
    Specified by:
    
    removeToRelationship in interface XBRLRelationshipPoint
    
    Parameters:
    
    rel - the rel
    
    Returns:
    
    true, if successful
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent DTS exception
  - changeBase
```
public void changeBase(DTSBase oldBase,
                       DTSBase newBase)
```
    This object is informed that a DTSBase is going to be deleted. All references to it must be cleared. DTSBase is used as index in some hashtables.
    
    Parameters:
    
    oldBase - DTSBase cannot be null
    
    newBase - DTSBase can be null
  - getRelationshipsBases
```
public java.util.Iterator<DTSBase> getRelationshipsBases()
                                                  throws XBRLValidationException
```
    Returns an iterator over all DTSBases this object has relationships from.
    
    Specified by:
    
    getRelationshipsBases in interface XBRLRelationshipPoint
    
    Returns:
    
    the relationships bases
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getRelationshipTypes
```
public java.util.Iterator<javax.xml.namespace.QName> getRelationshipTypes(DTSBase base)
                                                                   throws XBRLValidationException
```
    Returns an iterator over all QNames of relationship types that exists in a specific base.
    
    Specified by:
    
    getRelationshipTypes in interface XBRLRelationshipPoint
    
    Parameters:
    
    base - the base
    
    Returns:
    
    Iterator<QName>
    
    Throws:
    
    XBRLValidationException - the XBRL validation exception
  - getRelationshipsChain
```
public java.util.Iterator<XBRLRelationshipsChainLink> getRelationshipsChain(DTSBase base,
                                                                            javax.xml.namespace.QName type)
```
    Process all relationships this item is source and returns an iterator over all XBRLRelationshipsChainLink(s).
    
    Specified by:
    
    getRelationshipsChain in interface XBRLRelationshipPoint
    
    Parameters:
    
    base - the base
    
    type - the type
    
    Returns:
    
    Iterator<XBRLRelationshipsChainLink>
  - getLang
```
public java.lang.String getLang()
```
    Returns the value of the xml:lang attribute on this node or on a parent node Returns null if not specified on this or any parent node.
    
    Returns:
    
    String
  - getBase
```
public java.net.URI getBase(java.net.URI base)
```
    Search for an attribute called xml:base on this node if set, then resolves the base URI against that attribute and returns the resulting URI.
    Can return null if base is null and the document has not been added to a proper parent document otherwise, if the node has no a proper parent and base is not null base is returned
    
    Parameters:
    
    base - the base
    
    Returns:
    
    URI
  - getBase
```
public java.net.URI getBase()
```
    Search for an attribute called xml:base on this node and returns a resolved URI considering the content of the xml:base in ancestor nodes and the document URI.
    Can return null if the document has not been added to a proper parent document
    
    Returns:
    
    URI absolute
  - setBase
```
public void setBase(java.net.URI uri)
```
    Sets an attribute called xml:base on this node or changes the value of that node if it exists.
    
    Parameters:
    
    uri - as URI
  - setLang
```
public void setLang(java.lang.String lang)
```
    Sets the language for this element.
    
    Parameters:
    
    lang - the new lang
  - checkBase
```
public static void checkBase(boolean relativize,
                             java.net.URI base)
                      throws XBRLSerializationException
```
    For internal use only. During the serialization of XBRL elements, if serialization is set to true, then the base MUST not be null and MUST be an absolute URI. In case of errors this method raises an XBRLSerializationException. The code has been placed here because is accesible from multiple other objects in the API.
    
    Parameters:
    
    relativize - the relativize
    
    base - the base
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
    
    Since:
    
    2.6.5
  - generateNode
```
public XMLFragment generateNode()
                         throws XBRLSerializationException
```
    Serializes to a XMLFragment the representation of the properties of this Information Item This method should be called from classes derived from this class
    
    Returns:
    
    a clone of the surrounding XMLFragment so it can be incorporated into multiple trees
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
  - delAttribute
```
public boolean delAttribute(javax.xml.namespace.QName attributeQName)
```
    Removes an attribute from the attributes defined for this XMLFragment.
    
    Parameters:
    
    attributeQName - QName of the attribute to remove
    
    Returns:
    
    true, if successful
    
    Since:
    
    2.6.4
  - delAttribute
```
public boolean delAttribute(java.lang.String attributeName)
```
    Del attribute.
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    true, if successful
  - getFirstChildNoComment
```
public XMLFragment getFirstChildNoComment()
```
    NodeImpl contains an useful method called getFirstChild but that method returns NodeImpl and might return a comment instead of just Elements. This implementation skips comment nodes and returns XMLFragments
    
    Returns:
    
    the first child no comment
  - getLastChildNoComment
```
public XMLFragment getLastChildNoComment()
```
    NodeImpl contains an useful method called getLastChild but that method returns NodeImpl and might return a comment instead of just Elements. This implementation skips comment nodes and returns XMLFragments
    
    Returns:
    
    the last child no comment
  - getNextSiblingNoComment
```
public XMLFragment getNextSiblingNoComment()
```
    NodeImpl contains an useful method called getNextSibling but that method returns NodeImpl and might return a comment instead of just Elements. This implementation skips comment nodes and returns XMLFragments
    
    Returns:
    
    the next sibling no comment
  - setAttributeList
```
public void setAttributeList(net.sf.saxon.om.AttributeCollection atts)
```
    Sets the attribute list.
    
    Overrides:
    
    setAttributeList in class net.sf.saxon.tree.linked.ElementImpl
    
    Parameters:
    
    atts - the new attribute list
  - setAttributes
```
public void setAttributes(java.util.Set<XBRLAttribute> attributeSet)
```
    Adds or replaces the attributes of this object with attributes in the set received as a parameter to this method.
    
    Parameters:
    
    attributeSet - set of attributes to add or set to this object
  - getAttributes
```
public java.util.Iterator<XBRLAttribute> getAttributes()
```
    Access to attributes defined in this node.
    The id attribute is skipped as there is a specific method to access to it and set a value.
    This method is overridden by super classes and shall add additional filters to exclude other attributes that belongs to the superclass
    
    Returns:
    
    Iterator<XBRLAttribute>
    
    See Also:
    
    getAllAttributes()
  - getAllAttributes
```
public final java.util.Iterator<XBRLAttribute> getAllAttributes()
```
    Access to all attributes defined in this XMLFragment without any filter to remove attributes that belongs to a parent class in the class hierarchy.
    
    Returns:
    
    Iterator<XBRLAttribute>
    
    Since:
    
    2.8.4
    
    See Also:
    
    getAttributes()
  - addNamespace
```
public void addNamespace(net.sf.saxon.om.NamespaceBinding ns)
```
    Adds a namespace declaration that will be in the scope of namespaces declared in this node. Namespace declarations will be serialized to final output.
    
    Parameters:
    
    ns - Namespace
  - setNamespaces
```
public void setNamespaces(java.util.Collection<net.sf.saxon.om.NamespaceBinding> colNamespaces)
```
    One by one add the namespaces in the collection received as a parameter.
    
    Parameters:
    
    colNamespaces - a Collection<Namespace> type
  - isNamespaceDefined
```
public boolean isNamespaceDefined(net.sf.saxon.om.NamespaceBinding ns)
```
    Checks if the namespace in the parameter is defined in this node available namespaces and the prefix matches.
    
    Parameters:
    
    ns - Namespace to check if it is in scope
    
    Returns:
    
    boolean
  - getNthElement
```
public XMLFragment getNthElement(int index)
```
    Gets the nth child XMLFragment node from this node (numbering from 0). Ignores text nodes and comments, unlike getNthChild(int index).
    
    Parameters:
    
    index - integer, 0 based
    
    Returns:
    
    XMLFragment representing the nth child XMLFragment
    
    Since:
    
    2.6.9
  - getElements
```
public java.util.Iterator<XMLFragment> getElements()
```
    For complex type resources this returns an iterator with all children XML fragments This method may be overwriten by other classes in the hierarchy.
    
    Returns:
    
    Iterator<XMLFragment>
  - getNumberOfElements
```
public int getNumberOfElements()
```
    Returns the number of children elements that are instances of XMLFragment.
    
    Returns:
    
    the number of elements
  - getChildren
```
public java.util.Collection<net.sf.saxon.om.NodeInfo> getChildren()
```
    Returns all children nodes of current node in a Collection. Note this method includes Text nodes, Comment nodes and Element nodes
    
    Returns:
    
    Collection of NodeInfo derived instances
  - setElements
```
public void setElements(java.util.Iterator<XMLFragment> elementsIter)
```
    Sets the elements.
    
    Parameters:
    
    elementsIter - Iterator<XBRLFragment>
  - addAttribute
```
public boolean addAttribute(XBRLAttribute attr)
```
    Adds the attribute.
    
    Parameters:
    
    attr - the attr
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            javax.xml.namespace.QName qnValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    qnValue - the qn value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.value.QNameValue qnValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    qnValue - the qn value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.type.SimpleType type,
                            net.sf.saxon.om.GroundedValue gValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    type - the type
    
    gValue - the g value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.value.BooleanValue booleanValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    booleanValue - the boolean value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.type.SimpleType type,
                            net.sf.saxon.om.GroundedValue gValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    type - the type
    
    gValue - the g value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.value.BooleanValue booleanValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    booleanValue - the boolean value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.value.QNameValue qnameValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    qnameValue - the QNameValue value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            javax.xml.namespace.QName qnameValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    qnameValue - the QNameValue value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.value.AnyURIValue uriValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    uriValue - the uri value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.value.StringValue strValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    strValue - the str value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.value.DecimalValue decimalValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    decimalValue - the decimal value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            net.sf.saxon.value.AtomicValue atomicValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    atomicValue - the atomic value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.value.DoubleValue doubleValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    doubleValue - the double value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            net.sf.saxon.value.IntegerValue integerValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    integerValue - the integer value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            boolean booleanValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    booleanValue - the boolean value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            java.net.URI uriValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    uriValue - the uri value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(javax.xml.namespace.QName attrName,
                            java.lang.String strValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    strValue - the str value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(java.lang.String attrName,
                            java.lang.String attrValue)
```
    Adds the attribute.
    
    Parameters:
    
    attrName - the attr name
    
    attrValue - the attr value
    
    Returns:
    
    true, if successful
  - addAttribute
```
public boolean addAttribute(net.sf.saxon.type.SchemaType schemaType,
                            java.lang.String attrName,
                            java.lang.String attrValue,
                            java.lang.String attrPrefix,
                            java.lang.String attrNamespace)
```
    Adds the attribute.
    
    Parameters:
    
    schemaType - the schema type
    
    attrName - the attr name
    
    attrValue - the attr value
    
    attrPrefix - the attr prefix
    
    attrNamespace - the attr namespace
    
    Returns:
    
    true, if successful
  - addChild
```
public void addChild(XMLFragment f)
```
    Adds a child XMLFragment to this XMLFragment.
    This method shall be overridden by subclasses that knows where the child goes in respect with the children
    
    Parameters:
    
    f - the f
  - addChildArray
```
public void addChildArray(XMLFragment[] childArray)
```
    Adds an array of XMLFragment to this XMLFragment. This method has several limitations
    - Does not supports xml:base or events to update xlink:href values
    - Nodes can be added only at the end of the current nodes
    - Only work with XMLFragment or derived objects. Does not supports comments or processing instructions
    - addIdOfElement is not supported when parent document is not XBRLDocument
    Parameters:
    
    childArray - the child array
  - addChildAt
```
public void addChildAt(XMLFragment f,
                       int pos)
```
    Adds a child XMLFragment to this XMLFragment at index position.
    This method shall be overridden by subclasses that knows where the child goes in respect with the children
    
    Parameters:
    
    f - the f
    
    pos - the pos
  - findPosition
```
public int findPosition(java.util.Collection<java.lang.Class<? extends XMLFragment>> nodeSeq)
```
    This method finds the position of the child node on this node after searching for nodes in the nodeSeq sequence. For instance in order to find the position of a linkbaseRef element in an instance, this method shall be called with an array including XBRLSchemaRef.class and XBRLLinkbaseRef.class. The method will find all children nodes from the first node and will check if the nodes are schemaRef, then it will search for linkbaseRef and at the end of the last linkbaseRef the position will be returned
    
    Parameters:
    
    nodeSeq - sequence of node types to search
    
    Returns:
    
    integer, node position of the new node. Always >= 0
    
    See Also:
    
    findFirstNodeOfClass(Collection), childExists(NodeImpl)
  - findFirstNodeOfClass
```
public <T> T findFirstNodeOfClass(java.util.Collection<java.lang.Class<? extends XMLFragment>> nodeSeq)
```
    This method finds a node using a sequence of node classes. For instance in order to find the position of a role type, the annotation node must be used and in turn inside the annotation node the appinfo node must be used. This method is used to search for the existence of an annotation inside a schema and to find an appinfo inside the annotation. It returns null if the node is not found or the node if it is found.
    Note: the last node in the nodeSeq parameter must match the return type
    
    Type Parameters:
    
    T - the generic type
    
    Parameters:
    
    nodeSeq - the node seq
    
    Returns:
    
    the first node matching node class after traversing the sequence or null
    
    See Also:
    
    findPosition(Collection), childExists(NodeImpl)
  - createComment
```
public static net.sf.saxon.tree.linked.CommentImpl createComment(java.lang.String commentValue)
```
    Creates a comment node from a String.
    
    Parameters:
    
    commentValue - the comments value
    
    Returns:
    
    the Comment node
  - replace
```
public void replace(XMLFragment node)
```
    Replaces this fragment in the XML tree with another node. The old node can be garbage collected
    
    Parameters:
    
    node - the node that will be replaced
  - replaceChild
```
public void replaceChild(XMLFragment oldFragment,
                         XMLFragment newFragment)
```
    Replaces a child fragment with a new child fragment. FIXME: when oldFragment is null, newFragment is added at the end of parentFragment. This might not always be right.
    
    Parameters:
    
    oldFragment - the old child fragment, can be null if newFragment does not replace an existing fragment
    
    newFragment - the new child fragment, can be null, oldFragment will be deleted
  - replaceStringValue
```
public void replaceStringValue(java.lang.CharSequence stringValue)
```
    Better use setValue(...). For internal use only.
    
    Specified by:
    
    replaceStringValue in interface net.sf.saxon.om.MutableNodeInfo
    
    Overrides:
    
    replaceStringValue in class net.sf.saxon.tree.linked.ElementImpl
    
    Parameters:
    
    stringValue - the new string value
  - resetElements
```
public void resetElements()
```
    Removes all child nodes from this node and resets the cached hash if the call to isChangeHashEnabled() returns true.
  - removeChild
```
public void removeChild(XMLFragment f)
```
    Removes an XMLFragment from the list of children elements of this resource.
    
    Parameters:
    
    f - the f
  - removeChildNode
```
public static void removeChildNode(net.sf.saxon.tree.linked.NodeImpl nodeParent,
                                   net.sf.saxon.tree.linked.NodeImpl childNode)
```
    Removes a child node from the list of children elements of this resource.
    
    Parameters:
    
    nodeParent - the parent node
    
    childNode - the node to removed
  - xEqual
```
public static boolean xEqual(net.sf.saxon.value.AtomicValue param1,
                             net.sf.saxon.value.AtomicValue param2,
                             boolean bXBRLSpecCompliant)
```
    Performs the x-equality comparison of two strings as indicated in the XBRL 2.1 specification
    
    Parameters:
    
    param1 - the param1
    
    param2 - the param2
    
    bXBRLSpecCompliant - The functions specification requires this parameter to be set to false because the comformance suite of the functions specification IS NOT XBRL 2.1 compliant. If this value is set to false, strings are trim() before comparison. if this parameter is set to true this value obtained as it appears in the XML node (as indicated in secion 4.10 of the XBRL 2.1 specification).
    
    Returns:
    
    true, if successful
    
    Since:
    
    2.7.0
  - setRawParentXBRL
```
public boolean setRawParentXBRL(XMLFragment parent)
```
    Sets the parent of this node to the specific XMLFragment.
    
    Parameters:
    
    parent - the new parent
    
    Returns:
    
    true if the parent is different from previous parent and the new parent is set
  - getParentXBRL
```
public XMLFragment getParentXBRL()
```
    The parent XMLFragment node of this XMLFragment node.
    For Document nodes the returned value is null
    For Embedded document nodes, the returned value is the parent element node.
    
    Returns:
    
    the parent XMLFragment possible parents are: XBRLItem, XBRLTuple, XBRLImport, XBRLLinkbase, XBRLExtendedLink, XBRLDocumentation, XBRLRelationship, XBRLResource.
  - getParentDocument
```
public XBRLDocument getParentDocument()
```
    Access to the parent document for this node. This is always an instance of XBRLInstance, XBRLTaxonomy or XBRLLinkbase. Dealing with embedded linkbases raises the question about if a node in an embedded linkbase shall return the XBRLTaxonomy as parent or the XBRLLinkbase as parent. An embedded linkbase is not an instance of XBRLLinkbase because XBRLLinkbase now is not an XMLFragment. so it is NOT possible to return a proper XBRLDocument This means, a XBRLTaxonomy shall be returned This method return null when the XMLFragment is isolated outside a tree that contains an enclosing DocumentImpl
    
    Returns:
    
    the parent document
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Frees-up used memory
    This method should not be invoqued on live objects in the DTS. It is automatically invoqued by the API when an object is no longer used and referenced by other objects. It is save not to call it directly.
    
    Throws:
    
    java.lang.Throwable - the throwable
  - isDead
```
public boolean isDead()
```
    Returns true if the clear method has been called on this object. This method can be used to detect if an object contains valid references to other objects or if all references are no longer valid.
    
    Returns:
    
    boolean value, 'true' if the object may contain invalid references to other objects
  - isNil
```
public boolean isNil()
```
    Return true if the fact is nil it MUST contain a @xsi:nil attribute with value = true.
    
    Returns:
    
    boolean
    
    See Also:
    
    XMLElementDefinition.getNillable()
  - isEmpty
```
public boolean isEmpty()
```
    Returns true when this XMLFragment has no children XMLFragments.
    
    Returns:
    
    boolean value
  - setNil
```
public boolean setNil(boolean newValue)
```
    Sets the nil attribute to true or false according to the param value.
    
    Parameters:
    
    newValue - the new nil
    
    Returns:
    
    true if the nil property changed. False if there was no change
  - equalXdmValues
```
public static boolean equalXdmValues(net.sf.saxon.s9api.XdmValue val,
                                     net.sf.saxon.s9api.XdmValue val2,
                                     AtomicComparerHelper ach)
```
    Compares two XdmValue objects and returns true if both are the same atomicValues or the same XML nodes. This method uses s_equal2(Item, Item, true, null, ach) to compare nodes and s_equal2(Sequence, Sequence) for comparing values.
    
    Parameters:
    
    val - XdmValue
    
    val2 - XdmValue
    
    ach - the AtomicComparerHelper instance, will be passed as parameter to s_equal2(Item, Item, true, null, ach)
    
    Returns:
    
    boolean
    
    See Also:
    
    s_equal2(Item, Item, boolean, DTSContainer, AtomicComparerHelper), s_equal2(Sequence, Sequence)
  - s_equal2
```
public static boolean s_equal2(net.sf.saxon.om.Item item1,
                               net.sf.saxon.om.Item item2)
```
    Compares two Item instances for equality.
    
    Parameters:
    
    item1 - the item1
    
    item2 - the item2
    
    Returns:
    
    true, if successful
  - s_equal2
```
public static boolean s_equal2(net.sf.saxon.om.Sequence item1,
                               net.sf.saxon.om.Sequence item2)
```
    Compares two Item instances for equality.
    
    Parameters:
    
    item1 - the item1
    
    item2 - the item2
    
    Returns:
    
    true, if successful
  - getNamespaceBinding
```
public net.sf.saxon.om.NamespaceBinding getNamespaceBinding()
```
    Gets the namespace binding.
    
    Returns:
    
    the namespace binding
  - getElement
```
public XMLFragment getElement(javax.xml.namespace.QName nodeName)
```
    Gets the element.
    
    Parameters:
    
    nodeName - the node name
    
    Returns:
    
    the element
  - getElement
```
public XMLFragment getElement(java.lang.String nodeName,
                              java.lang.String namespace)
```
    Gets the element.
    
    Parameters:
    
    nodeName - the node name
    
    namespace - the namespace
    
    Returns:
    
    the element
  - addComment
```
public void addComment(java.lang.String commentValue)
```
    Adds the comment.
    
    Parameters:
    
    commentValue - the comment value
  - removeNamespace
```
public void removeNamespace(net.sf.saxon.om.NamespaceBinding oldNs)
```
    Removes the namespace.
    
    Parameters:
    
    oldNs - the old ns
  - reindex
```
public void reindex(int newIndex)
```
    Re sets index number of all children nodes
    There is a bug in saxonica when elements are deleted from a node. While the number of nodes is more than one and the children array exists, the indexes are OK. When two elements are in the children array, the first one is index number 0 and the second one is index number 1 and the first one is deleted, the array is converted into a single element (the one with reference 1) but the index number is not updated from 1 to 0
    A call to reindex takes care of this bug
    
    Parameters:
    
    newIndex - the new index
  - setDirty
```
public void setDirty()
```
    Sets the document is dirty and the XML nodes must be rebuild on the next call to updateXML.
  - isHashDependsOnAtribute
```
public boolean isHashDependsOnAtribute(javax.xml.namespace.QName attributeName)
```
    returns true if the hashCode depends on this attribute name. It is safe to return always true but might generate excesive calls to resetHash(). If it is well known that this attribute is not used in the hashCode calculation then it is better to return false.
    This method shall be overridden by sub classes
    
    Parameters:
    
    attributeName - the attribute name
    
    Returns:
    
    boolean value
  - isChangeHashEnabled
```
public boolean isChangeHashEnabled()
```
    Checks if is change hash enabled.
    
    Specified by:
    
    isChangeHashEnabled in interface HasChangeHashSupport
    
    Returns:
    
    true, if is change hash enabled
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener.
    
    Specified by:
    
    addPropertyChangeListener in interface HasChangeHashSupport
    
    Parameters:
    
    propertyName - the property name
    
    listener - the listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener.
    
    Specified by:
    
    removePropertyChangeListener in interface HasChangeHashSupport
    
    Parameters:
    
    propertyName - the property name
    
    listener - the listener
  - firePropertyChangeEvent
```
public void firePropertyChangeEvent(java.lang.String propertyName,
                                    java.lang.Object oldValue,
                                    java.lang.Object newValue)
```
    Fire property change event.
    
    Specified by:
    
    firePropertyChangeEvent in interface HasChangeHashSupport
    
    Parameters:
    
    propertyName - the property name
    
    oldValue - the old value
    
    newValue - the new value
  - getPropertyChangeListeners
```
public java.util.Set<java.beans.PropertyChangeListener> getPropertyChangeListeners(java.lang.String propertyName)
```
    Returns a set of PropertyChangeListeners registered for the corresponding propertyName.
    
    Parameters:
    
    propertyName - as string
    
    Returns:
    
    set of PropertyChangeListener, it might be the empty set if no PropertyChangeListener are registered
    
    Since:
    
    3.3.1
  - 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 XMLFragment

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

Field Detail

ADD_NAMESPACE_INHERIT

XPOINTER

XPATH

NO_POSITION

SOURCE_DOCUMENT

CONCEPT_QNAME

CONCEPT_LABEL

FACT_QNAME

FACT_CONCEPT_LABEL

FACT_CONCEPT_DATATYPE

SHORT_TEXT

ELEMENT_LABEL

EASY_TO_READ

HIDE_COMMON_ACCURACY

FACT_VALUE

RELATIONSHIP_TYPE

RESOURCE_TYPE

PERIOD_TYPE

PERIOD_VALUE

PERIOD_BOP

idQName

nil

langQName

baseQName

EMPTYRELATIONSHIPSITERATORINSTANCE

EMPTYXMLFRAGMENTITERATORINSTANCE

OrderComparator

OrderComparatorReverse

OrderComparator2

Constructor Detail

XMLFragment

XMLFragment

XMLFragment

XMLFragment

XMLFragment

XMLFragment

XMLFragment

XMLFragment

Method Detail

childExists

addChildNodeAt

addChildNode

addChildNodeArray

addChildNodeInBatch

commitBatch

objHashCode

objEquals

delete

getInScopeNamespaces

clone

clone

getConfiguration

getNamePool

setChildrenClone

toString

getFriendlyName

getFriendlyName

getToolTipText

getFriendlyName

getXPathToRoot

getContainerDocumentURI

generateLocatorToNode

getDocument

internalToString

moveNamespacesUp

copy

getContainer

getValue

getQNameValue