com.ihr.xbrl.om.taxonomy
Class XBRLArcroleType

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

All Implemented Interfaces:

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

public class XBRLArcroleType
extends XBRLRoleAndArcroleTypes
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

static int	ANY Values of the CyclesAllowed property
static javax.xml.namespace.QName	arcroleTypeQName
static int	NONE
static XBRLArcroleType	STANDARD_CONCEPT_LABEL
static XBRLArcroleType	STANDARD_CONCEPT_REFERENCE
static XBRLArcroleType	STANDARD_ESSENCE_ALIAS
static XBRLArcroleType	STANDARD_FACT_FOOTNOTE Static arcroles
static XBRLArcroleType	STANDARD_GENERAL_SPECIAL
static XBRLArcroleType	STANDARD_PARENT_CHILD
static XBRLArcroleType	STANDARD_REQUIRES_ELEMENT
static XBRLArcroleType	STANDARD_SIMILAR_TUPLES
static XBRLArcroleType	STANDARD_SUMMATION_ITEM
static int	UNDIRECTED

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

XBRLArcroleType(DTSContainer newDTS)
Creates a "virtual" arcrole type.

XBRLArcroleType(DTSContainer newDTS, XBRLArcroleType other)

XBRLArcroleType(XBRLArcroleType other)

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

Method Summary

void	addUse(XBRLRelationship here)
void	clear() Frees-up the memory used by this object
void	delUse(XBRLRelationship rel)
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
XBRLArcroleRef	getArcroleRef() 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)
static java.lang.Integer	getCyclesAllowed(java.lang.String code)
java.lang.String	getFriendlyName() Returns a string description that represents the element content in a form that users can understand.
java.util.Iterator<XBRLRelationship>	getUses() Access to the [arcrole uses] property The returned objects in the iterator are instances of XBRLRelationship elements
int	hashCode()
void	setCyclesAllowed(int cyclesAllowedCode)
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, isStatic, isUsedOn, isVirtual, removeUsedOn, sameUsedOn, setDefinition, setId, setParent, setStatic, setURI, setVirtual

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, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, 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

arcroleTypeQName

public static final javax.xml.namespace.QName arcroleTypeQName

ANY

public static final int ANY

Values of the CyclesAllowed property

See Also:

Constant Field Values

UNDIRECTED

public static final int UNDIRECTED

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

STANDARD_FACT_FOOTNOTE

public static XBRLArcroleType STANDARD_FACT_FOOTNOTE

Static arcroles

STANDARD_CONCEPT_LABEL

public static XBRLArcroleType STANDARD_CONCEPT_LABEL

STANDARD_CONCEPT_REFERENCE

public static XBRLArcroleType STANDARD_CONCEPT_REFERENCE

STANDARD_PARENT_CHILD

public static XBRLArcroleType STANDARD_PARENT_CHILD

STANDARD_SUMMATION_ITEM

public static XBRLArcroleType STANDARD_SUMMATION_ITEM

STANDARD_GENERAL_SPECIAL

public static XBRLArcroleType STANDARD_GENERAL_SPECIAL

STANDARD_ESSENCE_ALIAS

public static XBRLArcroleType STANDARD_ESSENCE_ALIAS

STANDARD_SIMILAR_TUPLES

public static XBRLArcroleType STANDARD_SIMILAR_TUPLES

STANDARD_REQUIRES_ELEMENT

public static XBRLArcroleType STANDARD_REQUIRES_ELEMENT

Constructor Detail

XBRLArcroleType

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

Creates a new XBRLRoleType object from a node in a file

Parameters:

node -

Throws:

XBRLValidationException

XBRLArcroleType

public XBRLArcroleType(XBRLArcroleType other)

XBRLArcroleType

public XBRLArcroleType(DTSContainer newDTS,
                       XBRLArcroleType other)

XBRLArcroleType

public XBRLArcroleType(DTSContainer newDTS)

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

Parameters:

newDTS -

Method Detail

addUse

public void addUse(XBRLRelationship here)

delUse

public void delUse(XBRLRelationship rel)

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 NONE

Returns:

integer constant

setCyclesAllowed

public void setCyclesAllowed(int cyclesAllowedCode)

getCyclesAllowed

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

getCyclesAllowed

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

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

getArcroleRef

public XBRLArcroleRef getArcroleRef()

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

Returns:

XBRLArcroleRef

clear

public void clear()

Frees-up the memory used by this object

Overrides:

clear in class XMLFragment

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