com.batavia.xbrl.instance
Interface Context

All Superinterfaces:

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

All Known Subinterfaces:

DimensionalContext

public interface Context
extends InstanceElement, IdHolder

The context element contains information about the entity being described, the reporting period and the reporting scenario, all of which are necessary for understanding a business fact captured as an XBRL item.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

Entity	createEntity() Create a child Entity and add it to the XbrlElement.
Period	createForeverPeriod() Create a forever period
Period	createPeriod() Create a child Period and add it to the XbrlElement.
Period	createPeriod(java.util.Date instant) create a instant period
Period	createPeriod(java.util.Date from, java.util.Date to) create a duration period
Scenario	createScenario() Create a child Scenario and add it to the XbrlElement.
Entity	getEntity() get the entity that is contained by this context
XmlAttribute	getId() return the id
Period	getPeriod() get the period that is contained by this context
Scenario	getScenario() Get the scenario that is contained by this context
boolean	identicalExceptPeriod(ComparablePart another) test if this is identical to another except for the period
boolean	isValidForPeriodType(java.lang.String periodTypeValue) test if this is valid for the given periodTypeValue
void	setEntity(Entity entity) Set the entity that is to be contained by this context
void	setId(XmlAttribute id) Set the id
void	setPeriod(Period period) Set the period that is to be contained by this context
void	setScenario(Scenario scenario) Set the scenario that is to be contained by this context

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

createEntity

Entity createEntity()

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

Returns:

Entity new child that is already added to parent when returned

createPeriod

Period createPeriod()

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

Returns:

Period new child that is already added to parent when returned

createScenario

Scenario createScenario()

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

Returns:

Scenario new child that is already added to parent when returned

getId

XmlAttribute getId()

return the id

Specified by:

getId in interface IdHolder

Returns:

Returns the id XmlAttribute.

setId

void setId(XmlAttribute id)

Set the id

Parameters:

id -

getEntity

Entity getEntity()

get the entity that is contained by this context

Returns:

the entity

setEntity

void setEntity(Entity entity)

Set the entity that is to be contained by this context

Parameters:

entity -

getPeriod

Period getPeriod()

get the period that is contained by this context

Returns:

the period

setPeriod

void setPeriod(Period period)

Set the period that is to be contained by this context

Parameters:

period -

getScenario

Scenario getScenario()

Get the scenario that is contained by this context

Returns:

setScenario

void setScenario(Scenario scenario)

Set the scenario that is to be contained by this context

Parameters:

scenario -

createForeverPeriod

Period createForeverPeriod()

Create a forever period

Returns:

createPeriod

Period createPeriod(java.util.Date instant)

create a instant period

Parameters:

instant -

Returns:

createPeriod

Period createPeriod(java.util.Date from,
                    java.util.Date to)

create a duration period

Parameters:

from -

to -

Returns:

identicalExceptPeriod

boolean identicalExceptPeriod(ComparablePart another)

test if this is identical to another except for the period

Parameters:

another -

Returns:

isValidForPeriodType

boolean isValidForPeriodType(java.lang.String periodTypeValue)

test if this is valid for the given periodTypeValue

Parameters:

periodTypeValue -

Returns: