com.batavia.xbrl.instance
Interface InstanceElement

All Superinterfaces:

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

All Known Subinterfaces:

Context, ContextElement, DateTime, DimensionalContext, DimensionalFractionItem, DimensionalItem, DimensionalMember, DimensionalScenario, DimensionalSegment, Divide, EndDate, Entity, ExplicitMember, Fact, Forever, Fraction, FractionDenominator, FractionNumerator, FractionPart, Identifier, Instant, Item, Measure, Period, RegularInstanceElement, ReportScope, RootElement, Scenario, Segment, StartDate, Tuple, TypedMember, Unit, UnitDenominator, UnitElement, UnitNumerator, UnknownInstanceElement, Xbrl

public interface InstanceElement
extends XbrlElement

Superclass for all types of elements of instancedocuments in XBRL environment

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

InstanceElement	createChildElement(FullyQualifiedName qName) Create a child InstanceElement with the given FullyQualifiedName and add it to the XbrlElement.
java.util.List	getAllowedSubstitutions(Declaration declaration) Returns allowed substitutions for the given declaration in the context of this XML element its DTS.
java.util.List	getChildren(Declaration declaration) Return this XML elements children that conform to the given XSD declaration.
DiscoverableTaxonomySet	getMyDiscoverableTaxonomySet() Get this elements' DTS by walking up the tree of ancestors from it self onwards to see if there are InstanceDocumentLink implementors that can return the requested DTS.
Xbrl	getXbrlRoot() Return this instance element its root XBRL element.

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

getXbrlRoot

Xbrl getXbrlRoot()

Return this instance element its root XBRL element. This is the first element named xbrl in the xbrl-instance namespace. NOTE: this does NOT have to be the root element for the XML document.

Returns:

getMyDiscoverableTaxonomySet

DiscoverableTaxonomySet getMyDiscoverableTaxonomySet()

Get this elements' DTS by walking up the tree of ancestors from it self onwards to see if there are InstanceDocumentLink implementors that can return the requested DTS.

Specified by:

getMyDiscoverableTaxonomySet in interface XbrlElement

Returns:

DiscoverableTaxonomySet

getChildren

java.util.List getChildren(Declaration declaration)

Return this XML elements children that conform to the given XSD declaration.

Parameters:

declaration -

Returns:

getAllowedSubstitutions

java.util.List getAllowedSubstitutions(Declaration declaration)

Returns allowed substitutions for the given declaration in the context of this XML element its DTS.

Parameters:

declaration -

Returns:

createChildElement

InstanceElement createChildElement(FullyQualifiedName qName)

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

Parameters:

qName -

Returns:

InstanceElement new child that is already added to parent when returned