com.ihr.xbrl.om.taxonomy

Class XBRLRoleAndArcroleTypes

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

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

Direct Known Subclasses:

XBRLArcroleType, XBRLRoleType

public abstract class XBRLRoleAndArcroleTypes
extends XMLFragment
implements XBRLValidation, java.lang.Comparable<XBRLRoleAndArcroleTypes>

The Class XBRLRoleAndArcroleTypes.

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 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
XBRLRoleAndArcroleTypes(DTSContainer newDTS, XBRLRoleAndArcroleTypes other) Instantiates a new XBRL role and arcrole types.
XBRLRoleAndArcroleTypes(XBRLRoleAndArcroleTypes other) Instantiates a new XBRL role and arcrole types.

Method Summary

Modifier and Type	Method and Description
void	addRef(XBRLDocument doc) Deprecated.
void	addUsedOn(XBRLUsedOn on) Adds the used on.
void	clear() Clear.
int	compareTo(XBRLRoleAndArcroleTypes o) Compare to.
boolean	equals(java.lang.Object other) Equals.
XBRLRoleAndArcroleTypes	generateNode() Generate node.
java.lang.Integer	getCode() Role types and arcroleTypes are stored in the DTS and a code is assigned to it.
java.lang.String	getDefinition() Access to the [Definition] property.
java.util.Iterator<XMLFragment>	getElements() Gets the elements.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
java.net.URI	getHRefURI() Creates a URI pointing to the roleType or arcroleType .
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLTaxonomy	getParentDocument() access to the [Parent] property.
java.lang.String	getRoleAndArcroleURI() Access to the [Role URI]/[Arcrole URI] property.
java.util.Iterator<XBRLUsedOn>	getUsedOn() Gets the used on.
XBRLValidationReport	getValidationReport() Gets the validation report.
boolean	hasChildNodes()
int	hashCode() Hash code.
void	invalidate() Invalidate.
boolean	invalidate(XBRLValidation.Direction dir) Invalidate.
boolean	isOnValidation() Checks if is on validation.
boolean	isStatic() Returns true for role types and arcrole types defined in the XBRL 2.1 specification
boolean	isUsedOn(javax.xml.namespace.QName here) returns true if the element represented by the QName can legally use this XBRLRoleType This method considers roles defined in the XBRL 2.1 specification, virtual roles undefined in the DTS and used in generic linkbases and roles properly defined in XBRL linkbases
boolean	isVirtual() Returns true for role types not referenced using roleRef elements or arcrole type not referenced via arcroleRef elements but valid because they are used within custom extended linkbases.
void	removeUsedOn(XBRLUsedOn on) Removes the used on.
boolean	sameUsedOn(XBRLRoleAndArcroleTypes o) Same used on.
void	setCode(java.lang.Integer newCode) This method is required to change the code of a role or arcrole that has been loaded in a compatible DTSContainer to the container from which the role or arcrole was created.
void	setDefinition(java.lang.String newValue) Sets the definition string for a role and arcrole types.
void	setId(java.lang.String id) Sets the id.
boolean	setRawParentXBRL(XMLFragment newParent) Changes the [Parent] property.
void	setRoleAndArcroleURI(java.lang.String newURI) Sets or changes the URI of this role type.
void	setStatic(boolean newValue) Used by the API when a static role or arcrole URI is defined.
void	setVirtual(boolean newValue) Used by the API when a virtual role or arcrole URI is defined.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) 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, clone, clone, 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, 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, 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, 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

Constructor Detail

XBRLRoleAndArcroleTypes

public XBRLRoleAndArcroleTypes(XBRLRoleAndArcroleTypes other)

Instantiates a new XBRL role and arcrole types.

Parameters:

other - the other

XBRLRoleAndArcroleTypes

public XBRLRoleAndArcroleTypes(DTSContainer newDTS,
                               XBRLRoleAndArcroleTypes other)

Instantiates a new XBRL role and arcrole types.

Parameters:

newDTS - the new dts

other - the other

Method Detail

generateNode

public XBRLRoleAndArcroleTypes generateNode()
                                     throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XBRL role and arcrole types

Throws:

XBRLSerializationException - the XBRL serialization exception

getDefinition

public java.lang.String getDefinition()

Access to the [Definition] property. If there is no definition this function returns null

Returns:

String

setDefinition

public void setDefinition(java.lang.String newValue)

