com.batavia.xbrl.instance
Interface Tuple

All Superinterfaces:

java.lang.Comparable, ComparablePart, Fact, IdHolder, IdKeeper, InstanceElement, ReportScope, java.io.Serializable, org.relaxng.datatype.ValidationContext, XbrlElement, XmlElement, XmlParticle

public interface Tuple
extends Fact, ReportScope

While most business facts can be independently understood, some facts are dependent on each other for proper understanding, especially if multiple occurrences of that fact are being reported.

For example, in reporting the management of a company, each manager’s name has to be properly associated with the manager’s correct title. Such sets of facts (manager’s title/manager’s name) are called tuples.

Tuples have complex content and MAY contain both items and other tuples.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addChild(XbrlElement child) Add the given child to this tuple
void	addFact(Fact aFact) Add the given fact to this tuples' content model
void	deleteEmptyFacts() Check to see if there are empty facts this could occur when a tuple is created based on tuple concept with choice elements.
java.util.List	getContextsInTuple(java.util.List contextList) Return a List with the contexts used by the item facts in the tuples' contents.
TupleChildren	getFacts() Get the facts that are in the content model for this tuple fact.
java.util.List	getFacts(Concept aConcept, Context aContext) Return a List with facts that are reported on the given concept and context and are contained in this tuple.
java.util.List	getFacts(FullyQualifiedName qName) get the list of facts from this tuples' content model that all have the given qName.
java.util.List	getFacts(FullyQualifiedName qName, Context aContext)
Item	getItem(FullyQualifiedName qName, Context aContext) Get the item fact from this tuples' content model that has the given qName and references the given context.
boolean	isAncestor(Fact aFact) Test if this tuple is a parent or ancestor of the given fact.
void	removeFact(Fact aFact) Remove the given fact from this tuples' content model

Methods inherited from interface com.batavia.xbrl.instance.Fact

createAttribute, createFootnote, createId, getConcept, getFactCompareIdentifier, getFootnotes, getId, getLabel, getType, getXbrlInstanceRoot, isDuplicate, isDuplicateExceptParent, isInferred, isRendered, requestExtraSibblings, setId, setInferred, setRendered, setXbrlInstanceRoot

Methods inherited from interface com.batavia.xbrl.instance.InstanceElement

createChildElement, getAllowedSubstitutions, getChildren, getMyDiscoverableTaxonomySet, getXbrlRoot

Methods inherited from interface com.batavia.xbrl.XbrlElement

fromXbrl, getXbrlElementNameSpace, removeChild, toXbrlStream, toXbrlString

Methods inherited from interface com.batavia.xml.XmlElement

addAttribute, addChild, addChildren, addComment, addMessage, addNameSpace, clearMessages, fromXml, getAttribute, getAttribute, getAttributeSet, getChild, getChildren, getChildren, getDefaultNameSpace, getDocumentHref, getErrorMessage, getFullyQualifiedNameValue, getMappedChildren, getMessages, getName, getNameSpace, getNameSpacePrefixes, getNameSpaces, getPointedElement, getValidXmlBase, getValue, getXmlElementNameSpace, getXmlRoot, isValid, moveChild, removeAttribute, removeChild, resolvePointedValue, resolvePointedXmlParticle, setAttributeValue, setChildren, setDocumentHref, setErrorMessage, setInit, setName, setTargetNameSpace, setValue, toXml, toXml, toXmlStream, toXmlString, toXstringBuffer, validate

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Methods inherited from interface com.batavia.xml.IdKeeper

addIdHolder, getHolder, removeIdHolder

Methods inherited from interface com.batavia.xbrl.instance.ReportScope

getFactsInThisScope, getFactsInThisScope, getFactsInThisScope

Methods inherited from interface com.batavia.xbrl.instance.InstanceElement

createChildElement, getAllowedSubstitutions, getChildren, getMyDiscoverableTaxonomySet, getXbrlRoot

Methods inherited from interface com.batavia.xbrl.XbrlElement

fromXbrl, getXbrlElementNameSpace, removeChild, toXbrlStream, toXbrlString

Methods inherited from interface com.batavia.xml.XmlElement

addAttribute, addChild, addChildren, addComment, addMessage, addNameSpace, clearMessages, fromXml, getAttribute, getAttribute, getAttributeSet, getChild, getChildren, getChildren, getDefaultNameSpace, getDocumentHref, getErrorMessage, getFullyQualifiedNameValue, getMappedChildren, getMessages, getName, getNameSpace, getNameSpacePrefixes, getNameSpaces, getPointedElement, getValidXmlBase, getValue, getXmlElementNameSpace, getXmlRoot, isValid, moveChild, removeAttribute, removeChild, resolvePointedValue, resolvePointedXmlParticle, setAttributeValue, setChildren, setDocumentHref, setErrorMessage, setInit, setName, setTargetNameSpace, setValue, toXml, toXml, toXmlStream, toXmlString, toXstringBuffer, validate

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Methods inherited from interface com.batavia.xml.IdKeeper

addIdHolder, getHolder, removeIdHolder

Method Detail

deleteEmptyFacts

void deleteEmptyFacts()

Check to see if there are empty facts this could occur when a tuple is created based on tuple concept with choice elements.

getFacts

TupleChildren getFacts()

Get the facts that are in the content model for this tuple fact.

Returns:

TupleChildren special collection for children of tuples.

addFact

void addFact(Fact aFact)

Add the given fact to this tuples' content model

Parameters:

aFact -

addChild

void addChild(XbrlElement child)

Add the given child to this tuple

Specified by:

addChild in interface XbrlElement

Parameters:

child -

removeFact

void removeFact(Fact aFact)

Remove the given fact from this tuples' content model

Parameters:

aFact -

getItem

Item getItem(FullyQualifiedName qName,
             Context aContext)

Get the item fact from this tuples' content model that has the given qName and references the given context.

Parameters:

qName -

aContext -

Returns:

an item fact that is in this tuples content model with the given qname and ref to the given context.

getFacts

java.util.List getFacts(FullyQualifiedName qName)

get the list of facts from this tuples' content model that all have the given qName.

Parameters:

qName -

Returns:

list with facts.

getContextsInTuple

java.util.List getContextsInTuple(java.util.List contextList)

Return a List with the contexts used by the item facts in the tuples' contents.

Parameters:

contextList -

Returns:

getFacts

java.util.List getFacts(Concept aConcept,
                        Context aContext)

Return a List with facts that are reported on the given concept and context and are contained in this tuple.

Parameters:

aConcept -

aContext -

Returns:

isAncestor

boolean isAncestor(Fact aFact)

Test if this tuple is a parent or ancestor of the given fact.

Parameters:

aFact -

Returns:

getFacts

java.util.List getFacts(FullyQualifiedName qName,
                        Context aContext)