com.ihr.xbrl.om.taxonomy
Class XBRLRoleType

java.lang.Object
  com.ihr.xbrl.om.XMLFragment
      com.ihr.xbrl.om.taxonomy.XBRLRoleAndArcroleTypes
          com.ihr.xbrl.om.taxonomy.XBRLRoleType

All Implemented Interfaces:

XBRLRelationshipPoint, XBRLValidation, XMLHasParent, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

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 interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

static javax.xml.namespace.QName	roleTypeQName
static XBRLRoleType	STANDARD_DOCUMENTATION
static XBRLRoleType	STANDARD_FOOTNOTE Static roles on resources
static XBRLRoleType	STANDARD_LABEL
static XBRLRoleType	STANDARD_LABEL_COMMENTARY_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_DEFINITION_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_DISCLOSURE_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_EXAMPLE_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_MEASUREMENT_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_NEGATIVE
static XBRLRoleType	STANDARD_LABEL_NEGATIVE_TERSE
static XBRLRoleType	STANDARD_LABEL_NEGATIVE_VERBOSE
static XBRLRoleType	STANDARD_LABEL_PERIOD_END
static XBRLRoleType	STANDARD_LABEL_PERIOD_START
static XBRLRoleType	STANDARD_LABEL_POSITIVE
static XBRLRoleType	STANDARD_LABEL_POSITIVE_TERSE
static XBRLRoleType	STANDARD_LABEL_POSITIVE_VERBOSE
static XBRLRoleType	STANDARD_LABEL_PRESENTATION_GUIDANCE
static XBRLRoleType	STANDARD_LABEL_TERSE
static XBRLRoleType	STANDARD_LABEL_TOTAL
static XBRLRoleType	STANDARD_LABEL_VERBOSE
static XBRLRoleType	STANDARD_LABEL_ZERO
static XBRLRoleType	STANDARD_LABEL_ZERO_TERSE
static XBRLRoleType	STANDARD_LABEL_ZERO_VERBOSE
static XBRLRoleType	STANDARD_LINKBASE_CALCULATION
static XBRLRoleType	STANDARD_LINKBASE_DEFINITION
static XBRLRoleType	STANDARD_LINKBASE_LABEL Static roles on linkbaseRef elements
static XBRLRoleType	STANDARD_LINKBASE_PRESENTATION
static XBRLRoleType	STANDARD_LINKBASE_REFERENCE
static XBRLRoleType	STANDARD_REFERENCE
static XBRLRoleType	STANDARD_REFERENCE_COMMENTARY
static XBRLRoleType	STANDARD_REFERENCE_DEFINITION
static XBRLRoleType	STANDARD_REFERENCE_DISCLOSURE
static XBRLRoleType	STANDARD_REFERENCE_EXAMPLE
static XBRLRoleType	STANDARD_REFERENCE_MANDATORY_DISCLOSURE
static XBRLRoleType	STANDARD_REFERENCE_MEASUREMENT
static XBRLRoleType	STANDARD_REFERENCE_PRESENTATION
static XBRLRoleType	STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE
static XBRLRoleType	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

Fields inherited from class com.ihr.xbrl.om.XMLFragment

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Constructor Summary

XBRLRoleType(DTSContainer newDTS)
Creates a "virtual" role type.

XBRLRoleType(DTSContainer newDts, XBRLRoleType other)

XBRLRoleType(XBRLRoleType other)

XBRLRoleType(XBRLTaxonomy parent, net.sf.saxon.s9api.XdmNode node)
Creates a new XBRLRoleType object

Method Summary

void	addUse(XMLFragment here)
void	clear() Frees-up used memory This method should not be invoqued on live objects in the DTS.
void	delUse(XMLFragment here)
boolean	equals(java.lang.Object other) Sets a new XPathFunctionResolver for this object
org.jdom.Element	generateNode(boolean relativize, java.net.URI base) Serializes to a jdom Element the representation of the properties of this Information Item This method should be called from classes derived from this class
java.lang.String	getFriendlyName() Returns a string description that represents the element content in a form that users can understand.
XBRLRoleRef	getRoleRef(XBRLDocument parent) 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
int	hashCode()
java.lang.String	toString() Returns the XML representation of this object as an String

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

