XSParticle.hpp

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/*
 * $Id$
 */
 
#if !defined(XERCESC_INCLUDE_GUARD_XSPARTICLE_HPP)
#define XERCESC_INCLUDE_GUARD_XSPARTICLE_HPP
 
#include <xercesc/framework/psvi/XSObject.hpp>
 
XERCES_CPP_NAMESPACE_BEGIN
 
// forward declarations
class XSElementDeclaration;
class XSModelGroup;
class XSWildcard;
 
class XMLPARSER_EXPORT XSParticle : public XSObject
{
public:
 
    // possible terms of this particle
    enum TERM_TYPE {
        /*
         * an empty particle
         */
        TERM_EMPTY          = 0,
        /*
         * the particle has element content
         */
        TERM_ELEMENT        = XSConstants::ELEMENT_DECLARATION,
        /*
         * the particle's content is a model group
         */
        TERM_MODELGROUP     = XSConstants::MODEL_GROUP_DEFINITION,
        /*
         * the particle's content is a wildcard
         */
        TERM_WILDCARD       = XSConstants::WILDCARD
    };
 
    //  Constructors and Destructor
    // -----------------------------------------------------------------------
 
    XSParticle
    (
        TERM_TYPE              termType
        , XSModel* const       xsModel
        , XSObject* const      particleTerm
        , XMLSize_t            minOccurs
        , XMLSize_t            maxOccurs
        , bool                 unbounded
        , MemoryManager* const manager
    );
 
 
    ~XSParticle();
 
    //---------------------
 
    XMLSize_t getMinOccurs() const;
 
    XMLSize_t getMaxOccurs() const;
 
    bool getMaxOccursUnbounded() const;
 
    TERM_TYPE getTermType() const;
 
    XSElementDeclaration *getElementTerm();
 
    XSModelGroup *getModelGroupTerm();
 
    XSWildcard *getWildcardTerm();
 
 
    //----------------------------------
 
private:
 
    // -----------------------------------------------------------------------
    //  Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    XSParticle(const XSParticle&);
    XSParticle & operator=(const XSParticle &);
 
protected:
 
    // -----------------------------------------------------------------------
    //  data members
    // -----------------------------------------------------------------------
    TERM_TYPE fTermType;
    XMLSize_t fMinOccurs;
    XMLSize_t fMaxOccurs;
    bool      fUnbounded;
    XSObject* fTerm;
};
 
inline XMLSize_t XSParticle::getMinOccurs() const
{
    return fMinOccurs;
}
 
inline XMLSize_t XSParticle::getMaxOccurs() const
{
    return fMaxOccurs;
}
 
inline bool XSParticle::getMaxOccursUnbounded() const
{
    return fUnbounded;
}
 
inline XSParticle::TERM_TYPE XSParticle::getTermType() const
{
    return fTermType;
}
 
XERCES_CPP_NAMESPACE_END
 
#endif