com.batavia.xbrl.instance.dimension
Interface DimensionalContext

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

public interface DimensionalContext
extends Context

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:
Ron van Ardenne

Method Summary
 java.util.List getContributorContexts()
           
 Declaration getDimAxisDomainMember()
           
 java.util.List getDimensionalContextElements(Sequence children)
           
 java.util.List getExplicitDimensionMembers()
           
 java.util.List getUsedDimensionItems()
           
 boolean isAggregator()
          checks whether the context could be aggregator aka used dom is source in domain member network
 boolean isAggregatorForContributorContext(DimensionalContext otherDimContext)
          chehcks whether the other context is contributing to this
 boolean isCompareForAggregatorContributor()
           
 void setCompareForAggregatorContributor(boolean compareForAggregatorContributor)
           
 void setDimAxis(IdHolder dim, Declaration dimAxisDomainMember)
           
 
Methods inherited from interface com.batavia.xbrl.instance.Context
createEntity, createForeverPeriod, createPeriod, createPeriod, createPeriod, createScenario, getEntity, getId, getPeriod, getScenario, identicalExceptPeriod, isValidForPeriodType, setEntity, setId, setPeriod, setScenario
 
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

getContributorContexts

java.util.List getContributorContexts()

isAggregatorForContributorContext

boolean isAggregatorForContributorContext(DimensionalContext otherDimContext)
chehcks whether the other context is contributing to this

Parameters:
otherDimContext -
Returns:

isCompareForAggregatorContributor

boolean isCompareForAggregatorContributor()
Returns:
Returns the compareForAggregatorContributor.

setCompareForAggregatorContributor

void setCompareForAggregatorContributor(boolean compareForAggregatorContributor)
Parameters:
compareForAggregatorContributor - The compareForAggregatorContributor to set.

getDimensionalContextElements

java.util.List getDimensionalContextElements(Sequence children)
Returns:
Returns the dimensional context elements.

getUsedDimensionItems

java.util.List getUsedDimensionItems()

getExplicitDimensionMembers

java.util.List getExplicitDimensionMembers()

isAggregator

boolean isAggregator()
checks whether the context could be aggregator aka used dom is source in domain member network

Returns:

setDimAxis

void setDimAxis(IdHolder dim,
                Declaration dimAxisDomainMember)

getDimAxisDomainMember

Declaration getDimAxisDomainMember()