com.ihr.xbrl.om.taxonomy

Class XBRLRoleType

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

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 XBRLRoleType
extends XBRLRoleAndArcroleTypes
implements java.io.Serializable

Provides the properties of an XBRL Role Type Information Item.

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 javax.xml.namespace.QName	roleAttribute The Constant roleAttribute.
static javax.xml.namespace.QName	roleTypeQName The Constant roleTypeQName.
static net.sf.saxon.om.StructuredQName	sqnRoleTypeQName The Constant sqnRoleTypeQName.
static XBRLRoleType	STANDARD_DOCUMENTATION The standard documentation.
static XBRLRoleType	STANDARD_FOOTNOTE Static roles on resources.
static XBRLRoleType	STANDARD_LABEL The standard label.
static XBRLRoleType	STANDARD_LABEL_COMMENTARY_GUIDANCE The standard label commentary guidance.
static XBRLRoleType	STANDARD_LABEL_DEFINITION_GUIDANCE The standard label definition guidance.
static XBRLRoleType	STANDARD_LABEL_DISCLOSURE_GUIDANCE The standard label disclosure guidance.
static XBRLRoleType	STANDARD_LABEL_EXAMPLE_GUIDANCE The standard label example guidance.
static XBRLRoleType	STANDARD_LABEL_MEASUREMENT_GUIDANCE The standard label measurement guidance.
static XBRLRoleType	STANDARD_LABEL_NEGATIVE The standard label negative.
static XBRLRoleType	STANDARD_LABEL_NEGATIVE_TERSE The standard label negative terse.
static XBRLRoleType	STANDARD_LABEL_NEGATIVE_VERBOSE The standard label negative verbose.
static XBRLRoleType	STANDARD_LABEL_PERIOD_END The standard label period end.
static XBRLRoleType	STANDARD_LABEL_PERIOD_START The standard label period start.
static XBRLRoleType	STANDARD_LABEL_POSITIVE The standard label positive.
static XBRLRoleType	STANDARD_LABEL_POSITIVE_TERSE The standard label positive terse.
static XBRLRoleType	STANDARD_LABEL_POSITIVE_VERBOSE The standard label positive verbose.
static XBRLRoleType	STANDARD_LABEL_PRESENTATION_GUIDANCE The standard label presentation guidance.
static XBRLRoleType	STANDARD_LABEL_TERSE The standard label terse.
static XBRLRoleType	STANDARD_LABEL_TOTAL The standard label total.
static XBRLRoleType	STANDARD_LABEL_VERBOSE The standard label verbose.
static XBRLRoleType	STANDARD_LABEL_ZERO The standard label zero.
static XBRLRoleType	STANDARD_LABEL_ZERO_TERSE The standard label zero terse.
static XBRLRoleType	STANDARD_LABEL_ZERO_VERBOSE The standard label zero verbose.
static XBRLRoleType	STANDARD_LINKBASE_CALCULATION The standard linkbase calculation.
static XBRLRoleType	STANDARD_LINKBASE_DEFINITION The standard linkbase definition.
static XBRLRoleType	STANDARD_LINKBASE_LABEL Static roles on linkbaseRef elements.
static XBRLRoleType	STANDARD_LINKBASE_PRESENTATION The standard linkbase presentation.
static XBRLRoleType	STANDARD_LINKBASE_REFERENCE The standard linkbase reference.
static XBRLRoleType	STANDARD_REFERENCE The standard reference.
static XBRLRoleType	STANDARD_REFERENCE_COMMENTARY The standard reference commentary.
static XBRLRoleType	STANDARD_REFERENCE_DEFINITION The standard reference definition.
static XBRLRoleType	STANDARD_REFERENCE_DISCLOSURE The standard reference disclosure.
static XBRLRoleType	STANDARD_REFERENCE_EXAMPLE The standard reference example.
static XBRLRoleType	STANDARD_REFERENCE_MANDATORY_DISCLOSURE The standard reference mandatory disclosure.
static XBRLRoleType	STANDARD_REFERENCE_MEASUREMENT The standard reference measurement.
static XBRLRoleType	STANDARD_REFERENCE_PRESENTATION The standard reference presentation.
static XBRLRoleType	STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE The standard reference recommended disclosure.
static XBRLRoleType	STANDARD_REFERENCE_UNSPECIFIED_DISCLOSURE The standard reference unspecified disclosure.
static XBRLRoleType	STANDARD_ROLE_URI There is one static definition of the standard role each time a DTSContainer is created a local copy of this object is created in that DTSContainer.
static java.util.Comparator<? super XBRLRoleType>	standardRoleComparator The standard role comparator.

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
XBRLRoleType(DTSContainer dts, boolean virtual) Instantiates a new XBRL role type.
XBRLRoleType(DTSContainer newDTS, XBRLRoleType other) Instantiates a new XBRL role type.
XBRLRoleType(XMLFragment node) Creates a new XBRLRoleType object.

