com.batavia.xbrl.taxonomy.type
Interface XbrlType

All Superinterfaces:

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

All Known Subinterfaces:

BasicType, ComplexType, FractionItemType, SimpleContent, SimpleType

public interface XbrlType
extends TaxonomyElement

interface for all types in the taxonomy domain

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

XmlAttribute	getBase()
XbrlType	getDerivedFrom()
XmlAttribute	getNameAttribute()
FullyQualifiedName	getNameForTargetNamespace() get the name for the targetted namespace
com.sun.msv.datatype.xsd.XSDatatype	getXSDatatype()
boolean	isDerivedFrom(FullyQualifiedName nameOfType) Determine if the this type is derived from the type identified by the given name
boolean	isFraction() determine if the type is a Fraction
boolean	isNonNumeric() determine if the type is alphanumeric
boolean	isNumeric() determine if the type is numeric
boolean	isNumericNonFraction() determine if the type is numeric but not a Fraction
boolean	isTypeOrDerivedFromType(FullyQualifiedName nameOfType) Determine if the this type is derived from or is the type identified by the given name
void	setDerivedFrom(XbrlType derivedFrom)
boolean	validate(XmlParticle element, ValidationDocument msgs) validate the element with the rules for this type

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

Method Detail

isTypeOrDerivedFromType

boolean isTypeOrDerivedFromType(FullyQualifiedName nameOfType)

Determine if the this type is derived from or is the type identified by the given name

Parameters:

nameOfType -

Returns:

true when this type is derived from or is the given type

isDerivedFrom

boolean isDerivedFrom(FullyQualifiedName nameOfType)

Determine if the this type is derived from the type identified by the given name

Parameters:

nameOfType -

Returns:

true when this type is derived from the given type

getNameAttribute

XmlAttribute getNameAttribute()

Returns:

Returns the nameAttribute.

getNameForTargetNamespace

FullyQualifiedName getNameForTargetNamespace()

get the name for the targetted namespace

Returns:

isNonNumeric

boolean isNonNumeric()

determine if the type is alphanumeric

isFraction

boolean isFraction()

determine if the type is a Fraction

isNumericNonFraction

boolean isNumericNonFraction()

determine if the type is numeric but not a Fraction

isNumeric

boolean isNumeric()

determine if the type is numeric

validate

boolean validate(XmlParticle element,
                 ValidationDocument msgs)

validate the element with the rules for this type

Parameters:

value -

Returns:

getDerivedFrom

XbrlType getDerivedFrom()

Returns:

Returns the derivedFrom.

setDerivedFrom

void setDerivedFrom(XbrlType derivedFrom)

Parameters:

derivedFrom - The derivedFrom to set.

getXSDatatype

com.sun.msv.datatype.xsd.XSDatatype getXSDatatype()

Returns:

Returns the baseType if any.

getBase

XmlAttribute getBase()

Returns:

Returns the attribute that indicates the base for this type if any.