org.xbrlapi.impl
Class TupleImpl

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

All Implemented Interfaces:

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

public class TupleImpl
extends FactImpl
implements Tuple

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

TupleImpl()

Method Summary

List<Fact>	getChildFacts() Get the list of child facts
List<Fact>	getChildFacts(URI namespace, String name) 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 class org.xbrlapi.impl.FactImpl

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

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.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

Constructor Detail

TupleImpl

public TupleImpl()

Method Detail

getChildFacts

public List<Fact> getChildFacts()
                         throws XBRLException

Get the list of child facts

Specified by:

getChildFacts in interface Tuple

Returns:

list of child fact fragments for the tuple

Throws:

XBRLException

See Also:

Tuple.getChildFacts()

getChildFacts

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

Get a list of facts matching the specified fact name.

Specified by:

getChildFacts in interface Tuple

Parameters:

namespace - The namespace of the desired facts

name - The local name of the desired facts

Returns:

the specified facts.

Throws:

XBRLException

See Also:

Tuple.getChildFacts(URI, String)

getChildFacts

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

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

Specified by:

getChildFacts in interface Tuple

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

See Also:

Tuple.getChildFacts(URI, String, String)