org.xbrlapi
Interface Context

All Superinterfaces:

Comparable<XML>, FactDimensionContainer, Fragment, Serializable, XML

All Known Implementing Classes:

ContextImpl

public interface Context
extends FactDimensionContainer

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

boolean	equals(Context context) Tests if the context is c-equal to another context returning true if they are c-equal.
Entity	getEntity() Get the entity of the context.
Period	getPeriod() Get the period of the context.
Scenario	getScenario() Get the scenario of the context.

Methods inherited from interface org.xbrlapi.FactDimensionContainer

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

getEntity

Entity getEntity()
                 throws XBRLException

Get the entity of the context.

Throws:

XBRLException - if the entity is missing or if more than one entity is in the context.

getPeriod

Period getPeriod()
                 throws XBRLException

Get the period of the context.

Throws:

XBRLException

getScenario

Scenario getScenario()
                     throws XBRLException

Get the scenario of the context. Returns null if there is no scenario.

Throws:

XBRLException

equals

boolean equals(Context context)
               throws XBRLException

Tests if the context is c-equal to another context returning true if they are c-equal. See the XBRL 2.1 specification for a definition of c-equal.

Parameters:

context - The context being compared.

Throws:

XBRLException