com.batavia.xbrl.taxonomy.type
Interface Choice

All Superinterfaces:

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

public interface Choice
extends RestrictionElement, ContentCreator

choice element of restrictions in XBRL environment, One and only one item defined must apear.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addRestrictionElement(RestrictionElement element) Add the given restriction to the collection of restriction elements for this element
void	createContents(InstanceElement returnValue, Xbrl aRoot, boolean includeDefaultValues, java.util.List contextList, boolean includeFootnotes) Create the contents of the returnValue argument based on the concepts in this object
java.util.List	getRestrictionElements()
boolean	refersToConcept(Concept aConcept, DiscoverableTaxonomySet instanceDts) Determine if the given concept is used by this element.
void	setRestrictionElements(java.util.List restrictionElements)

Methods inherited from interface com.batavia.xbrl.taxonomy.type.RestrictionElement

getActualMaxOccurs, getActualMinOccurs, getMaxOccursValue, getMinOccursValue, getRefsToConcept, isPresent, validate

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

Methods inherited from interface com.batavia.xbrl.taxonomy.type.ContentCreator

createContents, createMissingContents, getRefConceptNames

Method Detail

refersToConcept

boolean refersToConcept(Concept aConcept,
                        DiscoverableTaxonomySet instanceDts)

Determine if the given concept is used by this element.

Specified by:

refersToConcept in interface RestrictionElement

Parameters:

aConcept -

Returns:

boolean

addRestrictionElement

void addRestrictionElement(RestrictionElement element)

Add the given restriction to the collection of restriction elements for this element

Parameters:

element -

getRestrictionElements

java.util.List getRestrictionElements()

Returns:

Returns the restrictionElements.

setRestrictionElements

void setRestrictionElements(java.util.List restrictionElements)

Parameters:

restrictionElements - The restrictionElements to set.

createContents

void createContents(InstanceElement returnValue,
                    Xbrl aRoot,
                    boolean includeDefaultValues,
                    java.util.List contextList,
                    boolean includeFootnotes)

Create the contents of the returnValue argument based on the concepts in this object

Specified by:

createContents in interface ContentCreator

Parameters:

returnValue -

aRoot -

unit -

context -