com.batavia.xbrl.instance
Interface Fact

All Superinterfaces:

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

All Known Subinterfaces:

DimensionalFractionItem, DimensionalItem, Fraction, Item, Tuple

public interface Fact
extends InstanceElement, IdHolder

While a taxonomy defines reporting concepts, it does not contain the actual values of facts based on the defined concepts.

The fact values are contained in XBRL instances and are referred to as “facts”. Besides the actual value of a fact, such as “cash is 500,000”, the XBRL instance provides contextual information necessary for interpreting the fact values. For numeric facts, the XBRL instance also documents measurement accuracy and measurement units.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

XmlAttribute	createAttribute(FullyQualifiedName qName) Create a XmlAttribute with the given FullyQualifiedName and add it to the XbrlElement.
Footnote	createFootnote(java.lang.String footnoteValue) Create a footnote for this fact and set its text value
void	createId(Fact aFact, Xbrl aRoot) create an id for this fact based on its concept
Concept	getConcept() get the concept this fact is created for
java.lang.String	getFactCompareIdentifier() make String that can be used to identiy the fact cross instances
java.util.List	getFootnotes() Get the footnotes from this Facts' XBRL root that apply to this Fact
XmlAttribute	getId() Get the ID
Label	getLabel(java.lang.String prefRole, java.lang.String prefLanguage) Get the Label for this Fact from the DTS based on a preffered role such as a PresentationLink Could identify and a preffered language.
XbrlType	getType() get the type for this fact.
Xbrl	getXbrlInstanceRoot()
boolean	isDuplicate(Fact otherFact) test if this fact is a duplicate for the other fact
boolean	isDuplicateExceptParent(Fact otherFact) Same as isDuplicate(Fact otherFact) execpt that the parent equal is not performed.
boolean	isInferred() Facts that were inferred for the PTVI file DO NOT contribute in calculations since the original instance cannot bind the instance fact to the summation item
boolean	isRendered() Flag for render apps to detect that facts are rendered more thenonce in view
void	requestExtraSibblings(int nr) request the concept for this fact to create extra sibblings
void	setId(XmlAttribute id)
void	setInferred(boolean inferredForPtvi)
void	setRendered() flag this fact as rendered
void	setXbrlInstanceRoot(Xbrl xbrlInstanceRoot)

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

createChildElement, getAllowedSubstitutions, getChildren, getMyDiscoverableTaxonomySet, getXbrlRoot

Methods inherited from interface com.batavia.xbrl.XbrlElement

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

getLabel

Label getLabel(java.lang.String prefRole,
               java.lang.String prefLanguage)

Get the Label for this Fact from the DTS based on a preffered role such as a PresentationLink Could identify and a preffered language.

Parameters:

prefRole -

prefLanguage -

Returns:

getFootnotes

java.util.List getFootnotes()

Get the footnotes from this Facts' XBRL root that apply to this Fact

Returns:

List of footnotes

createAttribute

XmlAttribute createAttribute(FullyQualifiedName qName)

Create a XmlAttribute with the given FullyQualifiedName and add it to the XbrlElement. Return it so that the caller can influence the childs value

Parameters:

qName -

Returns:

XmlAttribute new attribute that is already added to parent when returned

getConcept

Concept getConcept()

get the concept this fact is created for

getType

XbrlType getType()

get the type for this fact. The fact resides in a Instance and has meaning within that instance. The meaning is given by its supporting DTS. The instance root has acces to that DTS. Ask the instance root to resolve the type

isDuplicate

boolean isDuplicate(Fact otherFact)

test if this fact is a duplicate for the other fact

Parameters:

otherFact -

Returns:

isDuplicateExceptParent

boolean isDuplicateExceptParent(Fact otherFact)

Same as isDuplicate(Fact otherFact) execpt that the parent equal is not performed.

Parameters:

otherFact -

Returns:

true when duplicate except for parent.

getXbrlInstanceRoot

Xbrl getXbrlInstanceRoot()

Returns:

Returns the xbrlInstanceRoot.

setXbrlInstanceRoot

void setXbrlInstanceRoot(Xbrl xbrlInstanceRoot)

Parameters:

xbrlInstanceRoot - The xbrlInstanceRoot to set.

getId

XmlAttribute getId()

Get the ID

Specified by:

getId in interface IdHolder

Returns:

XmlAttribute ID

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.

isInferred

boolean isInferred()

Facts that were inferred for the PTVI file DO NOT contribute in calculations since the original instance cannot bind the instance fact to the summation item

Returns:

Returns the inferredForPtvi.

setInferred

void setInferred(boolean inferredForPtvi)

Parameters:

inferredForPtvi - The inferredForPtvi to set.

createFootnote

Footnote createFootnote(java.lang.String footnoteValue)

Create a footnote for this fact and set its text value

Parameters:

footnoteValue -

Returns:

the new footnote

isRendered

boolean isRendered()

Flag for render apps to detect that facts are rendered more thenonce in view

Returns:

setRendered

void setRendered()

flag this fact as rendered

requestExtraSibblings

void requestExtraSibblings(int nr)

request the concept for this fact to create extra sibblings

Parameters:

nr -

createId

void createId(Fact aFact,
              Xbrl aRoot)

create an id for this fact based on its concept

Parameters:

aFact -

aRoot -

getFactCompareIdentifier

java.lang.String getFactCompareIdentifier()

make String that can be used to identiy the fact cross instances