org.xbrlapi

Interface MeasureResource

All Superinterfaces:

ArcEnd, java.lang.Comparable<XML>, ExtendedLinkContent, Fragment, MixedContentResource, Resource, java.io.Serializable, Xlink, XML

All Known Implementing Classes:

MeasureResourceImpl

public interface MeasureResource
extends MixedContentResource

Defines the functionality for the custom unit resource: a extended link resource that has a 1:1 association with a given Unit measure. Each unit resource defines a pairing of a namespace and a localname. Together these define a measure that can be used in XBRL units of measurement.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<MeasureResource>	getEquivalents()
java.lang.String	getMeasureLocalname()
java.lang.String	getMeasureNamespace()

Methods inherited from interface org.xbrlapi.MixedContentResource

getContentAsNodeList, getContentAsXHTMLString

Methods inherited from interface org.xbrlapi.Resource

getResourceRole

Methods inherited from interface org.xbrlapi.ArcEnd

getArcEndId, getArcsFrom, getArcsFromWithArcrole, getArcsTo, getArcsToWithArcrole, getLabel, getRole

Methods inherited from interface org.xbrlapi.ExtendedLinkContent

getExtendedLink

Methods inherited from interface org.xbrlapi.Xlink

getAttribute, getAttribute, getTitleAttribute, getTitleElement, getTitleElements, getXlinkType

Methods inherited from interface org.xbrlapi.Fragment

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getMeasureNamespace

java.lang.String getMeasureNamespace()
                                     throws XBRLException

Returns:

the measure namespace

Throws:

XBRLException

getMeasureLocalname

java.lang.String getMeasureLocalname()
                                     throws XBRLException

Returns:

the measure local name

Throws:

XBRLException

getEquivalents

java.util.Set<MeasureResource> getEquivalents()
                                              throws XBRLException

Returns:

a list of all equivalent unit resources, including this unit resource that is naturally equivalent to itself.

Throws:

XBRLException