addRef, addUsedOn, generateLocatorToNode, getDefinition, getElements, getHRefURI, getParent, getURI, getUsedOn, getValidationReport, invalidate, invalidate, isOnValidation, isStatic, isUsedOn, isVirtual, removeUsedOn, sameUsedOn, setDefinition, setId, setParent, setStatic, setURI, setVirtual, validate

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setValue, setVariablesDefined, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

roleTypeQName

public static final javax.xml.namespace.QName roleTypeQName

STANDARD_ROLE_URI

public 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

STANDARD_FOOTNOTE

public static XBRLRoleType STANDARD_FOOTNOTE

Static roles on resources

STANDARD_LABEL

public static XBRLRoleType STANDARD_LABEL

STANDARD_LABEL_TERSE

public static XBRLRoleType STANDARD_LABEL_TERSE

STANDARD_LABEL_VERBOSE

public static XBRLRoleType STANDARD_LABEL_VERBOSE

STANDARD_LABEL_POSITIVE

public static XBRLRoleType STANDARD_LABEL_POSITIVE

STANDARD_LABEL_POSITIVE_TERSE

public static XBRLRoleType STANDARD_LABEL_POSITIVE_TERSE

STANDARD_LABEL_POSITIVE_VERBOSE

public static XBRLRoleType STANDARD_LABEL_POSITIVE_VERBOSE

STANDARD_LABEL_NEGATIVE

public static XBRLRoleType STANDARD_LABEL_NEGATIVE

STANDARD_LABEL_NEGATIVE_TERSE

public static XBRLRoleType STANDARD_LABEL_NEGATIVE_TERSE

STANDARD_LABEL_NEGATIVE_VERBOSE

public static XBRLRoleType STANDARD_LABEL_NEGATIVE_VERBOSE

STANDARD_LABEL_ZERO

public static XBRLRoleType STANDARD_LABEL_ZERO

STANDARD_LABEL_ZERO_TERSE

public static XBRLRoleType STANDARD_LABEL_ZERO_TERSE

STANDARD_LABEL_ZERO_VERBOSE

public static XBRLRoleType STANDARD_LABEL_ZERO_VERBOSE

STANDARD_LABEL_TOTAL

public static XBRLRoleType STANDARD_LABEL_TOTAL

STANDARD_LABEL_PERIOD_START

public static XBRLRoleType STANDARD_LABEL_PERIOD_START

STANDARD_LABEL_PERIOD_END

public static XBRLRoleType STANDARD_LABEL_PERIOD_END

STANDARD_DOCUMENTATION

public static XBRLRoleType STANDARD_DOCUMENTATION

STANDARD_LABEL_DEFINITION_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_DEFINITION_GUIDANCE

STANDARD_LABEL_DISCLOSURE_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_DISCLOSURE_GUIDANCE

STANDARD_LABEL_PRESENTATION_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_PRESENTATION_GUIDANCE

STANDARD_LABEL_MEASUREMENT_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_MEASUREMENT_GUIDANCE

STANDARD_LABEL_COMMENTARY_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_COMMENTARY_GUIDANCE

STANDARD_LABEL_EXAMPLE_GUIDANCE

public static XBRLRoleType STANDARD_LABEL_EXAMPLE_GUIDANCE

STANDARD_REFERENCE

public static XBRLRoleType STANDARD_REFERENCE

STANDARD_REFERENCE_DEFINITION

public static XBRLRoleType STANDARD_REFERENCE_DEFINITION

STANDARD_REFERENCE_DISCLOSURE

public static XBRLRoleType STANDARD_REFERENCE_DISCLOSURE

STANDARD_REFERENCE_MANDATORY_DISCLOSURE

public static XBRLRoleType STANDARD_REFERENCE_MANDATORY_DISCLOSURE

STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE

