XBRLAPI

A Java API for XBRL


org.xbrlapi
Interface FactDimensionContainer

All Superinterfaces:
Comparable<XML>, Fragment, Serializable, XML
All Known Subinterfaces:
Context, Unit
All Known Implementing Classes:
ContextImpl, FactDimensionContainerImpl, UnitImpl

public interface FactDimensionContainer
extends Fragment

Author:
Geoffrey Shuetrim (geoff@galexy.net)

Method Summary
 String getId()
          Get the id attribute value of the container
<I extends Item>
List<I>
getReferencingItems()
           
 
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

getId

String getId()
             throws XBRLException
Get the id attribute value of the container

Returns:
the value of the id attribute for the unit or context.
Throws:
XBRLException - if the id attribute is missing.

getReferencingItems

<I extends Item> List<I> getReferencingItems()
                                         throws XBRLException
Returns:
the list of items in the instance that reference this context. The list is empty if no facts in the instance reference this context.
Throws:
XBRLException

Get Java XBRL API implementation at SourceForge.net.