Method Summary

Modifier and Type	Method and Description
boolean	addUse(XMLFragment here) Adds the use.
void	clear() Clear.
XBRLRoleType	clone() Clone.
XBRLRoleType	clone(DTSContainer dts) Clone.
boolean	delUse(XMLFragment here) Del use.
boolean	equals(java.lang.Object other) Equals.
XBRLRoleType	generateNode() Generate node.
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()
XBRLRoleRef	getRoleRef(DTSContainer dts) Creates a XBRLRoleRef object pointing to this role and that can be serialized to a roleRef.
java.util.Iterator<XMLFragment>	getUses() Access to the [role uses] property The returned objects in the iterator are instances of XBRLExtendedLink or XBRLResource elements.
boolean	hasChildNodes()
static XBRLRoleType	make(DTSContainer dts) Make.
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, hashCode, 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

roleTypeQName

public static final javax.xml.namespace.QName roleTypeQName

The Constant roleTypeQName.

sqnRoleTypeQName

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

The Constant sqnRoleTypeQName.

roleAttribute

public static final javax.xml.namespace.QName roleAttribute

The Constant roleAttribute.

standardRoleComparator

public static java.util.Comparator<? super XBRLRoleType> standardRoleComparator

The standard role comparator.

STANDARD_ROLE_URI

public static final XBRLRoleType STANDARD_ROLE_URI

There is one static definition of the standard role each time a DTSContainer is created a local copy of this object is created in that DTSContainer.

STANDARD_FOOTNOTE

public static final XBRLRoleType STANDARD_FOOTNOTE

Static roles on resources.

STANDARD_LABEL

public static final XBRLRoleType STANDARD_LABEL

The standard label.

STANDARD_LABEL_TERSE

public static final XBRLRoleType STANDARD_LABEL_TERSE

The standard label terse.

STANDARD_LABEL_VERBOSE

public static final XBRLRoleType STANDARD_LABEL_VERBOSE

The standard label verbose.

STANDARD_LABEL_POSITIVE

public static final XBRLRoleType STANDARD_LABEL_POSITIVE

The standard label positive.

STANDARD_LABEL_POSITIVE_TERSE

public static final XBRLRoleType STANDARD_LABEL_POSITIVE_TERSE

The standard label positive terse.

STANDARD_LABEL_POSITIVE_VERBOSE

public static final XBRLRoleType STANDARD_LABEL_POSITIVE_VERBOSE

The standard label positive verbose.

STANDARD_LABEL_NEGATIVE

public static final XBRLRoleType STANDARD_LABEL_NEGATIVE

The standard label negative.

STANDARD_LABEL_NEGATIVE_TERSE

public static final XBRLRoleType STANDARD_LABEL_NEGATIVE_TERSE

The standard label negative terse.

STANDARD_LABEL_NEGATIVE_VERBOSE

public static final XBRLRoleType STANDARD_LABEL_NEGATIVE_VERBOSE

The standard label negative verbose.

STANDARD_LABEL_ZERO

public static final XBRLRoleType STANDARD_LABEL_ZERO

The standard label zero.

STANDARD_LABEL_ZERO_TERSE

public static final XBRLRoleType STANDARD_LABEL_ZERO_TERSE

The standard label zero terse.

STANDARD_LABEL_ZERO_VERBOSE

public static final XBRLRoleType STANDARD_LABEL_ZERO_VERBOSE

The standard label zero verbose.

STANDARD_LABEL_TOTAL

public static final XBRLRoleType STANDARD_LABEL_TOTAL

The standard label total.

STANDARD_LABEL_PERIOD_START

public static final XBRLRoleType STANDARD_LABEL_PERIOD_START

The standard label period start.

STANDARD_LABEL_PERIOD_END

public static final XBRLRoleType STANDARD_LABEL_PERIOD_END

The standard label period end.

STANDARD_DOCUMENTATION

public static final XBRLRoleType STANDARD_DOCUMENTATION

The standard documentation.

STANDARD_LABEL_DEFINITION_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_DEFINITION_GUIDANCE

The standard label definition guidance.

STANDARD_LABEL_DISCLOSURE_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_DISCLOSURE_GUIDANCE

The standard label disclosure guidance.

STANDARD_LABEL_PRESENTATION_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_PRESENTATION_GUIDANCE

The standard label presentation guidance.

