API Docs for SAX and DOM                 XMLElementDecl.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2001 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Log: XMLElementDecl.hpp,v $ * Revision 1.10 2003/11/27 06:08:18 neilg * mark DOMTypeInfo-related methods on XMLElementDecl deprecated since they are not thread-safe * * Revision 1.9 2003/11/24 05:19:15 neilg * update method documentation * * Revision 1.8 2003/10/10 16:23:29 peiyongz * Implementation of Serialization/Deserialization * * Revision 1.7 2003/05/16 21:36:55 knoaman * Memory manager implementation: Modify constructors to pass in the memory manager. * * Revision 1.6 2003/05/15 18:26:07 knoaman * Partial implementation of the configurable memory manager. * * Revision 1.5 2003/03/07 18:08:10 tng * Return a reference instead of void for operator= * * Revision 1.4 2003/01/29 19:45:35 gareth * added api for DOMTypeInfo * * Revision 1.3 2002/11/04 15:00:21 tng * C++ Namespace Support. * * Revision 1.2 2002/08/20 16:55:33 tng * [Bug 6251] Info during compilation. * * Revision 1.1.1.1 2002/02/01 22:21:51 peiyongz * sane_include * * Revision 1.18 2001/08/21 16:06:10 tng * Schema: Unique Particle Attribution Constraint Checking. * * Revision 1.17 2001/07/24 18:30:47 knoaman * Added support for <group> + extra constraint checking for complexType * * Revision 1.16 2001/06/21 14:25:28 knoaman * Fix for bug 1946 * * Revision 1.15 2001/05/11 13:25:32 tng * Copyright update. * * Revision 1.14 2001/05/03 20:34:22 tng * Schema: SchemaValidator update * * Revision 1.13 2001/04/19 18:16:52 tng * Schema: SchemaValidator update, and use QName in Content Model * * Revision 1.12 2001/03/21 21:56:02 tng * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar. * * Revision 1.11 2001/03/21 19:29:29 tng * Schema: Content Model Updates, by Pei Yong Zhang. * * Revision 1.10 2001/02/26 19:29:13 tng * Schema: add virtual method getURI(), getContentSpec and setContenSpec in XMLElementDecl, and DTDElementDecl. * * Revision 1.9 2001/02/26 19:21:30 tng * Schema: add parameter prefix in findElem and findAttr. * * Revision 1.8 2000/12/14 18:49:57 tng * Fix API document generation warning: "Warning: end of member group without matching begin" * * Revision 1.7 2000/11/30 18:22:38 andyh * reuseValidator - fix bugs (spurious errors) that occured on reuse due to * pools already containing some items. Fixed by Tinny Ng. * * Revision 1.6 2000/05/11 23:11:32 andyh * Add missing validity checks for stand-alone documents, character range * and Well-formed parsed entities. Changes contributed by Sean MacRoibeaird * <sean.Macroibeaird@ireland.sun.com> * * Revision 1.5 2000/02/24 20:00:23 abagchi * Swat for removing Log from API docs * * Revision 1.4 2000/02/16 19:48:56 roddey * More documentation updates * * Revision 1.3 2000/02/15 01:21:30 roddey * Some initial documentation improvements. More to come... * * Revision 1.2 2000/02/06 07:47:48 rahulj * Year 2K copyright swat. * * Revision 1.1.1.1 1999/11/09 01:08:32 twl * Initial checkin * * Revision 1.2 1999/11/08 20:44:38 rahul * Swat for adding in Product name and CVS comment log variable. * */ #if !defined(XMLELEMENTDECL_HPP) #define XMLELEMENTDECL_HPP #include <xercesc/framework/XMLAttr.hpp> #include <xercesc/framework/XMLAttDefList.hpp> #include <xercesc/util/XMLString.hpp> #include <xercesc/util/PlatformUtils.hpp> #include <xercesc/internal/XSerializable.hpp> XERCES_CPP_NAMESPACE_BEGIN class ContentSpecNode; class XMLContentModel; class XMLElementDecl : public XSerializable, public XMemory { public: // ----------------------------------------------------------------------- // Class specific types // // CreateReasons // This type is used to store how an element declaration got into // the grammar's element pool. They are faulted in for various // reasons. // // LookupOpts // These are the values used by the attribute lookup methods. // // CharDataOpts // This is used to indicate how this type of element reacts to // character data as content. // ----------------------------------------------------------------------- enum CreateReasons { NoReason , Declared , AttList , InContentModel , AsRootElem , JustFaultIn }; enum LookupOpts { AddIfNotFound , FailIfNotFound }; enum CharDataOpts { NoCharData , SpacesOk , AllCharData }; // ----------------------------------------------------------------------- // Public static data // // fgInvalidElemId // A value to represent an invalid element node id. // // fgPCDataElemId // This is the value to use to represent a PCDATA node when an // element id is required. // // fgPCDataElemName // This is the value to use to represent a PCDATA node when an // element name is required. // ----------------------------------------------------------------------- static const unsigned int fgInvalidElemId; static const unsigned int fgPCDataElemId; static const XMLCh fgPCDataElemName[]; // ----------------------------------------------------------------------- // Destructor // ----------------------------------------------------------------------- virtual ~XMLElementDecl(); // ----------------------------------------------------------------------- // The virtual element decl interface // ----------------------------------------------------------------------- virtual XMLAttDef* findAttr ( const XMLCh* const qName , const unsigned int uriId , const XMLCh* const baseName , const XMLCh* const prefix , const LookupOpts options , bool& wasAdded ) const = 0; virtual XMLAttDefList& getAttDefList() const = 0; virtual CharDataOpts getCharDataOpts() const = 0; virtual bool hasAttDefs() const = 0; virtual bool resetDefs() = 0; virtual const ContentSpecNode* getContentSpec() const = 0; virtual ContentSpecNode* getContentSpec() = 0; virtual void setContentSpec(ContentSpecNode* toAdopt) = 0; virtual XMLContentModel* getContentModel() = 0; virtual void setContentModel(XMLContentModel* const newModelToAdopt) = 0; virtual const XMLCh* getFormattedContentModel () const = 0; // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- const XMLCh* getBaseName() const; XMLCh* getBaseName(); unsigned int getURI() const; const QName* getElementName() const; QName* getElementName(); const XMLCh* getFullName() const; CreateReasons getCreateReason() const; unsigned int getId() const; virtual const XMLCh* getDOMTypeInfoUri() const = 0; virtual const XMLCh* getDOMTypeInfoName() const = 0; bool isDeclared() const; bool isExternal() const; MemoryManager* getMemoryManager() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setElementName(const XMLCh* const prefix , const XMLCh* const localPart , const int uriId ); void setElementName(const XMLCh* const rawName , const int uriId ); void setElementName(const QName* const elementName); void setCreateReason(const CreateReasons newReason); void setId(const unsigned int newId); void setExternalElemDeclaration(const bool aValue); // ----------------------------------------------------------------------- // Miscellaneous methods // ----------------------------------------------------------------------- /*** * Support for Serialization/De-serialization ***/ DECL_XSERIALIZABLE(XMLElementDecl) protected : // ----------------------------------------------------------------------- // Hidden constructors // ----------------------------------------------------------------------- XMLElementDecl(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); private : // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- XMLElementDecl(const XMLElementDecl&); XMLElementDecl& operator=(const XMLElementDecl&); // ----------------------------------------------------------------------- // Data members // // fElementName // This is the name of the element decl. // // fCreateReason // We sometimes have to put an element decl object into the elem // decl pool before the element's declaration is seen, such as when // its used in another element's content model or an att list is // seen for it. This flag tells us whether its been declared, and // if not why it had to be created. // // fId // The unique id of this element. This is created by the derived // class, or more accurately the grammar that owns the objects // of the derived types. But, since they all have to have them, we // let them all store the id here. It is defaulted to have the // value fgInvalidElem until explicitly set. // // fExternalElement // This flag indicates whether or the element was declared externally. // ----------------------------------------------------------------------- MemoryManager* fMemoryManager; QName* fElementName; CreateReasons fCreateReason; unsigned int fId; bool fExternalElement; }; // --------------------------------------------------------------------------- // XMLElementDecl: Getter methods // --------------------------------------------------------------------------- inline const XMLCh* XMLElementDecl::getBaseName() const { return fElementName->getLocalPart(); } inline XMLCh* XMLElementDecl::getBaseName() { return fElementName->getLocalPart(); } inline unsigned int XMLElementDecl::getURI() const { return fElementName->getURI(); } inline const QName* XMLElementDecl::getElementName() const { return fElementName; } inline QName* XMLElementDecl::getElementName() { return fElementName; } inline const XMLCh* XMLElementDecl::getFullName() const { return fElementName->getRawName(); } inline XMLElementDecl::CreateReasons XMLElementDecl::getCreateReason() const { return fCreateReason; } inline unsigned int XMLElementDecl::getId() const { return fId; } inline bool XMLElementDecl::isDeclared() const { return (fCreateReason == Declared); } inline bool XMLElementDecl::isExternal() const { return fExternalElement; } inline MemoryManager* XMLElementDecl::getMemoryManager() const { return fMemoryManager; } // --------------------------------------------------------------------------- // XMLElementDecl: Setter methods // --------------------------------------------------------------------------- inline void XMLElementDecl::setCreateReason(const XMLElementDecl::CreateReasons newReason) { fCreateReason = newReason; } inline void XMLElementDecl::setId(const unsigned int newId) { fId = newId; } inline void XMLElementDecl::setExternalElemDeclaration(const bool aValue) { fExternalElement = aValue; } XERCES_CPP_NAMESPACE_END #endif

Copyright © 2003 The Apache Software Foundation. All Rights Reserved.