public static XBRLRoleType STANDARD_REFERENCE_RECOMMENDED_DISCLOSURE

STANDARD_REFERENCE_UNSPECIFIED_DISCLOSURE

public static XBRLRoleType STANDARD_REFERENCE_UNSPECIFIED_DISCLOSURE

STANDARD_REFERENCE_PRESENTATION

public static XBRLRoleType STANDARD_REFERENCE_PRESENTATION

STANDARD_REFERENCE_MEASUREMENT

public static XBRLRoleType STANDARD_REFERENCE_MEASUREMENT

STANDARD_REFERENCE_COMMENTARY

public static XBRLRoleType STANDARD_REFERENCE_COMMENTARY

STANDARD_REFERENCE_EXAMPLE

public static XBRLRoleType STANDARD_REFERENCE_EXAMPLE

STANDARD_LINKBASE_LABEL

public static XBRLRoleType STANDARD_LINKBASE_LABEL

Static roles on linkbaseRef elements

STANDARD_LINKBASE_PRESENTATION

public static XBRLRoleType STANDARD_LINKBASE_PRESENTATION

STANDARD_LINKBASE_DEFINITION

public static XBRLRoleType STANDARD_LINKBASE_DEFINITION

STANDARD_LINKBASE_REFERENCE

public static XBRLRoleType STANDARD_LINKBASE_REFERENCE

STANDARD_LINKBASE_CALCULATION

public static XBRLRoleType STANDARD_LINKBASE_CALCULATION

Constructor Detail

XBRLRoleType

public XBRLRoleType(XBRLTaxonomy parent,
                    net.sf.saxon.s9api.XdmNode node)
             throws XBRLValidationException

Creates a new XBRLRoleType object

Parameters:

node -

Throws:

XBRLValidationException

XBRLRoleType

public XBRLRoleType(DTSContainer newDts,
                    XBRLRoleType other)

XBRLRoleType

public XBRLRoleType(XBRLRoleType other)

XBRLRoleType

public XBRLRoleType(DTSContainer newDTS)

Creates a "virtual" role type. Change properties (included the virtual property if this is going to be serialized) after creation

Parameters:

newDTS -

Method Detail

addUse

public void addUse(XMLFragment here)

delUse

public void delUse(XMLFragment here)

Parameters:

here - XMLFragment

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()

Description copied from class: XMLFragment

Returns the XML representation of this object as an String

Overrides:

toString in class XMLFragment

equals

public boolean equals(java.lang.Object other)

Description copied from class: XMLFragment

Sets a new XPathFunctionResolver for this object

Overrides:

equals in class XBRLRoleAndArcroleTypes

hashCode

public int hashCode()

Overrides:

hashCode in class XBRLRoleAndArcroleTypes

getRoleRef

public XBRLRoleRef getRoleRef(XBRLDocument parent)

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

Returns:

XBRLRoleRef

generateNode

public org.jdom.Element generateNode(boolean relativize,
                                     java.net.URI base)
                              throws XBRLSerializationException

Description copied from class: XMLFragment

Serializes to a jdom Element the representation of the properties of this Information Item This method should be called from classes derived from this class

Overrides:

generateNode in class XBRLRoleAndArcroleTypes

Parameters:

relativize - boolean indicating if URIs should be relativized to the base URI (see next argument)

base - the URI to which some attributes of this object should be relativided

Returns:

a clone of the surrounding jdom Element so it can be incorporated into multiple trees

Throws:

XBRLSerializationException

getFriendlyName

public java.lang.String getFriendlyName()

Description copied from class: XMLFragment

Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.

Remarks, this method may return very long names not suitable for user interface

Overrides:

getFriendlyName in class XMLFragment

Returns:

Non empty String. Internationalization is enabled

clear

public void clear()

Description copied from class: XMLFragment

Frees-up used memory

This method should not be invoqued on live objects in the DTS. It is automatically invoqued by the API when an object is no longer used and referenced by other objects. It is save not to call it directly.

Overrides:

clear in class XMLFragment