org.xbrlapi
Interface Tuple

All Superinterfaces:

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

All Known Implementing Classes:

TupleImpl

public interface Tuple
extends Fact

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<Fact>	getChildFacts() Get the child facts
List<Fact>	getChildFacts(URI namespace, String localname) Get a list of facts matching the specified fact name.
List<Fact>	getChildFacts(URI namespace, String name, String contextRef) Get a list of facts matching the specified fact name and context id.

Methods inherited from interface org.xbrlapi.Fact

getConcept, getInstance, getTuple, isFraction, isNil, isNumeric, isTuple

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

getChildFacts

List<Fact> getChildFacts()
                         throws XBRLException

Get the child facts

Throws:

XBRLException

getChildFacts

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

Get a list of facts matching the specified fact name.

Parameters:

namespace - The namespace of the desired facts

localname - The local name of the desired facts

Returns:

the specified facts.

Throws:

XBRLException

getChildFacts

List<Fact> getChildFacts(URI namespace,
                         String name,
                         String contextRef)
                         throws XBRLException

Get a list of facts matching the specified fact name and context id.

Parameters:

namespace - The namespace of the desired facts

name - The local name of the desired facts

contextRef - The value of the context reference for the required facts.

Returns:

the specified facts.

Throws:

XBRLException