com.ihr.xbrl.om.exLinks

Class XBRLArc

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

All Implemented Interfaces:

HasDTSContainer, XBRLGlueInterface, 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 XBRLArc
extends XLinkElement
implements XBRLGlueInterface, java.io.Serializable

The Class XBRLArc.

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 com.ihr.xbrl.om.exLinks.XBRLArc.PriorityOrderComparator	ArcPriorityAndUseComparatorInstance The Constant ArcPriorityOrderComparatorInstance.
static int	OPTIONAL The Constant OPTIONAL.
static int	PROHIBITED The Constant PROHIBITED.

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
XBRLArc(DTSContainer dts) Instantiates a new XBRL arc.
XBRLArc(XBRLExtendedLink parent, XMLFragment node, java.lang.Integer arcroleTypeCode) Creates a new XBRLArc with a surrounding node and replaces surrounding node with this new XBRLArc instance.
XBRLArc(XMLFragment node, java.lang.Integer arcroleTypeCode) Creates a new XBRLArc with a surrounding node but does not replaces the node with the new arc.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLArc	clone() Clone.
XBRLArc	clone(DTSContainer newDTS) Clone.
static boolean	compareTwoArcs(XBRLArc arc1, XBRLArc arc2) Compare two arcs and returns true if both are duplicates.
static boolean	compareTwoLocatorSets(java.util.List<XMLFragment> set1, java.util.List<XMLFragment> set2) Compare two locator sets.
boolean	equals(java.lang.Object obj) Equals.
XBRLArc	generateNode() Generate node.
java.util.Iterator<XBRLAttribute>	getAttributes() Access to the [Attributes] property.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers) Gets the friendly name.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
int	getNumberOfObjectsFrom() Returns the number of objects in the [To] property.
int	getNumberOfObjectsTo() Returns the number of objects in the [From] property.
java.util.Iterator<XMLFragment>	getObjectsFrom() Access to the [From relationship Information Items] property The first time the method is called the objectsFrom Vector is created and data obtained from the DTS.
java.util.Iterator<XMLFragment>	getObjectsTo() Access to the [From relationship Information Items] property.
java.lang.Double	getOrder() Access to the [Order] property.
XBRLExtendedLink	getParentXBRL() Access to the [Parent] property.
int	getPriority() Gets the priority.
java.util.Iterator<XBRLRelationship>	getRelationships() Gets the relationships.
int	getUse() Access to the value of the use attribute on arcs.
boolean	hasChildNodes()
boolean	isSameNodeInfo(net.sf.saxon.om.NodeInfo other) Must be overridden to properly compare a relationship with an arc when the arc contains more than one surrounding relationships and for that reason the arc has not been converted to an XBRLRelationship.
void	removeFrom(XMLFragment ref) Removes the from.
void	removeTo(XMLFragment ref) Removes the to.
void	setArcroleTypeCode(java.lang.Integer code) This method sets the arcrole type using the arcrole code.

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

getActuate, getArcrole, 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, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, 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, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ArcPriorityAndUseComparatorInstance

public static final com.ihr.xbrl.om.exLinks.XBRLArc.PriorityOrderComparator ArcPriorityAndUseComparatorInstance

The Constant ArcPriorityOrderComparatorInstance.

OPTIONAL

public static final int OPTIONAL

The Constant OPTIONAL.

See Also:

Constant Field Values

PROHIBITED

public static final int PROHIBITED

The Constant PROHIBITED.

See Also:

Constant Field Values

Constructor Detail

XBRLArc

public XBRLArc(XBRLExtendedLink parent,
               XMLFragment node,
               java.lang.Integer arcroleTypeCode)

Creates a new XBRLArc with a surrounding node and replaces surrounding node with this new XBRLArc instance.

Parameters:

parent - XBRLExtendedLink

node - NodeInfo

arcroleTypeCode - the arcrole type code

XBRLArc

public XBRLArc(DTSContainer dts)

Instantiates a new XBRL arc.

Parameters:

dts - the dts

XBRLArc

public XBRLArc(XMLFragment node,
               java.lang.Integer arcroleTypeCode)

Creates a new XBRLArc with a surrounding node but does not replaces the node with the new arc. This constructor is used only by the EFM validator that works with the surrounding arcs during the validation process and from the FRTA validation when creating a new error message

Parameters:

node - NodeInfo

arcroleTypeCode - the arcrole type code

Method Detail

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XLinkElement

Throws:

java.lang.Throwable - the throwable

clone

public XBRLArc clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL arc

clone

public XBRLArc clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL arc

getParentXBRL

