com.ihr.xbrl.om.exLinks
Class XBRLLocator

java.lang.Object
  com.ihr.xbrl.om.XMLFragment
      com.ihr.xbrl.om.exLinks.XLinkElement
          com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship
              com.ihr.xbrl.om.exLinks.XBRLLocator

All Implemented Interfaces:

XBRLRelationshipPoint, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

public class XBRLLocator
extends XBRLPointerOfARelationship

This is not part of the XBRL Infoset. Locators are auxiliary objects.

Author:

Ignacio

Field Summary

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

actuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, type, TYPE

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

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Constructor Summary

XBRLLocator(DTSContainer dts, net.sf.saxon.s9api.XdmNode node)

XBRLLocator(XBRLArc arc, net.sf.saxon.s9api.XdmNode node)

XBRLLocator(XMLFragment reference)

Method Summary

XBRLArc	getArc() Access to the [parent] property
XMLDocumentURI	getHRefDocument() Obtains the document this locator is pointing to.
XBRLExtendedLink	getParent() The parent XMLFragment node of this XMLFragment node.
XMLFragment	getReference() Access to the [Reference] property.
boolean	isStandardLoc() Returns true if the surrounding node is a link:loc returns false if this object is in the substitution group of link:loc but not a link:loc

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

generateNode, getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setRole, setShow, setSType, setTitle, setTo

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

addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clear, clone, clone, delAttribute, delAttribute, equals, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributes, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getElements, getFragment, getFriendlyName, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, hashCode, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setId, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setValue, setVariablesDefined, toString, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XBRLLocator

public XBRLLocator(DTSContainer dts,
                   net.sf.saxon.s9api.XdmNode node)

XBRLLocator

public XBRLLocator(XBRLArc arc,
                   net.sf.saxon.s9api.XdmNode node)

XBRLLocator

public XBRLLocator(XMLFragment reference)

Method Detail

getArc

public XBRLArc getArc()

Access to the [parent] property

Returns:

XBRLArc

getParent

public XBRLExtendedLink getParent()

Description copied from class: XMLFragment

The parent XMLFragment node of this XMLFragment node.

For XBRLAttribute nodes, the parent is the element node.

For Document nodes the returned value is null

For Embedded document nodes, the returned value is the parent element node.

Specified by:

getParent in interface XMLHasParent

Overrides:

getParent in class XMLFragment

Returns:

the parent XMLFragment possible parents are: XBRLItem, XBRLTuple, XBRLImport, XBRLLinkbase, XBRLExtendedLink, XBRLDocumentation, XBRLRelationship, XBRLResource.

getReference

public XMLFragment getReference()
                         throws XBRLValidationException

Access to the [Reference] property.

Returns:

XMLFragment

Throws:

XBRLValidationException

getHRefDocument

public XMLDocumentURI getHRefDocument()
                               throws XBRLValidationException

Obtains the document this locator is pointing to. The fragment is not returned by this method If the locator is not a link:loc then the document is loaded in a new DTSContainer

Returns:

XMLDocumentURI

Throws:

XBRLValidationException

isStandardLoc

public boolean isStandardLoc()

Returns true if the surrounding node is a link:loc returns false if this object is in the substitution group of link:loc but not a link:loc

Returns:

boolean