com.batavia.xbrl.instance
Interface FootnoteLink

All Superinterfaces:

java.lang.Comparable, ComparablePart, ExtendedLink, IdHolder, IdKeeper, java.io.Serializable, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, Xlink, XmlBaseHolder, XmlElement, XmlParticle

public interface FootnoteLink
extends ExtendedLink

While tuples deal with certain regularly-structured associations between elements that might appear in an XBRL instance, many documents include irregularly structured associations between facts. For instance, several facts may all be linked to the sentence “Including the effects of the merger with Example.com.” To express these irregular linkages, XBRL uses the footnoteLink element to describe these irregularly structured associations between facts in an XBRL instance.

The footnoteLink element is an extended link. It contains locators, resources and arcs that describe irregular relationships between facts in an XBRL instance.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addFootnote(Footnote aPart) Add a footnote child
void	addFootnoteArc(FootnoteArc aPart) Add a footnote arc child
void	addFootnoteLocator(FootnoteLocator aPart) Add the FootnotLocator child and register it with its xlink:label as key for later retreival.
Footnote	createFootNote(Fact aFact) Create a child Footnote and add it to the XbrlElement.
Footnote	createFootnote(java.lang.String id) Create a child Footnote and add it to the XbrlElement.
FootnoteArc	createFootnoteArc(java.lang.String xlinkFrom, java.lang.String xlinkTo) Create a child FootnoteArc and add it to the XbrlElement.
FootnoteLocator	createFootnoteLocator(java.lang.String label, java.lang.String xlinkHref) Create a child FootnoteLocator and add it to the XbrlElement.
java.util.List	getFactsForFootnote(XmlAttribute xlinkLabel) get the Facts that this footnotelink links from for the footnotes with the given xlink:label attribute
java.util.List	getFootnoteArcs() Return the list with arcs that are declared by this footnote link.
java.util.List	getFootnoteArcsForFact(Fact fact)
java.util.Map	getFootnoteLocators() Get the 2 dimensional map with footnotelocators.
java.util.Map	getFootnotes() Get the 2 dimensional map with footnote resources.
java.util.List	getFootnotesForFact(Fact fact) Get the Footnotes that this footnote link links to for the given fact
Xbrl	getXbrl()
void	removeFootnote(Footnote aPart) Remove a footnote child
void	removeFootnoteArc(FootnoteArc aPart) Remove a footnote arc child
void	removeFootnoteLocator(FootnoteLocator aPart) Remove the FootnoteLocator child.
boolean	validate(ValidationDocument msgs) Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessagesImpl collection.

Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.ExtendedLink

addArc, addDocumentation, addLocator, addResource, addTitle, createArc, createDocumentation, createLocator, createTitle, getArcs, getDocumentations, getId, getLabelled, getLocators, getLocatorsList, getResources, getTitles, getXlinkRole, getXmlBase, removeArc, removeDocumentation, removeLocator, removeResource, removeTitle, setId, setXlinkRole, setXmlBase

Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.Xlink

getLinkbaseContainer, getXlinkType, setXlinkType

Methods inherited from interface com.batavia.xbrl.taxonomy.TaxonomyElement

getRoot, hasDecendantsWithAttribute, hasUnknownDecendants

Methods inherited from interface com.batavia.xbrl.XbrlElement

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

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

getXbrl

Xbrl getXbrl()

Returns:

Returns the xbrl root that this link is child of.

getFactsForFootnote

java.util.List getFactsForFootnote(XmlAttribute xlinkLabel)

get the Facts that this footnotelink links from for the footnotes with the given xlink:label attribute

Parameters:

xlinkLabel - xlink:label attribute on a footnote resource for which facts are requested.

Returns:

List with facts.

getFootnoteArcsForFact

java.util.List getFootnoteArcsForFact(Fact fact)

getFootnotesForFact

java.util.List getFootnotesForFact(Fact fact)

Get the Footnotes that this footnote link links to for the given fact

Parameters:

fact -

Returns:

list with footnotes.

createFootnoteArc

FootnoteArc createFootnoteArc(java.lang.String xlinkFrom,
                              java.lang.String xlinkTo)

Create a child FootnoteArc and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

xlinkFrom -

xlinkTo -

Returns:

FootnoteArc new child that is already added to parent when returned

createFootnote

Footnote createFootnote(java.lang.String id)

Create a child Footnote and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

id -

Returns:

Footnote new child that is already added to parent when returned

createFootNote

Footnote createFootNote(Fact aFact)

Create a child Footnote and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

fact -

Returns:

Footnote new child that is already added to parent when returned

createFootnoteLocator

FootnoteLocator createFootnoteLocator(java.lang.String label,
                                      java.lang.String xlinkHref)

Create a child FootnoteLocator and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Parameters:

label -

xlinkHref -

Returns:

FootnoteLocator new child that is already added to parent when returned

getFootnoteArcs

java.util.List getFootnoteArcs()

Return the list with arcs that are declared by this footnote link.

Returns:

footnote arcs

addFootnoteArc

void addFootnoteArc(FootnoteArc aPart)

Add a footnote arc child

Parameters:

aPart -

removeFootnoteArc

void removeFootnoteArc(FootnoteArc aPart)

Remove a footnote arc child

Parameters:

aPart -

getFootnotes

java.util.Map getFootnotes()

Get the 2 dimensional map with footnote resources. The footnote resources' xlink:label attribute value is used as key. Since multiple resources COULD have the same value the key maps to a list of footnotes.

Returns:

map

addFootnote

void addFootnote(Footnote aPart)

Add a footnote child

Parameters:

aPart -

removeFootnote

void removeFootnote(Footnote aPart)

Remove a footnote child

Parameters:

aPart -

getFootnoteLocators

java.util.Map getFootnoteLocators()

Get the 2 dimensional map with footnotelocators. The footnotelocators' xlink:label attribute value is used as key. Since multiple locators COULD have the same value the key maps to a list of footnotelocators.

Returns:

map

addFootnoteLocator

void addFootnoteLocator(FootnoteLocator aPart)

Add the FootnotLocator child and register it with its xlink:label as key for later retreival.

Parameters:

aPart -

removeFootnoteLocator

void removeFootnoteLocator(FootnoteLocator aPart)

Remove the FootnoteLocator child.

validate

boolean validate(ValidationDocument msgs)

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessagesImpl collection.

Specified by:

validate in interface ExtendedLink

Specified by:

validate in interface XmlElement

Parameters:

msgs - The messages that indicate the problems with the instance and or its supporting taxonomy set

Returns:

true if there ar no problems with this XbrlElementImpl