public XBRLExtendedLink getParentXBRL()

Access to the [Parent] property. This is the XBRLExtendedLink object this arc belongs to The XBRLExtendedLink is independent from the Linkbase it is serialized. There is one XBRLExtendedLink per XBRLRole

Overrides:

getParentXBRL in class XMLFragment

Returns:

XBRLExtendedLink

getUse

public int getUse()

Access to the value of the use attribute on arcs. It may be either OPTIONAL or PROHIBITED. return the default value "OPTIONAL" if not set.

Specified by:

getUse in interface XBRLGlueInterface

Returns:

int

getPriority

public int getPriority()

Gets the priority.

Specified by:

getPriority in interface XBRLGlueInterface

Returns:

the priority

getOrder

public java.lang.Double getOrder()

Access to the [Order] property. return 1.0 (the default value) if there is no order attribute or the value instead

Returns:

Double

getAttributes

public java.util.Iterator<XBRLAttribute> getAttributes()

Access to the [Attributes] property.

Specified by:

getAttributes in interface XBRLGlueInterface

Overrides:

getAttributes in class XLinkElement

Returns:

Iterator

See Also:

XMLFragment.getAllAttributes()

getObjectsFrom

public java.util.Iterator<XMLFragment> getObjectsFrom()
                                               throws XBRLValidationException

Access to the [From relationship Information Items] property The first time the method is called the objectsFrom Vector is created and data obtained from the DTS. XBRLLocators are auxiliary objects and never stored in the Vector. The XMLDocument the locator is pointing to is stored in the Vector Also, the referenced object is signaled that participates in a relationship.

Specified by:

getObjectsFrom in interface XBRLGlueInterface

Returns:

Iterator

Throws:

XBRLValidationException - the XBRL validation exception

getNumberOfObjectsFrom

public int getNumberOfObjectsFrom()
                           throws XBRLValidationException

Returns the number of objects in the [To] property. If the [To] property is not initialized this method forces to calculate it

Returns:

int

Throws:

XBRLValidationException - the XBRL validation exception

getNumberOfObjectsTo

public int getNumberOfObjectsTo()
                         throws XBRLValidationException

Returns the number of objects in the [From] property. If the [From] property is not initialized this method forces to calculate it

Returns:

int

Throws:

XBRLValidationException - the XBRL validation exception

removeFrom

public void removeFrom(XMLFragment ref)

Removes the from.

Parameters:

ref - the ref

getObjectsTo

public java.util.Iterator<XMLFragment> getObjectsTo()
                                             throws XBRLValidationException

Access to the [From relationship Information Items] property.

Specified by:

getObjectsTo in interface XBRLGlueInterface

Returns:

Iterator

Throws:

XBRLValidationException - the XBRL validation exception

removeTo

public void removeTo(XMLFragment ref)

Removes the to.

Parameters:

ref - the ref

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

isSameNodeInfo

public boolean isSameNodeInfo(net.sf.saxon.om.NodeInfo other)

Must be overridden to properly compare a relationship with an arc when the arc contains more than one surrounding relationships and for that reason the arc has not been converted to an XBRLRelationship.

Specified by:

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

Overrides:

isSameNodeInfo in class net.sf.saxon.tree.linked.NodeImpl

Parameters:

other - the other

Returns:

true, if is same node info

compareTwoArcs

public static boolean compareTwoArcs(XBRLArc arc1,
                                     XBRLArc arc2)
                              throws XBRLValidationException

Compare two arcs and returns true if both are duplicates.

Parameters:

arc1 - XBRLArc

arc2 - XBRLArc

Returns:

boolean

Throws:

XBRLValidationException - the XBRL validation exception

compareTwoLocatorSets

public static boolean compareTwoLocatorSets(java.util.List<XMLFragment> set1,
                                            java.util.List<XMLFragment> set2)

Compare two locator sets.

Parameters:

set1 - the set1

set2 - the set2

Returns:

true, if successful

getRelationships

public java.util.Iterator<XBRLRelationship> getRelationships()
                                                      throws XBRLValidationException

Gets the relationships.

Returns:

Iterator

Throws:

XBRLValidationException - the XBRL validation exception

generateNode

public XBRLArc generateNode()
                     throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XLinkElement

Returns:

the XBRL arc

Throws:

XBRLSerializationException - the XBRL serialization exception

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

Returns:

the friendly name

setArcroleTypeCode

public void setArcroleTypeCode(java.lang.Integer code)

This method sets the arcrole type using the arcrole code. This method is called during the SAX parsing phase to accelerate DTSLoading

Parameters:

code - the new arcrole type code

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