org.xbrlapi
Interface Unit

All Superinterfaces:

Comparable<XML>, FactDimensionContainer, Fragment, Serializable, XML

All Known Implementing Classes:

UnitImpl

public interface Unit
extends FactDimensionContainer

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

boolean	equals(Unit unit) Tests if the unit is u-equal to another unit returning true if they are u-equal and false otherwise
NodeList	getDenominatorMeasures() Get the set of measure elements in the denominator.
NodeList	getNumeratorMeasures() Get the numerator set of measures for the unit
List<Measure>	getResolvedDenominatorMeasures()
List<Measure>	getResolvedNumeratorMeasures()
boolean	hasDenominator() Determines if the unit has a denominator

Methods inherited from interface org.xbrlapi.FactDimensionContainer

getId, getReferencingItems

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

getNumeratorMeasures

NodeList getNumeratorMeasures()
                              throws XBRLException

Get the numerator set of measures for the unit

Returns:

the numerator measure set

Throws:

XBRLException

hasDenominator

boolean hasDenominator()
                       throws XBRLException

Determines if the unit has a denominator

Returns:

true if the unit has a denominator that has at least one measure in it, and false otherwise.

Throws:

XBRLException

getDenominatorMeasures

NodeList getDenominatorMeasures()
                                throws XBRLException

Get the set of measure elements in the denominator.

Returns:

the denominator measure set.

Throws:

XBRLException - if the denominator does not exist.

equals

boolean equals(Unit unit)
               throws XBRLException

Tests if the unit is u-equal to another unit returning true if they are u-equal and false otherwise

Parameters:

unit - The unit being compared.

Returns:

true if the two units are equal and false otherwise

Throws:

XBRLException

getResolvedNumeratorMeasures

List<Measure> getResolvedNumeratorMeasures()
                                           throws XBRLException

Returns:

a list of resolved numerator measures.

Throws:

XBRLException

getResolvedDenominatorMeasures

List<Measure> getResolvedDenominatorMeasures()
                                             throws XBRLException

Returns:

a list of resolved denominator measures. If there is no denominator then it returns an empty list.

Throws:

XBRLException