| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XMLAttDef.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
    00005  * reserved.
    00006  *
    00007  * Redistribution and use in source and binary forms, with or without
    00008  * modification, are permitted provided that the following conditions
    00009  * are met:
    00010  *
    00011  * 1. Redistributions of source code must retain the above copyright
    00012  *    notice, this list of conditions and the following disclaimer.
    00013  *
    00014  * 2. Redistributions in binary form must reproduce the above copyright
    00015  *    notice, this list of conditions and the following disclaimer in
    00016  *    the documentation and/or other materials provided with the
    00017  *    distribution.
    00018  *
    00019  * 3. The end-user documentation included with the redistribution,
    00020  *    if any, must include the following acknowledgment:
    00021  *       "This product includes software developed by the
    00022  *        Apache Software Foundation (http://www.apache.org/)."
    00023  *    Alternately, this acknowledgment may appear in the software itself,
    00024  *    if and wherever such third-party acknowledgments normally appear.
    00025  *
    00026  * 4. The names "Xerces" and "Apache Software Foundation" must
    00027  *    not be used to endorse or promote products derived from this
    00028  *    software without prior written permission. For written
    00029  *    permission, please contact apache\@apache.org.
    00030  *
    00031  * 5. Products derived from this software may not be called "Apache",
    00032  *    nor may "Apache" appear in their name, without prior written
    00033  *    permission of the Apache Software Foundation.
    00034  *
    00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00046  * SUCH DAMAGE.
    00047  * ====================================================================
    00048  *
    00049  * This software consists of voluntary contributions made by many
    00050  * individuals on behalf of the Apache Software Foundation, and was
    00051  * originally based on software copyright (c) 1999, International
    00052  * Business Machines, Inc., http://www.ibm.com .  For more information
    00053  * on the Apache Software Foundation, please see
    00054  * <http://www.apache.org/>.
    00055  */
    00056
    00057 /*
    00058  * $Log: XMLAttDef.hpp,v $
    00059  * Revision 1.12  2003/12/17 00:18:33  cargilld
    00060  * Update to memory management so that the static memory manager (one used to call Initialize) is only for static data.
    00061  *
    00062  * Revision 1.11  2003/11/24 05:19:15  neilg
    00063  * update method documentation
    00064  *
    00065  * Revision 1.10  2003/10/10 16:23:29  peiyongz
    00066  * Implementation of Serialization/Deserialization
    00067  *
    00068  * Revision 1.9  2003/05/16 21:36:55  knoaman
    00069  * Memory manager implementation: Modify constructors to pass in the memory manager.
    00070  *
    00071  * Revision 1.8  2003/05/15 18:26:07  knoaman
    00072  * Partial implementation of the configurable memory manager.
    00073  *
    00074  * Revision 1.7  2003/04/21 20:46:01  knoaman
    00075  * Use XMLString::release to prepare for configurable memory manager.
    00076  *
    00077  * Revision 1.6  2003/03/07 18:08:10  tng
    00078  * Return a reference instead of void for operator=
    00079  *
    00080  * Revision 1.5  2003/01/29 19:45:35  gareth
    00081  * added api for DOMTypeInfo
    00082  *
    00083  * Revision 1.4  2002/12/10 02:15:55  knoaman
    00084  * Schema Errata: E1-21.
    00085  *
    00086  * Revision 1.3  2002/11/04 15:00:21  tng
    00087  * C++ Namespace Support.
    00088  *
    00089  * Revision 1.2  2002/02/20 18:17:01  tng
    00090  * [Bug 5977] Warnings on generating apiDocs.
    00091  *
    00092  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
    00093  * sane_include
    00094  *
    00095  * Revision 1.13  2001/11/15 16:36:36  knoaman
    00096  * Re-organize constant values.
    00097  *
    00098  * Revision 1.12  2001/08/09 15:23:37  knoaman
    00099  * add support for <anyAttribute> declaration.
    00100  *
    00101  * Revision 1.11  2001/06/21 14:25:26  knoaman
    00102  * Fix for bug 1946
    00103  *
    00104  * Revision 1.10  2001/05/11 13:25:31  tng
    00105  * Copyright update.
    00106  *
    00107  * Revision 1.9  2001/02/27 18:48:20  tng
    00108  * Schema: Add SchemaAttDef, SchemaElementDecl, SchemaAttDefList.
    00109  *
    00110  * Revision 1.8  2000/12/14 18:49:56  tng
    00111  * Fix API document generation warning: "Warning: end of member group without matching begin"
    00112  *
    00113  * Revision 1.7  2000/11/30 18:22:38  andyh
    00114  * reuseValidator - fix bugs (spurious errors) that occured on reuse due to
    00115  * pools already containing some items.  Fixed by Tinny Ng.
    00116  *
    00117  * Revision 1.6  2000/07/07 22:23:38  jpolast
    00118  * remove useless getKey() functions.
    00119  *
    00120  * Revision 1.5  2000/02/24 20:00:22  abagchi
    00121  * Swat for removing Log from API docs
    00122  *
    00123  * Revision 1.4  2000/02/16 23:03:48  roddey
    00124  * More documentation updates
    00125  *
    00126  * Revision 1.3  2000/02/15 01:21:30  roddey
    00127  * Some initial documentation improvements. More to come...
    00128  *
    00129  * Revision 1.2  2000/02/06 07:47:46  rahulj
    00130  * Year 2K copyright swat.
    00131  *
    00132  * Revision 1.1.1.1  1999/11/09 01:08:27  twl
    00133  * Initial checkin
    00134  *
    00135  * Revision 1.2  1999/11/08 20:44:34  rahul
    00136  * Swat for adding in Product name and CVS comment log variable.
    00137  *
    00138  */
    00139
    00140 #if !defined(ATTDEF_HPP)
    00141 #define ATTDEF_HPP
    00142
    00143 #include <xercesc/util/PlatformUtils.hpp>
    00144 #include <xercesc/util/XMLString.hpp>
    00145 #include <xercesc/util/XMemory.hpp>
    00146 #include <xercesc/internal/XSerializable.hpp>
    00147
    00148 XERCES_CPP_NAMESPACE_BEGIN
    00149
    00150 class XMLAttr;
    00151
    00170 class  XMLAttDef : public XSerializable, public XMemory
    00171 {
    00172 public:
    00173     // -----------------------------------------------------------------------
    00174     //  Class specific types
    00175     //
    00176     //  AttTypes
    00177     //      The list of possible types that an attribute can have, according
    00178     //      to the XML 1.0 spec and schema.
    00179     //
    00180     //  DefAttTypes
    00181     //      The modifiers that an attribute decl can have, which indicates
    00182     //      whether instances of that attributes are required, implied, etc..
    00183     //
    00184     //  CreateReasons
    00185     //      This type is used to store how an attribute declaration got into
    00186     //      the elementdecl's attribute pool.
    00187     //
    00188     // -----------------------------------------------------------------------
    00189     enum AttTypes
    00190     {
    00191         CData               = 0
    00192         , ID                = 1
    00193         , IDRef             = 2
    00194         , IDRefs            = 3
    00195         , Entity            = 4
    00196         , Entities          = 5
    00197         , NmToken           = 6
    00198         , NmTokens          = 7
    00199         , Notation          = 8
    00200         , Enumeration       = 9
    00201         , Simple            = 10
    00202         , Any_Any           = 11
    00203         , Any_Other         = 12
    00204         , Any_List          = 13
    00205
    00206         , AttTypes_Count
    00207         , AttTypes_Min      = 0
    00208         , AttTypes_Max      = 13
    00209         , AttTypes_Unknown  = -1
    00210     };
    00211
    00212     enum DefAttTypes
    00213     {
    00214         Default                  = 0
    00215         , Fixed                  = 1
    00216         , Required               = 2
    00217         , Required_And_Fixed     = 3
    00218         , Implied                = 4
    00219         , ProcessContents_Skip   = 5
    00220         , ProcessContents_Lax    = 6
    00221         , ProcessContents_Strict = 7
    00222         , Prohibited             = 8
    00223
    00224         , DefAttTypes_Count
    00225         , DefAttTypes_Min   = 0
    00226         , DefAttTypes_Max   = 8
    00227         , DefAttTypes_Unknown = -1
    00228     };
    00229
    00230     enum CreateReasons
    00231     {
    00232         NoReason
    00233         , JustFaultIn
    00234     };
    00235
    00236     // -----------------------------------------------------------------------
    00237     //  Public static data members
    00238     // -----------------------------------------------------------------------
    00239     static const unsigned int fgInvalidAttrId;
    00240
    00241
    00242     // -----------------------------------------------------------------------
    00243     //  Public, static methods
    00244     // -----------------------------------------------------------------------
    00245
    00248
    00259     static const XMLCh* getAttTypeString(const AttTypes attrType
    00260         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00261
    00272     static const XMLCh* getDefAttTypeString(const DefAttTypes attrType
    00273         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00274
    00276
    00277
    00278     // -----------------------------------------------------------------------
    00279     //  Destructor
    00280     // -----------------------------------------------------------------------
    00281
    00284
    00288     virtual ~XMLAttDef();
    00290
    00291
    00292     // -----------------------------------------------------------------------
    00293     //  The virtual attribute def interface
    00294     // -----------------------------------------------------------------------
    00295
    00298
    00307     virtual const XMLCh* getFullName() const = 0;
    00308
    00313     virtual void reset() = 0;
    00314
    00316
    00317
    00318     // -----------------------------------------------------------------------
    00319     //  Getter methods
    00320     // -----------------------------------------------------------------------
    00321
    00324
    00333     DefAttTypes getDefaultType() const;
    00334
    00344     const XMLCh* getEnumeration() const;
    00345
    00354     unsigned int getId() const;
    00355
    00370     bool getProvided() const;
    00371
    00381     AttTypes getType() const;
    00382
    00392     const XMLCh* getValue() const;
    00393
    00402     CreateReasons getCreateReason() const;
    00403
    00411     bool isExternal() const;
    00412
    00420     MemoryManager* getMemoryManager() const;
    00421
    00422
    00427     virtual const XMLCh* getDOMTypeInfoUri() const = 0;
    00428
    00433     virtual const XMLCh* getDOMTypeInfoName() const = 0;
    00434
    00436
    00437
    00438     // -----------------------------------------------------------------------
    00439     //  Setter methods
    00440     // -----------------------------------------------------------------------
    00441
    00444
    00453     void setDefaultType(const XMLAttDef::DefAttTypes newValue);
    00454
    00463     void setId(const unsigned int newId);
    00464
    00474     void setProvided(const bool newValue);
    00475
    00483     void setType(const XMLAttDef::AttTypes newValue);
    00484
    00495     void setValue(const XMLCh* const newValue);
    00496
    00507     void setEnumeration(const XMLCh* const newValue);
    00508
    00516     void setCreateReason(const CreateReasons newReason);
    00517
    00523     void setExternalAttDeclaration(const bool aValue);
    00524
    00526
    00527     /***
    00528      * Support for Serialization/De-serialization
    00529      ***/
    00530     DECL_XSERIALIZABLE(XMLAttDef)
    00531
    00532 protected :
    00533     // -----------------------------------------------------------------------
    00534     //  Hidden constructors
    00535     // -----------------------------------------------------------------------
    00536     XMLAttDef
    00537     (
    00538         const   AttTypes       type = CData
    00539         , const DefAttTypes    defType= Implied
    00540         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00541     );
    00542     XMLAttDef
    00543     (
    00544         const   XMLCh* const        attValue
    00545         , const AttTypes            type
    00546         , const DefAttTypes         defType
    00547         , const XMLCh* const        enumValues = 0
    00548         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00549     );
    00550
    00551
    00552 private :
    00553     // -----------------------------------------------------------------------
    00554     //  Unimplemented constructors and operators
    00555     // -----------------------------------------------------------------------
    00556     XMLAttDef(const XMLAttDef&);
    00557     XMLAttDef& operator=(const XMLAttDef&);
    00558
    00559
    00560     // -----------------------------------------------------------------------
    00561     //  Private helper methods
    00562     // -----------------------------------------------------------------------
    00563     void cleanUp();
    00564
    00565
    00566     // -----------------------------------------------------------------------
    00567     //  Private data members
    00568     //
    00569     //  fDefaultType
    00570     //      Indicates what, if any, default stuff this attribute has.
    00571     //
    00572     //  fEnumeration
    00573     //      If its an enumeration, this is the list of values as space
    00574     //      separated values.
    00575     //
    00576     //  fId
    00577     //      This is the unique id of this attribute, given to it when its put
    00578     //      into the validator's attribute decl pool. It defaults to the
    00579     //      special value XMLAttrDef::fgInvalidAttrId.
    00580     //
    00581     //  fProvided
    00582     //      This field is really for use by the scanner. It is used to track
    00583     //      which of the attributes of an element were provided. Any marked
    00584     //      as not provided (after scanning the start tag) and having a
    00585     //      default type of Required, is in error.
    00586     //
    00587     //  fType
    00588     //      The type of attribute, which is one of the AttTypes values.
    00589     //
    00590     //  fValue
    00591     //      This is the value of the attribute, which is the default value
    00592     //      given in the attribute declaration.
    00593     //
    00594     //  fCreateReason
    00595     //      This flag tells us how this attribute got created.  Sometimes even
    00596     //      the attribute was not declared for the element, we want to fault
    00597     //      fault it into the pool to avoid lots of redundant errors.
    00598     //
    00599     //  fExternalAttribute
    00600     //      This flag indicates whether or not the attribute was declared externally.
    00601     // -----------------------------------------------------------------------
    00602     DefAttTypes     fDefaultType;
    00603     AttTypes        fType;
    00604     CreateReasons   fCreateReason;
    00605     bool            fProvided;
    00606     bool            fExternalAttribute;
    00607     unsigned int    fId;
    00608     XMLCh*          fValue;
    00609     XMLCh*          fEnumeration;
    00610     MemoryManager*  fMemoryManager;
    00611 };
    00612
    00613
    00614 // ---------------------------------------------------------------------------
    00615 //  Getter methods
    00616 // ---------------------------------------------------------------------------
    00617 inline XMLAttDef::DefAttTypes XMLAttDef::getDefaultType() const
    00618 {
    00619     return fDefaultType;
    00620 }
    00621
    00622 inline const XMLCh* XMLAttDef::getEnumeration() const
    00623 {
    00624     return fEnumeration;
    00625 }
    00626
    00627 inline unsigned int XMLAttDef::getId() const
    00628 {
    00629     return fId;
    00630 }
    00631
    00632 inline bool XMLAttDef::getProvided() const
    00633 {
    00634     return fProvided;
    00635 }
    00636
    00637 inline XMLAttDef::AttTypes XMLAttDef::getType() const
    00638 {
    00639     return fType;
    00640 }
    00641
    00642 inline const XMLCh* XMLAttDef::getValue() const
    00643 {
    00644     return fValue;
    00645 }
    00646
    00647 inline XMLAttDef::CreateReasons XMLAttDef::getCreateReason() const
    00648 {
    00649     return fCreateReason;
    00650 }
    00651
    00652 inline bool XMLAttDef::isExternal() const
    00653 {
    00654     return fExternalAttribute;
    00655 }
    00656
    00657 inline MemoryManager* XMLAttDef::getMemoryManager() const
    00658 {
    00659     return fMemoryManager;
    00660 }
    00661
    00662 // ---------------------------------------------------------------------------
    00663 //  XMLAttDef: Setter methods
    00664 // ---------------------------------------------------------------------------
    00665 inline void XMLAttDef::setDefaultType(const XMLAttDef::DefAttTypes newValue)
    00666 {
    00667     fDefaultType = newValue;
    00668 }
    00669
    00670 inline void XMLAttDef::setEnumeration(const XMLCh* const newValue)
    00671 {
    00672     if (fEnumeration)
    00673         fMemoryManager->deallocate(fEnumeration);
    00674
    00675     fEnumeration = XMLString::replicate(newValue, fMemoryManager);
    00676 }
    00677
    00678 inline void XMLAttDef::setId(const unsigned int newId)
    00679 {
    00680     fId = newId;
    00681 }
    00682
    00683 inline void XMLAttDef::setProvided(const bool newValue)
    00684 {
    00685     fProvided = newValue;
    00686 }
    00687
    00688 inline void XMLAttDef::setType(const XMLAttDef::AttTypes newValue)
    00689 {
    00690     fType = newValue;
    00691 }
    00692
    00693 inline void XMLAttDef::setValue(const XMLCh* const newValue)
    00694 {
    00695     if (fValue)
    00696        fMemoryManager->deallocate(fValue);
    00697
    00698     fValue = XMLString::replicate(newValue, fMemoryManager);
    00699 }
    00700
    00701 inline void
    00702 XMLAttDef::setCreateReason(const XMLAttDef::CreateReasons newReason)
    00703 {
    00704     fCreateReason = newReason;
    00705 }
    00706
    00707 inline void XMLAttDef::setExternalAttDeclaration(const bool aValue)
    00708 {
    00709     fExternalAttribute = aValue;
    00710 }
    00711
    00712 XERCES_CPP_NAMESPACE_END
    00713
    00714 #endif

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