org.apache.xerces.impl.xs

Class XSParticleDecl

java.lang.Object

org.apache.xerces.impl.xs.XSParticleDecl

All Implemented Interfaces:

XSObject, XSParticle

public class XSParticleDecl
extends Object
implements XSParticle

Store schema particle declaration.

Version:

$Id$

Author:

Sandy Gao, IBM

Field Summary

Fields

Modifier and Type	Field and Description
XSObjectList	fAnnotations
int	fMaxOccurs
int	fMinOccurs
short	fType
XSTerm	fValue
static short	PARTICLE_ELEMENT
static short	PARTICLE_EMPTY
static short	PARTICLE_MODELGROUP
static short	PARTICLE_ONE_OR_MORE
static short	PARTICLE_WILDCARD
static short	PARTICLE_ZERO_OR_MORE
static short	PARTICLE_ZERO_OR_ONE

Constructor Summary

Constructors

Constructor and Description
XSParticleDecl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	emptiable() 3.9.6 Schema Component Constraint: Particle Emptiable whether this particle is emptible
XSObjectList	getAnnotations() Optional.
int	getMaxOccurs() {max occurs} determines the maximum number of terms that can occur.
boolean	getMaxOccursUnbounded() {max occurs} whether the maxOccurs value is unbounded.
int	getMinOccurs() {min occurs} determines the minimum number of terms that can occur.
String	getName() The name of this XSObject depending on the XSObject type.
String	getNamespace() The namespace URI of this node, or null if it is unspecified.
XSNamespaceItem	getNamespaceItem() A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.
XSTerm	getTerm() {term} One of a model group, a wildcard, or an element declaration.
short	getType() Get the type of the object, i.e ELEMENT_DECLARATION.
boolean	isEmpty()
XSParticleDecl	makeClone()
int	maxEffectiveTotalRange()
int	minEffectiveTotalRange() 3.8.6 Effective Total Range (all and sequence) and Effective Total Range (choice) The following methods are used to return min/max range for a particle.
void	reset()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARTICLE_EMPTY

public static final short PARTICLE_EMPTY

See Also:

Constant Field Values

PARTICLE_ELEMENT

public static final short PARTICLE_ELEMENT

See Also:

Constant Field Values

PARTICLE_WILDCARD

public static final short PARTICLE_WILDCARD

See Also:

Constant Field Values

PARTICLE_MODELGROUP

public static final short PARTICLE_MODELGROUP

See Also:

Constant Field Values

PARTICLE_ZERO_OR_MORE

public static final short PARTICLE_ZERO_OR_MORE

See Also:

Constant Field Values

PARTICLE_ZERO_OR_ONE

public static final short PARTICLE_ZERO_OR_ONE

See Also:

Constant Field Values

PARTICLE_ONE_OR_MORE

public static final short PARTICLE_ONE_OR_MORE

See Also:

Constant Field Values

fType

public short fType

fValue

public XSTerm fValue

fMinOccurs

public int fMinOccurs

fMaxOccurs

public int fMaxOccurs

fAnnotations

public XSObjectList fAnnotations

Constructor Detail

XSParticleDecl

public XSParticleDecl()

Method Detail

makeClone

public XSParticleDecl makeClone()

emptiable

public boolean emptiable()

3.9.6 Schema Component Constraint: Particle Emptiable whether this particle is emptible

isEmpty

public boolean isEmpty()

minEffectiveTotalRange

public int minEffectiveTotalRange()

3.8.6 Effective Total Range (all and sequence) and Effective Total Range (choice) The following methods are used to return min/max range for a particle. They are not exactly the same as it's described in the spec, but all the values from the spec are retrievable by these methods.

maxEffectiveTotalRange

public int maxEffectiveTotalRange()

toString

public String toString()

Overrides:

toString in class Object

reset

public void reset()

getType

public short getType()

Get the type of the object, i.e ELEMENT_DECLARATION.

Specified by:

getType in interface XSObject

getName

public String getName()

The name of this XSObject depending on the XSObject type.

Specified by:

getName in interface XSObject

getNamespace

public String getNamespace()

The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.

Specified by:

getNamespace in interface XSObject

getMinOccurs

public int getMinOccurs()

{min occurs} determines the minimum number of terms that can occur.

Specified by:

getMinOccurs in interface XSParticle

getMaxOccursUnbounded

public boolean getMaxOccursUnbounded()

{max occurs} whether the maxOccurs value is unbounded.

Specified by:

getMaxOccursUnbounded in interface XSParticle

getMaxOccurs

public int getMaxOccurs()

{max occurs} determines the maximum number of terms that can occur.

Specified by:

getMaxOccurs in interface XSParticle

getTerm

public XSTerm getTerm()

{term} One of a model group, a wildcard, or an element declaration.

Specified by:

getTerm in interface XSParticle

getNamespaceItem

public XSNamespaceItem getNamespaceItem()

Description copied from interface: XSObject

A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.

Specified by:

getNamespaceItem in interface XSObject

See Also:

XSObject.getNamespaceItem()

getAnnotations

public XSObjectList getAnnotations()

Optional. Annotations.

Specified by:

getAnnotations in interface XSParticle