org.xbrlapi

Interface Item

All Superinterfaces:

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

All Known Subinterfaces:

FractionItem, NonNumericItem, NumericItem, SimpleNumericItem

All Known Implementing Classes:

FractionItemImpl, ItemImpl, NonNumericItemImpl, NumericItemImpl, SimpleNumericItemImpl

public interface Item
extends Fact

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
Context	getContext() Get the context for this item.
java.lang.String	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

getContext

Context getContext()
                   throws XBRLException

Get the context for this item. Presumes that there is at most one XBRL instance in each document in the data store.

Returns:

the context fragment associated with this item

Throws:

XBRLException - if the context reference is missing or the context is unavailable.

getContextId

java.lang.String getContextId()
                              throws XBRLException

Returns:

the ID of the context referenced by this item.

Throws:

XBRLException - if the context reference is missing.