org.xbrlapi.impl

Class NumericItemImpl

java.lang.Object

org.xbrlapi.impl.XMLImpl

org.xbrlapi.impl.FragmentImpl

org.xbrlapi.impl.FactImpl

org.xbrlapi.impl.ItemImpl

org.xbrlapi.impl.NumericItemImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XML>, Fact, Fragment, Item, NumericItem, XML

Direct Known Subclasses:

FractionItemImpl, SimpleNumericItemImpl

public class NumericItemImpl
extends ItemImpl
implements NumericItem

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NumericItemImpl()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDecimals() Get the decimals attribute for this item.
java.lang.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.
java.lang.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 class org.xbrlapi.impl.ItemImpl

getContext, getContextId

Methods inherited from class org.xbrlapi.impl.FactImpl

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

Methods inherited from class org.xbrlapi.impl.FragmentImpl

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 class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, 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 class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

NumericItemImpl

public NumericItemImpl()

Method Detail

getUnit

public Unit getUnit()
             throws XBRLException

Description copied from interface: NumericItem

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

Specified by:

getUnit in interface NumericItem

Returns:

the units fragment referenced by this numeric item.

Throws:

XBRLException

See Also:

NumericItem.getUnit()

getUnitId

public java.lang.String getUnitId()
                           throws XBRLException

Specified by:

getUnitId in interface NumericItem

Returns:

the ID of the unit referenced by this item.

Throws:

XBRLException - if the unit reference is missing.

See Also:

NumericItem.getUnitId()

getDecimals

public java.lang.String getDecimals()
                             throws XBRLException

Get the decimals attribute for this item.

Specified by:

getDecimals in interface NumericItem

Returns:

the value of the decimals attribute

Throws:

XBRLException

See Also:

NumericItem.getDecimals()

getPrecision

public java.lang.String getPrecision()
                              throws XBRLException

Get the precision attribute for this item.

Specified by:

getPrecision in interface NumericItem

Returns:

the value of the precision attribute

Throws:

XBRLException

See Also:

NumericItem.getPrecision()

hasPrecision

public boolean hasPrecision()
                     throws XBRLException

Returns true if the fact has a precision attribute.

Specified by:

hasPrecision in interface NumericItem

Returns:

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

Throws:

XBRLException

See Also:

NumericItem.hasPrecision()

hasDecimals

public boolean hasDecimals()
                    throws XBRLException

Returns true if the fact has a decimals attribute.

Specified by:

hasDecimals in interface NumericItem

Returns:

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

Throws:

XBRLException

See Also:

NumericItem.hasDecimals()