org.apache.xerces.impl.xs

Class XSParticleDecl

Implemented Interfaces:
org.apache.xerces.xs.XSParticle

public class XSParticleDecl
extends java.lang.Object
implements org.apache.xerces.xs.XSParticle

Store schema particle declaration.
Version:
$Id: XSParticleDecl.java 388853 2006-03-25 23:05:56Z mrglavas $
Author:
Sandy Gao, IBM

Field Summary

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
org.apache.xerces.xs.XSObjectList
fAnnotations
int
fMaxOccurs
int
fMinOccurs
short
fType
org.apache.xerces.xs.XSTerm
fValue

Method Summary

boolean
emptiable()
3.9.6 Schema Component Constraint: Particle Emptiable whether this particle is emptible
org.apache.xerces.xs.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.
org.apache.xerces.xs.XSNamespaceItem
getNamespaceItem()
org.apache.xerces.xs.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()

Field Details

PARTICLE_ELEMENT

public static final short PARTICLE_ELEMENT
Field Value:
1

PARTICLE_EMPTY

public static final short PARTICLE_EMPTY
Field Value:
0

PARTICLE_MODELGROUP

public static final short PARTICLE_MODELGROUP
Field Value:
3

PARTICLE_ONE_OR_MORE

public static final short PARTICLE_ONE_OR_MORE
Field Value:
6

PARTICLE_WILDCARD

public static final short PARTICLE_WILDCARD
Field Value:
2

PARTICLE_ZERO_OR_MORE

public static final short PARTICLE_ZERO_OR_MORE
Field Value:
4

PARTICLE_ZERO_OR_ONE

public static final short PARTICLE_ZERO_OR_ONE
Field Value:
5

fAnnotations

public org.apache.xerces.xs.XSObjectList fAnnotations

fMaxOccurs

public int fMaxOccurs

fMinOccurs

public int fMinOccurs

fType

public short fType

fValue

public org.apache.xerces.xs.XSTerm fValue

Method Details

emptiable

public boolean emptiable()
3.9.6 Schema Component Constraint: Particle Emptiable whether this particle is emptible

getAnnotations

public org.apache.xerces.xs.XSObjectList getAnnotations()
Optional. Annotations.
Specified by:
getAnnotations in interface org.apache.xerces.xs.XSParticle

getMaxOccurs

public int getMaxOccurs()
{max occurs} determines the maximum number of terms that can occur.
Specified by:
getMaxOccurs in interface org.apache.xerces.xs.XSParticle

getMaxOccursUnbounded

public boolean getMaxOccursUnbounded()
{max occurs} whether the maxOccurs value is unbounded.
Specified by:
getMaxOccursUnbounded in interface org.apache.xerces.xs.XSParticle

getMinOccurs

public int getMinOccurs()
{min occurs} determines the minimum number of terms that can occur.
Specified by:
getMinOccurs in interface org.apache.xerces.xs.XSParticle

getName

public String getName()
The name of this XSObject depending on the XSObject type.
Specified by:
getName in interface org.apache.xerces.xs.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 org.apache.xerces.xs.XSObject

getNamespaceItem

public org.apache.xerces.xs.XSNamespaceItem getNamespaceItem()
Specified by:
getNamespaceItem in interface org.apache.xerces.xs.XSObject
See Also:
org.apache.xerces.xs.XSObject.getNamespaceItem()

getTerm

public org.apache.xerces.xs.XSTerm getTerm()
{term} One of a model group, a wildcard, or an element declaration.
Specified by:
getTerm in interface org.apache.xerces.xs.XSParticle

getType

public short getType()
Get the type of the object, i.e ELEMENT_DECLARATION.
Specified by:
getType in interface org.apache.xerces.xs.XSObject

isEmpty

public boolean isEmpty()

makeClone

public XSParticleDecl makeClone()

maxEffectiveTotalRange

public int maxEffectiveTotalRange()

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.

reset

public void reset()

toString

public String toString()

Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.