|  | 
 XSParticle Class ReferenceThis class describes all properties of a Schema Particle component.  
More...
Inheritance diagram for XSParticle:  [legend]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 |  |  |  |  | XSParticle (TERM_TYPE termType, XSModel *const xsModel, XSObject *const particleTerm, int minOccurs, int maxOccurs, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager) |  |  | The default constructor. 
 |  |  |  |  | ~XSParticle () |  |  |  | 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. 
 |  | XSElementDeclaration * | getElementTerm () |  |  | If this particle has an [element declaration] for its term, this method returns that declaration; otherwise, it returns 0. 
 |  | XSModelGroup * | getModelGroupTerm () |  |  | If this particle has a [model group] for its term, this method returns that definition; otherwise, it returns 0. 
 |  | XSWildcard * | getWildcardTerm () |  |  | 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 |  | XSObject * | fTerm |  
 Detailed DescriptionThis class describes all properties of a Schema Particle component.
This is *always* owned by the validator /parser object from which it is obtained. 
 
 
 Member Enumeration Documentation
 
  
    |  | 
 Enumeration values: 
| TERM_EMPTY |  |  | TERM_ELEMENT |  |  | TERM_MODELGROUP |  |  | TERM_WILDCARD |  | 
 |  
 Constructor & Destructor Documentation
 
  
    |  | 
The default constructor. 
 
 Parameters:
  
    |  | termType |  |  |  | xsModel |  |  |  | particleTerm |  |  |  | minOccurs |  |  |  | maxOccurs |  |  |  | manager | The configurable memory manager | 
 |  
 
 Member Function Documentation
 
  
    |  | 
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. 
 |  
 
  
    | 
        
          | 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. 
 
     |  
 
  
    | 
        
          | int XSParticle::getMinOccurs | ( |  | ) | const |  |  
  
    |  | 
[min occurs]: determines the minimum number of terms that can occur. 
 
     |  
 
  
    |  | 
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. 
 |  
 
  
    |  | 
Returns the type of the [term]: one of TERM_EMPTY, TERM_ELEMENT, TERM_MODELGROUP, or TERM_WILDCARD. 
 
     |  
 
  
    |  | 
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
 
 
 
 The documentation for this class was generated from the following file:
 |