com.batavia.xbrl.taxonomy.type
Interface Declaration

All Superinterfaces:

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

All Known Subinterfaces:

Concept, Item, Tuple

public interface Declaration
extends RegularSchemaElement, IdHolder

Declaration for elements that may apear in xml docs

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

XmlElement	createContents(XmlElement parent, boolean includeDefaultValue)
Declaration	getAncestor()
FullyQualifiedName	getNameForTargetNamespace()
FullyQualifiedName	getNameForTargetNamespace(XbrlElement parent)
XmlAttribute	getSubstitutionGroup()
XbrlType	getXmlType()
boolean	isAbstract()
boolean	isInSubstitutionGroup(FullyQualifiedName substitutionGroup)
boolean	isPresent(XmlParticle element, com.j2r.xbrl.taxonomy.type.Valid valid, int min, int max)
void	setSubstitutionGroup(XmlAttribute substitutionGroup)
boolean	validate(XmlElement xmlElement, 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 XbrlValidationMessages collection.
void	validate(XmlParticle element, ValidationDocument msgs, com.j2r.xbrl.taxonomy.type.Valid offsetHolder, int min, int max)

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.xml.IdHolder

getId

Method Detail

getNameForTargetNamespace

FullyQualifiedName getNameForTargetNamespace()

getNameForTargetNamespace

FullyQualifiedName getNameForTargetNamespace(XbrlElement parent)

createContents

XmlElement createContents(XmlElement parent,
                          boolean includeDefaultValue)

getSubstitutionGroup

XmlAttribute getSubstitutionGroup()

Returns:

Returns the substitutionGroup.

setSubstitutionGroup

void setSubstitutionGroup(XmlAttribute substitutionGroup)

Parameters:

substitutionGroup - The substitutionGroup to set.

validate

boolean validate(XmlElement xmlElement,
                 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 XbrlValidationMessages collection.

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

isPresent

boolean isPresent(XmlParticle element,
                  com.j2r.xbrl.taxonomy.type.Valid valid,
                  int min,
                  int max)

validate

void validate(XmlParticle element,
              ValidationDocument msgs,
              com.j2r.xbrl.taxonomy.type.Valid offsetHolder,
              int min,
              int max)

isAbstract

boolean isAbstract()

getAncestor

Declaration getAncestor()

isInSubstitutionGroup

boolean isInSubstitutionGroup(FullyQualifiedName substitutionGroup)

getXmlType

XbrlType getXmlType()