com.ihr.xbrl.om.exLinks
Class XBRLLabelResource

java.lang.Object
  com.ihr.xbrl.om.XMLFragment
      com.ihr.xbrl.om.exLinks.XLinkElement
          com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship
              com.ihr.xbrl.om.exLinks.XBRLResource
                  com.ihr.xbrl.om.exLinks.XBRLLabelResource

All Implemented Interfaces:

XBRLRelationshipPoint, XBRLValueKey, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

public class XBRLLabelResource
extends XBRLResource

Label resources are the object model representation of the link:label elements in label Linkbases

Author:

Ignacio

Field Summary

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, TYPE

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

XBRLLabelResource(XBRLExtendedLink parent, java.lang.String lang, java.lang.String label, XBRLRoleType role)
Applications creating a new label resource.

XBRLLabelResource(XBRLExtendedLink parent, net.sf.saxon.s9api.XdmNode resNode)
Creates a new label from a node in an extended link.

XBRLLabelResource(XBRLResource other)
Labels are normally created by copying another existing resource

Method Summary

java.lang.String	getFriendlyName() Returns a string description that represents the element content in a form that users can understand.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Returns a string description that represents the element content in a form that users can understand.
void	validate() Performs XBRL 2.1 validation on label resources

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clear, equals, generateLocatorToNode, generateNode, getAttributes, getDTSBase, getParent, getRoleType, getType, getValueKey, hashCode, isComplexType, isSimpleType, setComplexType, setDTSBase, setId, setParent, setRole, setRoleType, setSimpleType, setValue

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo

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

addAttribute, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getElements, getFragment, 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, setVariablesDefined, toString, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLRelationshipPoint

addFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationship

Constructor Detail

XBRLLabelResource

public XBRLLabelResource(XBRLExtendedLink parent,
                         net.sf.saxon.s9api.XdmNode resNode)

Creates a new label from a node in an extended link.

Parameters:

parent - XBRLExtendedLink parent of this new label

resNode - XdmNode saxon node defined in saxon s9api

Throws:

XBRLValidationException

XBRLLabelResource

public XBRLLabelResource(XBRLResource other)

Labels are normally created by copying another existing resource

Parameters:

other - XBRLResource

Throws:

XBRLValidationException

XBRLLabelResource

public XBRLLabelResource(XBRLExtendedLink parent,
                         java.lang.String lang,
                         java.lang.String label,
                         XBRLRoleType role)

Applications creating a new label resource. Label resources cannot be duplicated in this API.

A duplicate resource is not deleted from heap. It can be used to locate the existing resource by calling getResource(res) in the dtsContainer() object.

Parameters:

parent - XBRLExtendedLink, parent of this new resource

lang - the language code for the new label resource

label - the text of the new label

role - the role type for the new resource

Throws:

XBRLDuplicateResource

Method Detail

validate

public void validate()
              throws XBRLValidationException

Performs XBRL 2.1 validation on label resources

Throws:

XBRLValidationException

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 XBRLResource

Returns:

Non empty String. Internationalization is enabled

getFriendlyName

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

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 override by parent classes.

This function accepts flags that are defined as constants in XMLFragment in order to modify the output.

• XMLFragment.XPOINTER includes the element position in the source file using the XPointer specification. Note, if the document is created from objects the value may not be available
• XMLFragment.XPATH includes the element position in the source file using XPATH. Note, if the document is created from objects the value may not be available
• XMLFragment.NO_POSITION does not include the element position in the source file.
• XMLFragment.CONCEPT_QNAME for XBRLItem, XBRLTuple and XMLElementDefinition.
• XMLFragment.CONCEPT_LABEL for XBRLItema and XBRLTuple.
• XMLFragment.FACT_QNAME for facts.
• XMLFragment.FACT_CONCEPT_LABEL for facts.
• XMLFragment.SHORT_TEXT for resources, returns the resource text, id or xlink:label

Overrides:

getFriendlyName in class XBRLResource

Parameters:

modifiers - integer

Returns:

Non empty String. Internationalization is enabled