com.ihr.xbrl.om.taxonomy

Class XBRLArcroleType

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.taxonomy.XBRLRoleAndArcroleTypes

com.ihr.xbrl.om.taxonomy.XBRLArcroleType

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<XBRLRoleAndArcroleTypes>, 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 XBRLArcroleType
extends XBRLRoleAndArcroleTypes
implements java.io.Serializable

This class represents an arcrole type definition in a DTS.

An arcrole type definition can be of 3 types:

1. Static: defined in the XBRL 2.1 specification without a real declaration of link:arcroleType
2. Regular: defined in a taxonomy schema and declared using link:arcroleType and referenced from a linkbase using link:arcroleRef
3. Virtual: used in a linkbase that is not generic linkbase and not a linkbase defined in the XBRL 2.1 specification and not declared using link:arcroleType

The XBRL 2.1 specification defines 3 possible values for the cycles on networks using arcroleTypes. This type defines constants ANY, UNDIRECTED and NONE as possible values for the cycles Allowed property of an arcrole type definition.

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 int	ANY ANY cycle is allowed (bitmap), DIRECTED and UNDIRECTED
static javax.xml.namespace.QName	arcroleAttribute The Constant arcroleAttribute.
static javax.xml.namespace.QName	arcroleTypeQName The Constant arcroleTypeQName.
static javax.xml.namespace.QName	cyclesAllowedAttribute The Constant cyclesAllowedAttribute.
static int	NONE NONE (no) cycles are allowed, this includes DIRECTED and UNDIRECTED cycles detection.
static net.sf.saxon.om.StructuredQName	sqnArcroleTypeQName The Constant sqnArcroleTypeQName.
static XBRLArcroleType	STANDARD_CONCEPT_LABEL The standard concept label.
static XBRLArcroleType	STANDARD_CONCEPT_REFERENCE The standard concept reference.
static XBRLArcroleType	STANDARD_ESSENCE_ALIAS The standard essence alias.
static XBRLArcroleType	STANDARD_FACT_FOOTNOTE Static arcroles.
static XBRLArcroleType	STANDARD_GENERAL_SPECIAL The standard general special.
static XBRLArcroleType	STANDARD_PARENT_CHILD The standard parent child.
static XBRLArcroleType	STANDARD_REQUIRES_ELEMENT The standard requires element.
static XBRLArcroleType	STANDARD_SIMILAR_TUPLES The standard similar tuples.
static XBRLArcroleType	STANDARD_SUMMATION_ITEM The standard summation item.
static int	UNDIRECTED UNDIRECTED cycles are allowed (bitmap).

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
XBRLArcroleType(DTSContainer dts, boolean virtual) Used to create virtual arcrole types.
XBRLArcroleType(DTSContainer dts, java.lang.String uri, int cyclesAllowed) Creates a new XBRLArcroleType for the specific values of the uri and cyclesAllowed.
XBRLArcroleType(DTSContainer newDTS, XBRLArcroleType other) Instantiates a new XBRL arcrole type.
XBRLArcroleType(XMLFragment node) Creates a new XBRLArcroleType object from a node in a file.

Method Summary

Modifier and Type	Method and Description
boolean	addUse(XBRLRelationship rel) Adds the use.
void	clear() Frees-up the memory used by this object.
XBRLArcroleType	clone() Clone.
XBRLArcroleType	clone(DTSContainer dts) Clone.
boolean	delUse(XBRLRelationship rel) Del use.
boolean	equals(java.lang.Object other) Equals.
XBRLArcroleType	generateNode() Generate node.
XBRLArcroleRef	getArcroleRef(DTSContainer dts) Creates an XBRLArcroleRef object that points to this arcroleRef and that can be serialized.
int	getCyclesAllowed() Returns an integer constant according to the value of the cyclesAllowed attribute on the arcrole type definition.
static java.lang.String	getCyclesAllowed(int code) Gets the cycles allowed.
static java.lang.Integer	getCyclesAllowed(java.lang.String code) Gets the cycles allowed.
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()
java.util.Iterator<XBRLRelationship>	getUses() Access to the [arcrole uses] property The returned objects in the iterator are instances of XBRLRelationship elements.
boolean	hasChildNodes()
int	hashCode() Hash code.
static XBRLArcroleType	make(DTSContainer dts) Make.
void	setCyclesAllowed(int cyclesAllowedCode) Sets the cycles allowed.
void	setCyclesAllowed(java.lang.String cyclesAllowedValue) Sets the cycles allowed.
java.lang.String	toString() To string.

Methods inherited from class com.ihr.xbrl.om.taxonomy.XBRLRoleAndArcroleTypes

addRef, addUsedOn, compareTo, getCode, getDefinition, getElements, getFriendlyName, getHRefURI, getParentDocument, getRoleAndArcroleURI, getUsedOn, getValidationReport, invalidate, invalidate, isOnValidation, isStatic, isUsedOn, isVirtual, removeUsedOn, sameUsedOn, setCode, setDefinition, setId, setRawParentXBRL, setRoleAndArcroleURI, setStatic, setVirtual, validate

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, getAttributes, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, 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, isHashDependsOnAtribute, 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, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

arcroleTypeQName

public static final javax.xml.namespace.QName arcroleTypeQName

The Constant arcroleTypeQName.

sqnArcroleTypeQName

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

The Constant sqnArcroleTypeQName.

arcroleAttribute

public static final javax.xml.namespace.QName arcroleAttribute

The Constant arcroleAttribute.

cyclesAllowedAttribute

public static final javax.xml.namespace.QName cyclesAllowedAttribute

The Constant cyclesAllowedAttribute.

ANY

public static final int ANY

ANY cycle is allowed (bitmap), DIRECTED and UNDIRECTED

See Also:

Constant Field Values