STANDARD_LABEL_MEASUREMENT_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_MEASUREMENT_GUIDANCE

The standard label measurement guidance.

STANDARD_LABEL_COMMENTARY_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_COMMENTARY_GUIDANCE

The standard label commentary guidance.

STANDARD_LABEL_EXAMPLE_GUIDANCE

public static final XBRLRoleType STANDARD_LABEL_EXAMPLE_GUIDANCE

The standard label example guidance.

STANDARD_REFERENCE

public static final XBRLRoleType STANDARD_REFERENCE

The standard reference.

STANDARD_REFERENCE_DEFINITION

public static final XBRLRoleType STANDARD_REFERENCE_DEFINITION

The standard reference definition.

STANDARD_REFERENCE_DISCLOSURE

public static final XBRLRoleType STANDARD_REFERENCE_DISCLOSURE

The standard reference disclosure.

STANDARD_REFERENCE_MANDATORY_DISCLOSURE

public static final XBRLRoleType STANDARD_REFERENCE_MANDATORY_DISCLOSURE

The standard reference mandatory disclosure.

STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE

public static final XBRLRoleType STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE

The standard reference recommended disclosure.

STANDARD_REFERENCE_UNSPECIFIED_DISCLOSURE

public static final XBRLRoleType STANDARD_REFERENCE_UNSPECIFIED_DISCLOSURE

The standard reference unspecified disclosure.

STANDARD_REFERENCE_PRESENTATION

public static final XBRLRoleType STANDARD_REFERENCE_PRESENTATION

The standard reference presentation.

STANDARD_REFERENCE_MEASUREMENT

public static final XBRLRoleType STANDARD_REFERENCE_MEASUREMENT

The standard reference measurement.

STANDARD_REFERENCE_COMMENTARY

public static final XBRLRoleType STANDARD_REFERENCE_COMMENTARY

The standard reference commentary.

STANDARD_REFERENCE_EXAMPLE

public static final XBRLRoleType STANDARD_REFERENCE_EXAMPLE

The standard reference example.

STANDARD_LINKBASE_LABEL

public static final XBRLRoleType STANDARD_LINKBASE_LABEL

Static roles on linkbaseRef elements.

STANDARD_LINKBASE_PRESENTATION

public static final XBRLRoleType STANDARD_LINKBASE_PRESENTATION

The standard linkbase presentation.

STANDARD_LINKBASE_DEFINITION

public static final XBRLRoleType STANDARD_LINKBASE_DEFINITION

The standard linkbase definition.

STANDARD_LINKBASE_REFERENCE

public static final XBRLRoleType STANDARD_LINKBASE_REFERENCE

The standard linkbase reference.

STANDARD_LINKBASE_CALCULATION

public static final XBRLRoleType STANDARD_LINKBASE_CALCULATION

The standard linkbase calculation.

Constructor Detail

XBRLRoleType

public XBRLRoleType(XMLFragment node)
             throws XBRLValidationException

Creates a new XBRLRoleType object.

Parameters:

node - the node

Throws:

XBRLValidationException - the XBRL validation exception

XBRLRoleType

public XBRLRoleType(DTSContainer newDTS,
                    XBRLRoleType other)

Instantiates a new XBRL role type.

Parameters:

newDTS - the new dts

other - the other

XBRLRoleType

public XBRLRoleType(DTSContainer dts,
                    boolean virtual)

Instantiates a new XBRL role type.

Parameters:

dts - the dts

virtual - the virtual

Method Detail

clone

public XBRLRoleType clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL role type

clone

public XBRLRoleType clone(DTSContainer dts)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

dts - the dts

Returns:

the XBRL role type

make

public static XBRLRoleType make(DTSContainer dts)

Make.

Parameters:

dts - the dts

Returns:

the XBRL role type

addUse

public boolean addUse(XMLFragment here)

Adds the use.

Parameters:

here - the here

Returns:

true, if successful

delUse

public boolean delUse(XMLFragment here)

Del use.

Parameters:

here - XMLFragment

Returns:

true, if successful

getUses

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

Access to the [role uses] property The returned objects in the iterator are instances of XBRLExtendedLink or XBRLResource elements.

Returns:

Iterator

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

getRoleRef

public XBRLRoleRef getRoleRef(DTSContainer dts)

Creates a XBRLRoleRef object pointing to this role and that can be serialized to a roleRef.

Parameters:

dts - the DTSContainer

Returns:

new XBRLRoleRef

generateNode

public XBRLRoleType generateNode()
                          throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XBRLRoleAndArcroleTypes

Returns:

the XBRL role 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

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLRoleAndArcroleTypes

Throws:

java.lang.Throwable - the throwable

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