XSParticle Class Reference

Inheritance diagram for XSParticle:

XSObject XMemory

List of all members.

Public Types

enum  TERM_TYPE { TERM_EMPTY = 0, TERM_ELEMENT = XSConstants::ELEMENT_DECLARATION, TERM_MODELGROUP = XSConstants::MODEL_GROUP_DEFINITION, TERM_WILDCARD = XSConstants::WILDCARD }

Public Member Functions

Constructors
 XSParticle (TERM_TYPE termType, XSModel *const xsModel, XSObject *const particleTerm, int minOccurs, int maxOccurs, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 The default constructor.
Destructor
 ~XSParticle ()
XSParticle methods
int getMinOccurs () const
 [min occurs]: determines the minimum number of terms that can occur.
int getMaxOccurs () const
 [max occurs] determines the maximum number of terms that can occur.
bool getMaxOccursUnbounded () const
 [max occurs] whether the maxOccurs value is unbounded.
TERM_TYPE getTermType () const
 Returns the type of the [term]: one of TERM_EMPTY, TERM_ELEMENT, TERM_MODELGROUP, or TERM_WILDCARD.
XSElementDeclarationgetElementTerm ()
 If this particle has an [element declaration] for its term, this method returns that declaration; otherwise, it returns 0.
XSModelGroupgetModelGroupTerm ()
 If this particle has a [model group] for its term, this method returns that definition; otherwise, it returns 0.
XSWildcardgetWildcardTerm ()
 If this particle has an [wildcard] for its term, this method returns that declaration; otherwise, it returns 0.

Protected Attributes

TERM_TYPE fTermType
int fMinOccurs
int fMaxOccurs
XSObjectfTerm


Member Enumeration Documentation

enum XSParticle::TERM_TYPE

Enumerator:
TERM_EMPTY 
TERM_ELEMENT 
TERM_MODELGROUP 
TERM_WILDCARD 


Constructor & Destructor Documentation

XSParticle::XSParticle ( TERM_TYPE  termType,
XSModel *const   xsModel,
XSObject *const   particleTerm,
int  minOccurs,
int  maxOccurs,
MemoryManager *const   manager = XMLPlatformUtils::fgMemoryManager 
)

The default constructor.

Parameters:
termType 
xsModel 
particleTerm 
minOccurs 
maxOccurs 
manager The configurable memory manager

XSParticle::~XSParticle (  ) 


Member Function Documentation

int XSParticle::getMinOccurs (  )  const

[min occurs]: determines the minimum number of terms that can occur.

int XSParticle::getMaxOccurs (  )  const

[max occurs] determines the maximum number of terms that can occur.

To query for value of unbounded use maxOccursUnbounded.

bool XSParticle::getMaxOccursUnbounded (  )  const

[max occurs] whether the maxOccurs value is unbounded.

XSParticle::TERM_TYPE XSParticle::getTermType (  )  const

Returns the type of the [term]: one of TERM_EMPTY, TERM_ELEMENT, TERM_MODELGROUP, or TERM_WILDCARD.

XSElementDeclaration* XSParticle::getElementTerm (  ) 

If this particle has an [element declaration] for its term, this method returns that declaration; otherwise, it returns 0.

Returns:
The element declaration that is the [term] of this Particle if and only if getTermType() == TERM_ELEMENT.

XSModelGroup* XSParticle::getModelGroupTerm (  ) 

If this particle has a [model group] for its term, this method returns that definition; otherwise, it returns 0.

Returns:
The model group that is the [term] of this Particle if and only if getTermType() == TERM_MODELGROUP.

XSWildcard* XSParticle::getWildcardTerm (  ) 

If this particle has an [wildcard] for its term, this method returns that declaration; otherwise, it returns 0.

Returns:
The wildcard declaration that is the [term] of this Particle if and only if getTermType() == TERM_WILDCARD.


Member Data Documentation

TERM_TYPE XSParticle::fTermType [protected]

int XSParticle::fMinOccurs [protected]

int XSParticle::fMaxOccurs [protected]

XSObject* XSParticle::fTerm [protected]


The documentation for this class was generated from the following file:
Generated on Thu Feb 19 11:35:46 2009 for Xerces-C++ by  doxygen 1.5.4