org.xbrlapi
Interface Fact

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Subinterfaces:

FractionItem, Item, NonNumericItem, NumericItem, SimpleNumericItem, Tuple

All Known Implementing Classes:

FactImpl, FractionItemImpl, ItemImpl, NonNumericItemImpl, NumericItemImpl, SimpleNumericItemImpl, TupleImpl

public interface Fact
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Concept	getConcept() Get the concept that defines the syntax for this fact.
Instance	getInstance() Get the instance that this fact is a part of
Tuple	getTuple() Get the tuple that this fact is a part of
boolean	isFraction()
boolean	isNil() Return true if the fact has a nill value.
boolean	isNumeric()
boolean	isTuple() Return true if the fact is a tuple and false otherwise

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

isTuple

boolean isTuple()
                throws XBRLException

Return true if the fact is a tuple and false otherwise

Throws:

XBRLException

getInstance

Instance getInstance()
                     throws XBRLException

Get the instance that this fact is a part of

Returns:

the xbrl instance fragment

Throws:

XBRLException - if the fact is not part of an instance.

getTuple

Tuple getTuple()
               throws XBRLException

Get the tuple that this fact is a part of

Returns:

the xbrl tuple fragment or null if this

Throws:

XBRLException

getConcept

Concept getConcept()
                   throws XBRLException

Get the concept that defines the syntax for this fact.

Returns:

the appropriate concept fragment from the data store.

Throws:

XBRLException - if the concept cannot be found.

isNumeric

boolean isNumeric()
                  throws XBRLException

Returns:

true if the fact is reported with units and false otherwise.

Throws:

XBRLException

isFraction

boolean isFraction()
                   throws XBRLException

Returns:

true if the fact is a fraction item type or derived therefrom and false otherwise.

Throws:

XBRLException

isNil

boolean isNil()
              throws XBRLException

Return true if the fact has a nill value.

Throws:

XBRLException