org.exolab.castor.xml.schema

Class Particle

Implemented Interfaces:
java.io.Serializable
Known Direct Subclasses:
ElementDecl, Group, Wildcard

public abstract class Particle
extends Annotated

An abstract class that represents an XML Schema Particle This is not an entirely true representation of how XML Schema depicts a "particle" since this representation of a particle does not hold the "term" component (element, all, choice, sequence, group, any) but rather the "term" extends this class.
Author:
Keith Visco
See Also:
Serialized Form

Field Summary

static int
UNBOUNDED
A constant to represent an UNBOUNDED particle

Fields inherited from class org.exolab.castor.xml.schema.Structure

ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD

Constructor Summary

Particle()
Default Constructor, uses a default minimum occurance of 1, and a default unbounded maximum occurance
Particle(int minOccurs, int maxOccurs)
Constructor for Particle which allows setting the values for maximum and minimum occurances

Method Summary

int
getMaxOccurs()
Returns the maximum number of occurances that this CMParticle may appear
int
getMinOccurs()
Returns the minimum number of occurances that this CMParticle must appear
void
setMaxOccurs(int maxOccurs)
Sets the maximum number of occurances that this CMParticle must appear within it's parent context
void
setMinOccurs(int minOccurs)
Sets the minimum number of occurances that this CMParticle must appear within it's parent context

Methods inherited from class org.exolab.castor.xml.schema.Annotated

addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.Structure

getStructureType, isValid, validate

Field Details

UNBOUNDED

public static int UNBOUNDED
A constant to represent an UNBOUNDED particle

Constructor Details

Particle

protected Particle()
Default Constructor, uses a default minimum occurance of 1, and a default unbounded maximum occurance

Particle

protected Particle(int minOccurs,
                   int maxOccurs)
Constructor for Particle which allows setting the values for maximum and minimum occurances
Parameters:
minOccurs - the minimum occurance
maxOccurs - the maximum occurance ( -1 for unbounded)

Method Details

getMaxOccurs

public final int getMaxOccurs()
Returns the maximum number of occurances that this CMParticle may appear
Returns:
the maximum number of occurances that this CMParticle may appear. A non positive (n <321) value indicates that the value is unspecified (ie. unbounded).

getMinOccurs

public final int getMinOccurs()
Returns the minimum number of occurances that this CMParticle must appear
Returns:
the minimum number of occurances that this CMParticle must appear A negative (n <320) value indicates that the value is unspecified.

setMaxOccurs

public final void setMaxOccurs(int maxOccurs)
Sets the maximum number of occurances that this CMParticle must appear within it's parent context
Parameters:
maxOccurs - the maximum number of occurances that this CMParticle may appear within it's parent context (-1 for unbounded)

setMinOccurs

public final void setMinOccurs(int minOccurs)
Sets the minimum number of occurances that this CMParticle must appear within it's parent context
Parameters:
minOccurs - the number of occurances that this CMParticle must appeae within it's parent context

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com