Sets the definition string for a role and arcrole types. The string may be null in this case the role or arcrole type will have no definition

Parameters:

newValue - the new definition

getParentDocument

public XBRLTaxonomy getParentDocument()

access to the [Parent] property. This is the taxonomy in which the role/arcrole type is defined

Overrides:

getParentDocument in class XMLFragment

Returns:

XBRLTaxonomy

setId

public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException

Sets the id.

Overrides:

setId in class XMLFragment

Parameters:

id - the new id

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent DTS exception

setRawParentXBRL

public boolean setRawParentXBRL(XMLFragment newParent)

Changes the [Parent] property. This is the taxonomy in which the role/arcrole type is defined

Overrides:

setRawParentXBRL in class XMLFragment

Parameters:

newParent - the new parent

Returns:

true, if successful

getCode

public java.lang.Integer getCode()

Role types and arcroleTypes are stored in the DTS and a code is assigned to it. The code can be used to retrieve the RoleType or arcroleType from the DTSContainer and is faster than comparing the URI

Returns:

Integer

Since:

2.6.7

setCode

public void setCode(java.lang.Integer newCode)

This method is required to change the code of a role or arcrole that has been loaded in a compatible DTSContainer to the container from which the role or arcrole was created. The method shall not be used by applications. Is for internal API use only.

Parameters:

newCode - the new code

getUsedOn

public java.util.Iterator<XBRLUsedOn> getUsedOn()

Gets the used on.

Returns:

the used on

addUsedOn

public void addUsedOn(XBRLUsedOn on)

Adds the used on.

Parameters:

on - the on

removeUsedOn

public void removeUsedOn(XBRLUsedOn on)

Removes the used on.

Parameters:

on - the on

isUsedOn

public boolean isUsedOn(javax.xml.namespace.QName here)

returns true if the element represented by the QName can legally use this XBRLRoleType

This method considers roles defined in the XBRL 2.1 specification, virtual roles undefined in the DTS and used in generic linkbases and roles properly defined in XBRL linkbases

Parameters:

here - the node element to check for

Returns:

boolean value

isStatic

public boolean isStatic()

Returns true for role types and arcrole types defined in the XBRL 2.1 specification

Returns:

boolean

isVirtual

public boolean isVirtual()

Returns true for role types not referenced using roleRef elements or arcrole type not referenced via arcroleRef elements but valid because they are used within custom extended linkbases.

Returns:

boolean

setStatic

public void setStatic(boolean newValue)

Used by the API when a static role or arcrole URI is defined.

Parameters:

newValue - the new static

setVirtual

public void setVirtual(boolean newValue)

Used by the API when a virtual role or arcrole URI is defined.

Parameters:

newValue - the new virtual

getRoleAndArcroleURI

public java.lang.String getRoleAndArcroleURI()

Access to the [Role URI]/[Arcrole URI] property.

Returns:

String

setRoleAndArcroleURI

public void setRoleAndArcroleURI(java.lang.String newURI)

Sets or changes the URI of this role type. If there was an existing role type the old role type URI is unregistered from the DTS and the new role type is registered. Virtual or Static role types are not registered. virtual and static properties should be set before setRoleAndArcroleURI is called.

Parameters:

newURI - the new uri

equals

public boolean equals(java.lang.Object other)

Equals.

Specified by:

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

Overrides:

equals in class XMLFragment

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 XMLFragment

Returns:

the int

sameUsedOn

public boolean sameUsedOn(XBRLRoleAndArcroleTypes o)

Same used on.

Parameters:

o - the o

Returns:

true, if successful

getHRefURI

public java.net.URI getHRefURI()

Creates a URI pointing to the roleType or arcroleType .

Returns:

URI

addRef

@Deprecated
public void addRef(XBRLDocument doc)

Deprecated.

When a role or arcrole is referenced via roleRef its is annotated here.

Parameters:

doc - the doc

getElements

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

Gets the elements.

Overrides:

getElements in class XMLFragment

Returns:

the elements

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

getValidationReport

public XBRLValidationReport getValidationReport()

Gets the validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

the 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

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Validate.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the proc

Returns:

the XBRL validation report

isOnValidation

public boolean isOnValidation()

Checks if is on validation.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true, if is on validation

compareTo

public int compareTo(XBRLRoleAndArcroleTypes o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<XBRLRoleAndArcroleTypes>

Parameters:

o - the o

Returns:

the int

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLFragment

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