com.batavia.xml
Interface XmlParticle

All Superinterfaces:

java.lang.Comparable, ComparablePart, org.relaxng.datatype.ValidationContext

All Known Subinterfaces:

All, Annotation, AnyAttribute, AnyElement, AppInfo, Arc, ArcroleRef, ArcroleType, AttributeGroup, AttributeType, BasicType, CalculationArc, CalculationLink, Choice, ComplexContent, ComplexType, Concept, Context, ContextElement, DateTime, Declaration, DeclaredArc, DeclaredLink, DeclaredResource, Definition, DefinitionArc, DefinitionLink, DimensionalContext, DimensionalFractionItem, DimensionalItem, DimensionalMember, DimensionalScenario, DimensionalSegment, Divide, Documentation, Documentation, EndDate, Entity, ExplicitMember, ExtendedLink, Extension, ExtensionType, Fact, Footnote, FootnoteArc, FootnoteLink, FootnoteLocator, Forever, Fraction, FractionDenominator, FractionItemType, FractionNumerator, FractionPart, FullyQualifiedName, Group, GroupRefElement, Identifier, Import, Include, InstanceElement, Instant, Item, Item, Label, LabelArc, Labelled, LabelLink, Linkbase, LinkbaseExtendedLink, LinkbaseRef, LinkbaseRef, LinkbaseRoot, LinkElement, Locator, Measure, MessageElement, MessagesElement, OriginElement, Part, Period, PresentationArc, PresentationLink, Redefine, RefElement, Reference, ReferenceArc, ReferenceLink, RegularInstanceElement, RegularSchemaElement, RelationLink, ReportScope, Resource, Restriction, RestrictionElement, RoleRef, RoleType, RoleTypeElement, Root, RootElement, Scenario, SchemaRef, Segment, Sequence, SimpleContent, SimpleLink, SimpleType, StartDate, TaxonomyElement, Title, Tuple, Tuple, TypedMember, Unit, UnitDenominator, UnitElement, UnitNumerator, UnknownInstanceElement, UnknownTaxonomyElement, UnknownXlink, UsedOn, Xbrl, XbrlElement, XbrlType, Xlink, XmlAttribute, XmlElement

public interface XmlParticle
extends ComparablePart, org.relaxng.datatype.ValidationContext

Interface for all parts within the XBRL domain.

This interface implements the link to the parent and its implementors provide parts of the comparable interfaces implementations.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	destroy()
java.lang.String	getBaseUri() Get the uri of the targetNamespace.
NameSpace	getNameSpace(java.lang.String namePrefix) Get the namespace that is associated with the given prefix; if not here, check the parent (if not null or equal to this).
XmlParticle	getParent() Get the direct parent.
java.lang.String	getPrefix(NameSpace nameSpace) Get the prefix the namespace is known by; if not here, check the parent (if not null or equal to this Attributes do not have a default namespace, so when the argument is null the return value is null.
NameSpace	getTargetNameSpace() Get the namespace this particle is contributing to.
boolean	isBoolean() Determine if this XmlParticle represents a boolean type.
boolean	isNumber() Determine if this XmlParticle represents a numeric type.
boolean	p_equal(ComparablePart other) Determine if the other is Parent equal to this.
java.lang.String	resolveNamespacePrefix(java.lang.String prefix) Resolve the uri of the namespace that the prefix indicates.
void	setParent(XmlParticle parent) Set the parent.
java.lang.String	toXstring() Convert this XmlParticle to a String representation that can be used for a x_equal [XPATH] comparison.

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

Method Detail

getBaseUri

java.lang.String getBaseUri()

Get the uri of the targetNamespace. The targetNamespace is the namespace the particle contributes to. This target is determined by the root element that contains this particle.

Specified by:

getBaseUri in interface org.relaxng.datatype.ValidationContext

Returns:

the base uri, uri of the targetnamespace.

getNameSpace

NameSpace getNameSpace(java.lang.String namePrefix)

Get the namespace that is associated with the given prefix; if not here, check the parent (if not null or equal to this). Attributes do not have a default namespace, so when the argument is null or an empty String the return value is null.

Returns:

Returns the namesSpace, returns null if no namespace is associated with the given namePrefix.

getParent

XmlParticle getParent()

Get the direct parent.

Returns:

the parent.

getPrefix

java.lang.String getPrefix(NameSpace nameSpace)

Get the prefix the namespace is known by; if not here, check the parent (if not null or equal to this Attributes do not have a default namespace, so when the argument is null the return value is null.

Returns:

Returns the namesSpace prefix, returns null if no namespace is associated with the given namePrefix.

getTargetNameSpace

NameSpace getTargetNameSpace()

Get the namespace this particle is contributing to. If This element has not got one, its parent target namespace will be returned.

Returns:

Returns the target nameSpace.

isBoolean

boolean isBoolean()

Determine if this XmlParticle represents a boolean type.

Returns:

true if this XmlParticle represents a boolean type.

isNumber

boolean isNumber()

Determine if this XmlParticle represents a numeric type.

Returns:

true if this XmlParticle represents a numeric type.

resolveNamespacePrefix

java.lang.String resolveNamespacePrefix(java.lang.String prefix)

Resolve the uri of the namespace that the prefix indicates.

Specified by:

resolveNamespacePrefix in interface org.relaxng.datatype.ValidationContext

Returns:

the uri that was resolved or null if not found.

setParent

void setParent(XmlParticle parent)

Set the parent.

Parameters:

parent - The parent to set.

toXstring

java.lang.String toXstring()

Convert this XmlParticle to a String representation that can be used for a x_equal [XPATH] comparison.

Returns:

namespace_uri:name String that can be used for a x_equal [XPATH] comparison.

p_equal

boolean p_equal(ComparablePart other)

Determine if the other is Parent equal to this. return true when other is Parent equal to this.

destroy

void destroy()