Top Description Fields Constructors Methods
org.apache.xerces.impl.xs

public Class XSParticleDecl

extends Object
implements XSParticle
Class Inheritance
All Implemented Interfaces
org.apache.xerces.xs.XSParticle, org.apache.xerces.xs.XSObject
Imports
org.apache.xerces.impl.xs.util.XSObjectListImpl, org.apache.xerces.xs.XSConstants, .XSNamespaceItem, .XSObjectList, .XSParticle, .XSTerm
Store schema particle declaration.
Author
Sandy Gao, IBM
Version
$Id: XSParticleDecl.java 965250 2010-07-18 16:04:58Z mrglavas $

Field Summary

Modifier and TypeField and Description
public XSObjectList
fAnnotations

private String
fDescription

get the string description of this particle

public int
fMaxOccurs

public int
fMinOccurs

public short
fType

public XSTerm
fValue

public static final short
PARTICLE_ELEMENT

public static final short
PARTICLE_EMPTY

public static final short
PARTICLE_MODELGROUP

public static final short
PARTICLE_ONE_OR_MORE

public static final short
PARTICLE_WILDCARD

public static final short
PARTICLE_ZERO_OR_MORE

public static final short
PARTICLE_ZERO_OR_ONE

Constructor Summary

AccessConstructor and Description
public
XSParticleDecl()

Method Summary

Modifier and TypeMethod and Description
pack-priv void
appendParticle(StringBuffer buffer)

append the string description of this particle to the string buffer this is for error message.

public boolean
emptiable()

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

public XSObjectList
getAnnotations()

Implements org.apache.xerces.xs.XSParticle.getAnnotations.

Optional.
public int
getMaxOccurs()

Implements org.apache.xerces.xs.XSParticle.getMaxOccurs.

{max occurs} determines the maximum number of terms that can occur.
public boolean
getMaxOccursUnbounded()

Implements org.apache.xerces.xs.XSParticle.getMaxOccursUnbounded.

{max occurs} whether the maxOccurs value is unbounded.
public int
getMinOccurs()

Implements org.apache.xerces.xs.XSParticle.getMinOccurs.

{min occurs} determines the minimum number of terms that can occur.
public String
getName()

Implements org.apache.xerces.xs.XSObject.getName.

The name of this XSObject depending on the XSObject type.
public String
getNamespace()

Implements org.apache.xerces.xs.XSObject.getNamespace.

The namespace URI of this node, or null if it is unspecified.
public XSNamespaceItem
getNamespaceItem()

Implements org.apache.xerces.xs.XSObject.getNamespaceItem.

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

Implements org.apache.xerces.xs.XSParticle.getTerm.

{term} One of a model group, a wildcard, or an element declaration.
public short
getType()

Implements org.apache.xerces.xs.XSObject.getType.

Get the type of the object, i.e ELEMENT_DECLARATION.
public boolean
isEmpty()

public XSParticleDecl
makeClone()

public int
maxEffectiveTotalRange()

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.

public void
reset()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

fAnnotationsback to summary
public XSObjectList fAnnotations
fDescriptionback to summary
private String fDescription

get the string description of this particle

fMaxOccursback to summary
public int fMaxOccurs
fMinOccursback to summary
public int fMinOccurs
fTypeback to summary
public short fType
fValueback to summary
public XSTerm fValue
PARTICLE_ELEMENTback to summary
public static final short PARTICLE_ELEMENT
PARTICLE_EMPTYback to summary
public static final short PARTICLE_EMPTY
PARTICLE_MODELGROUPback to summary
public static final short PARTICLE_MODELGROUP
PARTICLE_ONE_OR_MOREback to summary
public static final short PARTICLE_ONE_OR_MORE
PARTICLE_WILDCARDback to summary
public static final short PARTICLE_WILDCARD
PARTICLE_ZERO_OR_MOREback to summary
public static final short PARTICLE_ZERO_OR_MORE
PARTICLE_ZERO_OR_ONEback to summary
public static final short PARTICLE_ZERO_OR_ONE

Constructor Detail

XSParticleDeclback to summary
public XSParticleDecl()

Method Detail

appendParticleback to summary
pack-priv void appendParticle(StringBuffer buffer)

append the string description of this particle to the string buffer this is for error message.

emptiableback to summary
public boolean emptiable()

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

getAnnotationsback to summary
public XSObjectList getAnnotations()

Implements org.apache.xerces.xs.XSParticle.getAnnotations.

Optional. Annotations.

getMaxOccursback to summary
public int getMaxOccurs()

Implements org.apache.xerces.xs.XSParticle.getMaxOccurs.

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

getMaxOccursUnboundedback to summary
public boolean getMaxOccursUnbounded()

Implements org.apache.xerces.xs.XSParticle.getMaxOccursUnbounded.

{max occurs} whether the maxOccurs value is unbounded.

getMinOccursback to summary
public int getMinOccurs()

Implements org.apache.xerces.xs.XSParticle.getMinOccurs.

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

getNameback to summary
public String getName()

Implements org.apache.xerces.xs.XSObject.getName.

The name of this XSObject depending on the XSObject type.

getNamespaceback to summary
public String getNamespace()

Implements org.apache.xerces.xs.XSObject.getNamespace.

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

getNamespaceItemback to summary
public XSNamespaceItem getNamespaceItem()

Implements org.apache.xerces.xs.XSObject.getNamespaceItem.

Doc from org.apache.xerces.xs.XSObject.getNamespaceItem.

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

See Also
org.apache.xerces.xs.XSObject#getNamespaceItem()
getTermback to summary
public XSTerm getTerm()

Implements org.apache.xerces.xs.XSParticle.getTerm.

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

getTypeback to summary
public short getType()

Implements org.apache.xerces.xs.XSObject.getType.

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

isEmptyback to summary
public boolean isEmpty()
makeCloneback to summary
public XSParticleDecl makeClone()
maxEffectiveTotalRangeback to summary
public int maxEffectiveTotalRange()
minEffectiveTotalRangeback to summary
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.

resetback to summary
public void reset()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.