UNDIRECTED

public static final int UNDIRECTED

UNDIRECTED cycles are allowed (bitmap). DIRECTED cycles are not allowed.

See Also:

Constant Field Values

NONE

public static final int NONE

NONE (no) cycles are allowed, this includes DIRECTED and UNDIRECTED cycles detection.

See Also:

Constant Field Values

STANDARD_FACT_FOOTNOTE

public static final XBRLArcroleType STANDARD_FACT_FOOTNOTE

Static arcroles.

STANDARD_CONCEPT_LABEL

public static final XBRLArcroleType STANDARD_CONCEPT_LABEL

The standard concept label.

STANDARD_CONCEPT_REFERENCE

public static final XBRLArcroleType STANDARD_CONCEPT_REFERENCE

The standard concept reference.

STANDARD_PARENT_CHILD

public static final XBRLArcroleType STANDARD_PARENT_CHILD

The standard parent child.

STANDARD_SUMMATION_ITEM

public static final XBRLArcroleType STANDARD_SUMMATION_ITEM

The standard summation item.

STANDARD_GENERAL_SPECIAL

public static final XBRLArcroleType STANDARD_GENERAL_SPECIAL

The standard general special.

STANDARD_ESSENCE_ALIAS

public static final XBRLArcroleType STANDARD_ESSENCE_ALIAS

The standard essence alias.

STANDARD_SIMILAR_TUPLES

public static final XBRLArcroleType STANDARD_SIMILAR_TUPLES

The standard similar tuples.

STANDARD_REQUIRES_ELEMENT

public static final XBRLArcroleType STANDARD_REQUIRES_ELEMENT

The standard requires element.

Constructor Detail

XBRLArcroleType

public XBRLArcroleType(XMLFragment node)
                throws XBRLValidationException

Creates a new XBRLArcroleType object from a node in a file.

Parameters:

node - the node

Throws:

XBRLValidationException - the XBRL validation exception

XBRLArcroleType

public XBRLArcroleType(DTSContainer dts,
                       java.lang.String uri,
                       int cyclesAllowed)

Creates a new XBRLArcroleType for the specific values of the uri and cyclesAllowed. The new arcrole type will be declared as regular arcrole so a taxonomy parent shall be assigned.

Parameters:

dts - the dts

uri - the uri

cyclesAllowed - the cycles allowed

XBRLArcroleType

public XBRLArcroleType(DTSContainer newDTS,
                       XBRLArcroleType other)

Instantiates a new XBRL arcrole type.

Parameters:

newDTS - the new dts

other - the other

XBRLArcroleType

public XBRLArcroleType(DTSContainer dts,
                       boolean virtual)

Used to create virtual arcrole types. Virtual arcrole types exists on extended linkbases that are not standard and not generic linkbases and also has no explicit arcrole type definition and no arcroleRef element is required to point to it

Parameters:

dts - the dts

virtual - the virtual

Method Detail

make

public static XBRLArcroleType make(DTSContainer dts)

Make.

Parameters:

dts - the dts

Returns:

the XBRL arcrole type

clone

public XBRLArcroleType clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL arcrole type

clone

public XBRLArcroleType clone(DTSContainer dts)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

dts - the dts

Returns:

the XBRL arcrole type

addUse

public boolean addUse(XBRLRelationship rel)

Adds the use.

Parameters:

rel - the here

Returns:

true, if successful

delUse

public boolean delUse(XBRLRelationship rel)

Del use.

Parameters:

rel - the rel

Returns:

true, if successful

getUses

public java.util.Iterator<XBRLRelationship> getUses()

Access to the [arcrole uses] property The returned objects in the iterator are instances of XBRLRelationship elements.

Returns:

Iterator

getCyclesAllowed

public int getCyclesAllowed()

Returns an integer constant according to the value of the cyclesAllowed attribute on the arcrole type definition.

• the value 0 means ANY
• the value 1 means UNDIRECTED
• the value 2 means DIRECTED
• the value 3 means NONE

Note that the value 2 is not supported by the XBRL 2.1 specification

Returns:

integer constant

setCyclesAllowed

public void setCyclesAllowed(java.lang.String cyclesAllowedValue)

Sets the cycles allowed.

Parameters:

cyclesAllowedValue - the new cycles allowed

setCyclesAllowed

public void setCyclesAllowed(int cyclesAllowedCode)

Sets the cycles allowed.

Parameters:

cyclesAllowedCode - the new cycles allowed

getCyclesAllowed

public static java.lang.String getCyclesAllowed(int code)

Gets the cycles allowed.

Parameters:

code - the code

Returns:

the cycles allowed

getCyclesAllowed

public static java.lang.Integer getCyclesAllowed(java.lang.String code)

Gets the cycles allowed.

Parameters:

code - the code

Returns:

the cycles allowed

toString

public java.lang.String toString()

To string.

Overrides:

toString in class XMLFragment

Returns:

the string

equals

public boolean equals(java.lang.Object other)

Equals.

Specified by:

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

Overrides:

equals in class XBRLRoleAndArcroleTypes

Parameters:

other - the other

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XBRLRoleAndArcroleTypes

Returns:

the int

getArcroleRef

public XBRLArcroleRef getArcroleRef(DTSContainer dts)

Creates an XBRLArcroleRef object that points to this arcroleRef and that can be serialized.

Parameters:

dts - the dts

Returns:

XBRLArcroleRef

clear

public void clear()
           throws java.lang.Throwable

Frees-up the memory used by this object.

Overrides:

clear in class XBRLRoleAndArcroleTypes

Throws:

java.lang.Throwable - the throwable

generateNode

public XBRLArcroleType generateNode()
                             throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XBRLRoleAndArcroleTypes

Returns:

the XBRL arcrole type

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

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