com.ihr.xbrl.om.exLinks

Class XBRLArcroleRef

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.XBRLSimpleLink

com.ihr.xbrl.om.exLinks.XBRLArcroleRef

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

public class XBRLArcroleRef
extends XBRLSimpleLink

The Class XBRLArcroleRef.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	arcroleURI The q arcrole uri.
static net.sf.saxon.om.StructuredQName	sqnStandardArcroleRefQName The Constant sqnStandardArcroleRefQName.
static javax.xml.namespace.QName	standardArcroleRefQName This is 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
XBRLArcroleRef(DTSContainer dts, XBRLArcroleType arcrole) Instantiates a new XBRL arcrole ref.
XBRLArcroleRef(XMLFragment node) Instantiates a new XBRL arcrole ref.

Method Summary

Modifier and Type	Method and Description
XBRLArcroleRef	clone() Clone.
XBRLArcroleRef	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object obj) Equals.
XBRLArcroleRef	generateNode() Generate node.
XBRLArcroleType	getArcroleType() Gets the arcrole type.
java.net.URI	getArcroleURI() Gets the arcrole uri.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
boolean	hasChildNodes()
int	hashCode() Hash code.

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

clear, getActuate, getArcrole, getAttributes, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, 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

standardArcroleRefQName

public static final javax.xml.namespace.QName standardArcroleRefQName

This is the element name of standard locators.

sqnStandardArcroleRefQName

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

The Constant sqnStandardArcroleRefQName.

arcroleURI

public static javax.xml.namespace.QName arcroleURI

The q arcrole uri.

Constructor Detail

XBRLArcroleRef

public XBRLArcroleRef(XMLFragment node)

Instantiates a new XBRL arcrole ref.

Parameters:

node - the node

XBRLArcroleRef

public XBRLArcroleRef(DTSContainer dts,
                      XBRLArcroleType arcrole)

Instantiates a new XBRL arcrole ref.

Parameters:

dts - the dts

arcrole - the arcrole

Method Detail

clone

public XBRLArcroleRef clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL arcrole ref

clone

public XBRLArcroleRef clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL arcrole ref

hashCode

public int hashCode()

Hash code.

Specified by:

hashCode in interface net.sf.saxon.om.NodeInfo

Overrides:

hashCode in class XLinkElement

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Specified by:

equals in interface net.sf.saxon.om.NodeInfo

Overrides:

equals in class XLinkElement

Parameters:

obj - the obj

Returns:

true, if successful

getArcroleURI

public java.net.URI getArcroleURI()
                           throws XBRLValidationException

Gets the arcrole uri.

Note, this method is not used internally in the API to avoid having to deal with XBRLRuntimeExceptions caused by invalid URIs. Use getAttributeValue(XBRLArcroleRef.arcroleURI) instead that returns a string and performs no validation at all

Returns:

the arcrole uri

Throws:

XBRLValidationException - the XBRL validation exception

getArcroleType

public XBRLArcroleType getArcroleType()

Gets the arcrole type.

Returns:

the arcrole type

generateNode

public XBRLArcroleRef generateNode()
                            throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XLinkElement

Returns:

the XBRL arcrole ref

Throws:

XBRLSerializationException - the XBRL serialization exception

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