Public Member Functions | Static Public Attributes | Protected Member Functions

org.exolab.castor.xml.schema.Particle Class Reference

Inheritance diagram for org.exolab.castor.xml.schema.Particle:
org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.Structure org.exolab.castor.xml.schema.ElementDecl org.exolab.castor.xml.schema.Group org.exolab.castor.xml.schema.Wildcard org.exolab.castor.xml.schema.ModelGroup

List of all members.

Public Member Functions

final int getMaxOccurs ()
final int getMinOccurs ()
final void setMaxOccurs (int maxOccurs)
final void setMinOccurs (int minOccurs)

Static Public Attributes

static int UNBOUNDED = -1

Protected Member Functions

 Particle ()
 Particle (int minOccurs, int maxOccurs)

Detailed Description

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

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.Particle.Particle (  )  [protected]

Default Constructor, uses a default minimum occurance of 1, and a default unbounded maximum occurance

org.exolab.castor.xml.schema.Particle.Particle ( int  minOccurs,
int  maxOccurs 
) [protected]

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)

References org.exolab.castor.xml.schema.Particle.setMaxOccurs(), and org.exolab.castor.xml.schema.Particle.setMinOccurs().

Member Function Documentation

final int org.exolab.castor.xml.schema.Particle.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 < 1) value indicates that the value is unspecified (ie. unbounded).

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfoForAny(), org.exolab.castor.builder.binding.XMLBindingComponent.createGroupItem(), org.exolab.castor.builder.SourceFactory.createSourceCode(), org.exolab.castor.xml.schema.Group.enumerate(), org.exolab.castor.xml.schema.ComplexType.getMaxOccurs(), org.exolab.castor.xml.schema.reader.GroupUnmarshaller.GroupUnmarshaller(), and org.exolab.castor.xml.schema.ElementDecl.validate().

final int org.exolab.castor.xml.schema.Particle.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 < 0) value indicates that the value is unspecified.

Referenced by org.exolab.castor.builder.MemberFactory.createFieldInfoForAny(), org.exolab.castor.xml.schema.Group.enumerate(), org.exolab.castor.xml.schema.ComplexType.getMinOccurs(), org.exolab.castor.xml.schema.reader.GroupUnmarshaller.GroupUnmarshaller(), and org.exolab.castor.xml.schema.ElementDecl.validate().

final void org.exolab.castor.xml.schema.Particle.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)

Referenced by org.exolab.castor.xml.dtd.Converter.convertContentParticle(), org.exolab.castor.xml.dtd.Converter.convertDTDElementToSchemaElement(), org.exolab.castor.xml.schema.reader.ElementUnmarshaller.ElementUnmarshaller(), org.exolab.castor.xml.schema.util.XMLInstance2SchemaHandler.endElement(), org.exolab.castor.xml.schema.reader.GroupUnmarshaller.GroupUnmarshaller(), org.exolab.castor.xml.schema.reader.WildcardUnmarshaller.init(), org.exolab.castor.xml.schema.reader.ModelGroupUnmarshaller.ModelGroupUnmarshaller(), and org.exolab.castor.xml.schema.Particle.Particle().

final void org.exolab.castor.xml.schema.Particle.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

Referenced by org.exolab.castor.xml.dtd.Converter.convertContentParticle(), org.exolab.castor.xml.dtd.Converter.convertDTDElementToSchemaElement(), org.exolab.castor.xml.schema.reader.ElementUnmarshaller.ElementUnmarshaller(), org.exolab.castor.xml.schema.reader.GroupUnmarshaller.GroupUnmarshaller(), org.exolab.castor.xml.schema.reader.WildcardUnmarshaller.init(), org.exolab.castor.xml.schema.reader.ModelGroupUnmarshaller.ModelGroupUnmarshaller(), and org.exolab.castor.xml.schema.Particle.Particle().

Member Data Documentation

int org.exolab.castor.xml.schema.Particle.UNBOUNDED = -1 [static]

A constant to represent an UNBOUNDED particle

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:56 for ACS-10.0 Java API by  doxygen 1.7.0