org.xbrlapi.impl
Class FactImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.FragmentImpl
          org.xbrlapi.impl.FactImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ItemImpl, TupleImpl

public class FactImpl
extends FragmentImpl
implements Fact

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

FactImpl()

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 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, finalize, 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

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

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

FactImpl

public FactImpl()

Method Detail

isTuple

public boolean isTuple()
                throws XBRLException

Return true if the fact is a tuple and false otherwise

Specified by:

isTuple in interface Fact

Throws:

XBRLException

getInstance

public Instance getInstance()
                     throws XBRLException

Description copied from interface: Fact

Get the instance that this fact is a part of

Specified by:

getInstance in interface Fact

Returns:

the xbrl instance fragment

Throws:

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

See Also:

Fact.getInstance()

getTuple

public Tuple getTuple()
               throws XBRLException

Description copied from interface: Fact

Get the tuple that this fact is a part of

Specified by:

getTuple in interface Fact

Returns:

the xbrl tuple fragment or null if this

Throws:

XBRLException

See Also:

Fact.getTuple()

getConcept

public Concept getConcept()
                   throws XBRLException

Description copied from interface: Fact

Get the concept that defines the syntax for this fact.

Specified by:

getConcept in interface Fact

Returns:

the appropriate concept fragment from the data store.

Throws:

XBRLException - if the concept cannot be found.

See Also:

Fact.getConcept()

isNumeric

public boolean isNumeric()
                  throws XBRLException

Specified by:

isNumeric in interface Fact

Returns:

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

Throws:

XBRLException

See Also:

Fact.isNumeric()

isFraction

public boolean isFraction()
                   throws XBRLException

Specified by:

isFraction in interface Fact

Returns:

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

Throws:

XBRLException

See Also:

Fact.isFraction()

isNil

public boolean isNil()
              throws XBRLException

Description copied from interface: Fact

Return true if the fact has a nill value.

Specified by:

isNil in interface Fact

Throws:

XBRLException

See Also:

Fact.isNil()