org.xbrlapi
Interface NumericItem

All Superinterfaces:

Comparable<XML>, Fact, Fragment, Item, Serializable, XML

All Known Subinterfaces:

FractionItem, SimpleNumericItem

All Known Implementing Classes:

FractionItemImpl, NumericItemImpl, SimpleNumericItemImpl

public interface NumericItem
extends Item

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getDecimals() Get the decimals attribute for this item.
String	getPrecision() Get the precision attribute for this item.
Unit	getUnit() Presumes that there is at most one XBRL instance in each document in the data store.
String	getUnitId()
boolean	hasDecimals() Returns true if the fact has a decimals attribute.
boolean	hasPrecision() Returns true if the fact has a precision attribute.

Methods inherited from interface org.xbrlapi.Item

getContext, getContextId

Methods inherited from interface org.xbrlapi.Fact

getConcept, getInstance, getTuple, isFraction, isNil, isNumeric, isTuple

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

getUnit

Unit getUnit()
             throws XBRLException

Presumes that there is at most one XBRL instance in each document in the data store.

Returns:

the units fragment referenced by this numeric item.

Throws:

XBRLException

getUnitId

String getUnitId()
                 throws XBRLException

Returns:

the ID of the unit referenced by this item.

Throws:

XBRLException - if the unit reference is missing.

getDecimals

String getDecimals()
                   throws XBRLException

Get the decimals attribute for this item.

Returns:

the value of the decimals attribute

Throws:

XBRLException

getPrecision

String getPrecision()
                    throws XBRLException

Get the precision attribute for this item.

Returns:

the value of the precision attribute

Throws:

XBRLException

hasPrecision

boolean hasPrecision()
                     throws XBRLException

Returns true if the fact has a precision attribute.

Returns:

true if the fact has a precision attribute and false otherwise.

Throws:

XBRLException

hasDecimals

boolean hasDecimals()
                    throws XBRLException

Returns true if the fact has a decimals attribute.

Returns:

true if the fact has a decimals attribute and false otherwise.

Throws:

XBRLException