com.ihr.xbrl.om.exLinks

Class XBRLLocator

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLLocator

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

public class XBRLLocator
extends XBRLPointerOfARelationship
implements XBRLValidation

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

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

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

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static net.sf.saxon.om.StructuredQName	sqnStandardLocQName The Constant sqnStandardLocQName.
static javax.xml.namespace.QName	standardLocQName This is link:loc the element name of standard locators .

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

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, type, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

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

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

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

NODE_LETTER

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLLocator(DTSContainer dts) Instantiates a new XBRL locator.
XBRLLocator(XBRLArc arc, XMLFragment node) Instantiates a new XBRL locator.
XBRLLocator(XMLFragment niLoc) Instantiates a new XBRL locator.
XBRLLocator(XMLFragment parent, XMLFragment reference) Instantiates a new XBRL locator.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLLocator	clone() Clone.
XBRLLocator	clone(DTSContainer newDTS) Clone.
XBRLArc	getArc() Access to the [parent] property.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLRoleType	getRoleType() Access to the [Role Type] property The resource is validated against the content of the roleType information Return null if no roleType exist on resource.
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isOnValidation() Checks if is on validation.
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 .
void	setRoleType(XBRLRoleType role) Sets the role type.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Validate.
void	validateNotEmptyHref(java.net.URI href) Validate not empty href.

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

equals, generateNode, getActuate, getArcrole, getAttributes, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, hashCode, isHashDependsOnAtribute, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setRole, setShow, setSType, setTitle, setTo, validateXPointer

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

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFriendlyName, getFriendlyName, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setId, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

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

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

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

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

standardLocQName

public static final javax.xml.namespace.QName standardLocQName

This is link:loc the element name of standard locators .

sqnStandardLocQName

public static final net.sf.saxon.om.StructuredQName sqnStandardLocQName

The Constant sqnStandardLocQName.

Constructor Detail

XBRLLocator

public XBRLLocator(DTSContainer dts)

Instantiates a new XBRL locator.

Parameters:

dts - the dts

XBRLLocator

public XBRLLocator(XBRLArc arc,
                   XMLFragment node)

Instantiates a new XBRL locator.

Parameters:

arc - the arc

node - the node

XBRLLocator

public XBRLLocator(XMLFragment parent,
                   XMLFragment reference)

Instantiates a new XBRL locator.

Parameters:

parent - the element that will be the locator parent.

reference - the reference where the locator will point to

XBRLLocator

public XBRLLocator(XMLFragment niLoc)

Instantiates a new XBRL locator.

Parameters:

niLoc - the ni loc

Method Detail

getArc

public XBRLArc getArc()

Access to the [parent] property.

Returns:

XBRLArc

validateNotEmptyHref

public void validateNotEmptyHref(java.net.URI href)
                          throws XBRLValidationExceptionInvalidEmptyHRef

Validate not empty href.

Parameters:

href - the href

Throws:

XBRLValidationExceptionInvalidEmptyHRef - the XBRL validation exception invalid empty h ref

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

getRoleType

public XBRLRoleType getRoleType()

Access to the [Role Type] property The resource is validated against the content of the roleType information Return null if no roleType exist on resource.

Returns:

XBRLRoleType

setRoleType

public void setRoleType(XBRLRoleType role)

Sets the role type.

Parameters:

role - the new role type

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the validation report

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Validate.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the proc

Returns:

the XBRL validation report

invalidate

public void invalidate()

Invalidate.

Specified by:

invalidate in interface XBRLValidation

invalidate

public boolean invalidate(XBRLValidation.Direction dir)

Invalidate.

Specified by:

invalidate in interface XBRLValidation

Parameters:

dir - the dir

Returns:

true, if successful

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XLinkElement

Throws:

java.lang.Throwable - the throwable

clone

public XBRLLocator clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL locator

clone

public XBRLLocator clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL locator

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