org.xbrlapi
Interface Instance

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Implementing Classes:

InstanceImpl

public interface Instance
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<Concept>	getAllConcepts()
long	getAllConceptsCount()
List<Fact>	getAllFacts()
long	getAllFactsCount()
List<Item>	getAllItems()
List<Concept>	getChildConcepts()
long	getChildConceptsCount()
List<Fact>	getChildFacts() Get the list of facts that are children of the instance.
long	getChildFactsCount()
List<Item>	getChildItems()
Context	getContext(String id) Get a specified context from the instance based on its id.
List<Context>	getContexts() Get list contexts contained in the instance.
String	getEarliestPeriod()
Map<String,Set<String>>	getEntityIdentifiers()
List<EntityResource>	getEntityResources()
List<Fact>	getFacts(Concept concept)
List<Fact>	getFacts(URI namespace, String localname)
List<ExtendedLink>	getFootnoteLinks() Get a list of footnote link fragments Returns null if none are contained by the XBRL instance.
List<FootnoteResource>	getFootnotes()
String	getLatestPeriod()
List<SimpleLink>	getLinkbaseRefs() Get the list of linkbaseRef fragments in the instance Returns null if none are contained by the XBRL instance.
List<SimpleLink>	getSchemaRefs() Get the list of schemaRef fragments in the instance Returns null if none are contained by the XBRL instance.
List<Tuple>	getTuples()
Unit	getUnit(String id) Get a specified unit from the instance based on its id.
List<Unit>	getUnits() Get the list of units contained in the instance.

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

getSchemaRefs

List<SimpleLink> getSchemaRefs()
                               throws XBRLException

Get the list of schemaRef fragments in the instance Returns null if none are contained by the XBRL instance.

Throws:

XBRLException

getLinkbaseRefs

List<SimpleLink> getLinkbaseRefs()
                                 throws XBRLException

Get the list of linkbaseRef fragments in the instance Returns null if none are contained by the XBRL instance.

Throws:

XBRLException

getContexts

List<Context> getContexts()
                          throws XBRLException

Get list contexts contained in the instance. Returns null if none are contained by the XBRL instance.

Throws:

XBRLException

getContext

Context getContext(String id)
                   throws XBRLException

Get a specified context from the instance based on its id.

Parameters:

id - The id of the context fragment

Returns:

the context fragment

Throws:

XBRLException - if the context does not exist

getUnits

List<Unit> getUnits()
                    throws XBRLException

Get the list of units contained in the instance. Returns null if none are contained by the XBRL instance.

Throws:

XBRLException

getUnit

Unit getUnit(String id)
             throws XBRLException

Get a specified unit from the instance based on its id.

Parameters:

id - The id of the unit fragment

Returns:

the unit fragment

Throws:

XBRLException - if the unit is not in this instance.

getFootnoteLinks

List<ExtendedLink> getFootnoteLinks()
                                    throws XBRLException

Get a list of footnote link fragments Returns null if none are contained by the XBRL instance.

Throws:

XBRLException

getFootnotes

List<FootnoteResource> getFootnotes()
                                    throws XBRLException

Returns:

a list containing all of the footnote resources in the instance.

Throws:

XBRLException

getChildFacts

List<Fact> getChildFacts()
                         throws XBRLException

Get the list of facts that are children of the instance. Facts that are within tuples are not included in this list.

Returns:

the list of facts that are children of the instance.

Throws:

XBRLException

getAllFacts

List<Fact> getAllFacts()
                       throws XBRLException

Returns:

all facts (tuples and facts within tuples also) in this instance.

Throws:

XBRLException

getChildConcepts

List<Concept> getChildConcepts()
                               throws XBRLException

Returns:

the list of concepts that have facts that are children of this XBRL instance (rather than being children of tuples).

Throws:

XBRLException

getAllConcepts

List<Concept> getAllConcepts()
                             throws XBRLException

Returns:

the list of all concepts that have facts in this XBRL instance, including nested within tuples.

Throws:

XBRLException

getChildConceptsCount

long getChildConceptsCount()
                           throws XBRLException

Returns:

the number of concepts that have facts that are children of this XBRL instance (rather than being nested within tuples).

Throws:

XBRLException

getAllConceptsCount

long getAllConceptsCount()
                         throws XBRLException

Returns:

the number of concepts that have facts in this instance.

Throws:

XBRLException

getChildFactsCount

long getChildFactsCount()
                        throws XBRLException

Returns:

the number of child facts in the instance (excludes facts that are contained within tuples).

Throws:

XBRLException

getAllFactsCount

long getAllFactsCount()
                      throws XBRLException

Returns:

the number of facts in the instance including tuples and those facts within tuples.

Throws:

XBRLException

getEarliestPeriod

String getEarliestPeriod()
                         throws XBRLException

Returns:

the value of the earliest start date or instance in a context period in the XBRL instance. Returns null if the XBRL instance does not contain a context that does not have a value of forever.

Throws:

XBRLException

getLatestPeriod

String getLatestPeriod()
                       throws XBRLException

Returns:

the value of the latest start date or instance in a context period in the XBRL instance. Returns null if the XBRL instance does not contain a context that does not have a value of forever.

Throws:

XBRLException

getEntityResources

List<EntityResource> getEntityResources()
                                        throws XBRLException

Returns:

the list of entity resources for entities with facts in the instance.

Throws:

XBRLException

getEntityIdentifiers

Map<String,Set<String>> getEntityIdentifiers()
                                             throws XBRLException

Returns:

A map, indexed by entity identifier schemes, of sets of the entity identifiers for those schemes, as contained in this XBRL instance.

Throws:

XBRLException

getTuples

List<Tuple> getTuples()
                      throws XBRLException

Returns:

the list of tuples that are children of the instance. Tuples that are within tuples are not included in this list. The list is empty if the instance does not contain tuples.

Throws:

XBRLException

getChildItems

List<Item> getChildItems()
                         throws XBRLException

Returns:

the list of all items that are children of the instance. Tuples (and the items that they contain are not included in the list).

Throws:

XBRLException

getAllItems

List<Item> getAllItems()
                       throws XBRLException

Returns:

the list of all items in the instance including those in tuples.

Throws:

XBRLException

getFacts

List<Fact> getFacts(URI namespace,
                    String localname)
                    throws XBRLException

Parameters:

namespace - The namespace of the facts to select.

localname - The local name of the facts to select.

Returns:

the list of facts in the instance with the given namespace and local name.

Throws:

XBRLException - if either parameter is null.

getFacts

List<Fact> getFacts(Concept concept)
                    throws XBRLException

Parameters:

concept - the concept to get the facts for.

Returns:

the list of facts in this instance that are reporting values for the specified concept.

Throws:

XBRLException - if the parameter is null.