| 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-2001 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.2  2002/02/20 18:17:01  tng
    00060  * [Bug 5977] Warnings on generating apiDocs.
    00061  *
    00062  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
    00063  * sane_include
    00064  *
    00065  * Revision 1.13  2001/11/15 16:36:36  knoaman
    00066  * Re-organize constant values.
    00067  *
    00068  * Revision 1.12  2001/08/09 15:23:37  knoaman
    00069  * add support for <anyAttribute> declaration.
    00070  *
    00071  * Revision 1.11  2001/06/21 14:25:26  knoaman
    00072  * Fix for bug 1946
    00073  *
    00074  * Revision 1.10  2001/05/11 13:25:31  tng
    00075  * Copyright update.
    00076  *
    00077  * Revision 1.9  2001/02/27 18:48:20  tng
    00078  * Schema: Add SchemaAttDef, SchemaElementDecl, SchemaAttDefList.
    00079  *
    00080  * Revision 1.8  2000/12/14 18:49:56  tng
    00081  * Fix API document generation warning: "Warning: end of member group without matching begin"
    00082  *
    00083  * Revision 1.7  2000/11/30 18:22:38  andyh
    00084  * reuseValidator - fix bugs (spurious errors) that occured on reuse due to
    00085  * pools already containing some items.  Fixed by Tinny Ng.
    00086  *
    00087  * Revision 1.6  2000/07/07 22:23:38  jpolast
    00088  * remove useless getKey() functions.
    00089  *
    00090  * Revision 1.5  2000/02/24 20:00:22  abagchi
    00091  * Swat for removing Log from API docs
    00092  *
    00093  * Revision 1.4  2000/02/16 23:03:48  roddey
    00094  * More documentation updates
    00095  *
    00096  * Revision 1.3  2000/02/15 01:21:30  roddey
    00097  * Some initial documentation improvements. More to come...
    00098  *
    00099  * Revision 1.2  2000/02/06 07:47:46  rahulj
    00100  * Year 2K copyright swat.
    00101  *
    00102  * Revision 1.1.1.1  1999/11/09 01:08:27  twl
    00103  * Initial checkin
    00104  *
    00105  * Revision 1.2  1999/11/08 20:44:34  rahul
    00106  * Swat for adding in Product name and CVS comment log variable.
    00107  *
    00108  */
    00109
    00110 #if !defined(ATTDEF_HPP)
    00111 #define ATTDEF_HPP
    00112
    00113 #include <xercesc/util/XMLString.hpp>
    00114
    00115 class XMLAttr;
    00116
    00135 class  XMLAttDef
    00136 {
    00137 public:
    00138     // -----------------------------------------------------------------------
    00139     //  Class specific types
    00140     //
    00141     //  AttTypes
    00142     //      The list of possible types that an attribute can have, according
    00143     //      to the XML 1.0 spec and schema.
    00144     //
    00145     //  DefAttTypes
    00146     //      The modifiers that an attribute decl can have, which indicates
    00147     //      whether instances of that attributes are required, implied, etc..
    00148     //
    00149     //  CreateReasons
    00150     //      This type is used to store how an attribute declaration got into
    00151     //      the elementdecl's attribute pool.
    00152     //
    00153     // -----------------------------------------------------------------------
    00154     enum AttTypes
    00155     {
    00156         CData               = 0
    00157         , ID                = 1
    00158         , IDRef             = 2
    00159         , IDRefs            = 3
    00160         , Entity            = 4
    00161         , Entities          = 5
    00162         , NmToken           = 6
    00163         , NmTokens          = 7
    00164         , Notation          = 8
    00165         , Enumeration       = 9
    00166         , Simple            = 10
    00167         , Any_Any           = 11
    00168         , Any_Other         = 12
    00169         , Any_List          = 13
    00170
    00171         , AttTypes_Count
    00172         , AttTypes_Min      = 0
    00173         , AttTypes_Max      = 13
    00174         , AttTypes_Unknown  = -1
    00175     };
    00176
    00177     enum DefAttTypes
    00178     {
    00179         Default                  = 0
    00180         , Fixed                  = 1
    00181         , Required               = 2
    00182         , Required_And_Fixed     = 3
    00183         , Implied                = 4
    00184         , ProcessContents_Strict = 5
    00185         , ProcessContents_Lax    = 6
    00186         , ProcessContents_Skip   = 7
    00187         , Prohibited             = 8
    00188
    00189         , DefAttTypes_Count
    00190         , DefAttTypes_Min   = 0
    00191         , DefAttTypes_Max   = 8
    00192         , DefAttTypes_Unknown = -1
    00193     };
    00194
    00195     enum CreateReasons
    00196     {
    00197         NoReason
    00198         , JustFaultIn
    00199     };
    00200
    00201     // -----------------------------------------------------------------------
    00202     //  Public static data members
    00203     // -----------------------------------------------------------------------
    00204     static const unsigned int fgInvalidAttrId;
    00205
    00206
    00207     // -----------------------------------------------------------------------
    00208     //  Public, static methods
    00209     // -----------------------------------------------------------------------
    00210
    00213
    00224     static const XMLCh* getAttTypeString(const AttTypes attrType);
    00225
    00236     static const XMLCh* getDefAttTypeString(const DefAttTypes attrType);
    00237
    00239
    00240
    00241     // -----------------------------------------------------------------------
    00242     //  Destructor
    00243     // -----------------------------------------------------------------------
    00244
    00247
    00251     virtual ~XMLAttDef();
    00253
    00254
    00255     // -----------------------------------------------------------------------
    00256     //  The virtual attribute def interface
    00257     // -----------------------------------------------------------------------
    00258
    00261
    00270     virtual const XMLCh* getFullName() const = 0;
    00271
    00273
    00274
    00275     // -----------------------------------------------------------------------
    00276     //  Getter methods
    00277     // -----------------------------------------------------------------------
    00278
    00281
    00290     DefAttTypes getDefaultType() const;
    00291
    00301     const XMLCh* getEnumeration() const;
    00302
    00311     unsigned int getId() const;
    00312
    00326     bool getProvided() const;
    00327
    00337     AttTypes getType() const;
    00338
    00348     const XMLCh* getValue() const;
    00349
    00358     CreateReasons getCreateReason() const;
    00359
    00367     bool isExternal() const;
    00368
    00370
    00371
    00372     // -----------------------------------------------------------------------
    00373     //  Setter methods
    00374     // -----------------------------------------------------------------------
    00375
    00378
    00387     void setDefaultType(const XMLAttDef::DefAttTypes newValue);
    00388
    00397     void setId(const unsigned int newId);
    00398
    00407     void setProvided(const bool newValue);
    00408
    00416     void setType(const XMLAttDef::AttTypes newValue);
    00417
    00428     void setValue(const XMLCh* const newValue);
    00429
    00440     void setEnumeration(const XMLCh* const newValue);
    00441
    00449     void setCreateReason(const CreateReasons newReason);
    00450
    00456     void setExternalAttDeclaration(const bool aValue);
    00457
    00459
    00460 protected :
    00461     // -----------------------------------------------------------------------
    00462     //  Hidden constructors
    00463     // -----------------------------------------------------------------------
    00464     XMLAttDef
    00465     (
    00466         const   AttTypes            type = CData
    00467         , const DefAttTypes         defType = Implied
    00468     );
    00469     XMLAttDef
    00470     (
    00471         const   XMLCh* const        attValue
    00472         , const AttTypes            type
    00473         , const DefAttTypes         defType
    00474         , const XMLCh* const        enumValues = 0
    00475     );
    00476
    00477
    00478 private :
    00479     // -----------------------------------------------------------------------
    00480     //  Unimplemented constructors and operators
    00481     // -----------------------------------------------------------------------
    00482     XMLAttDef(const XMLAttDef&);
    00483     void operator=(const XMLAttDef&);
    00484
    00485
    00486     // -----------------------------------------------------------------------
    00487     //  Private helper methods
    00488     // -----------------------------------------------------------------------
    00489     void cleanUp();
    00490
    00491
    00492     // -----------------------------------------------------------------------
    00493     //  Private data members
    00494     //
    00495     //  fDefaultType
    00496     //      Indicates what, if any, default stuff this attribute has.
    00497     //
    00498     //  fEnumeration
    00499     //      If its an enumeration, this is the list of values as space
    00500     //      separated values.
    00501     //
    00502     //  fId
    00503     //      This is the unique id of this attribute, given to it when its put
    00504     //      into the validator's attribute decl pool. It defaults to the
    00505     //      special value XMLAttrDef::fgInvalidAttrId.
    00506     //
    00507     //  fProvided
    00508     //      This field is really for use by the scanner. It is used to track
    00509     //      which of the attributes of an element were provided. Any marked
    00510     //      as not provided (after scanning the start tag) and having a
    00511     //      default type of Required, is in error.
    00512     //
    00513     //  fType
    00514     //      The type of attribute, which is one of the AttTypes values.
    00515     //
    00516     //  fValue
    00517     //      This is the value of the attribute, which is the default value
    00518     //      given in the attribute declaration.
    00519     //
    00520     //  fCreateReason
    00521     //      This flag tells us how this attribute got created.  Sometimes even
    00522     //      the attribute was not declared for the element, we want to fault
    00523     //      fault it into the pool to avoid lots of redundant errors.
    00524     //
    00525     //  fExternalAttribute
    00526     //      This flag indicates whether or not the attribute was declared externally.
    00527     // -----------------------------------------------------------------------
    00528     DefAttTypes     fDefaultType;
    00529     XMLCh*          fEnumeration;
    00530     unsigned int    fId;
    00531     bool            fProvided;
    00532     AttTypes        fType;
    00533     XMLCh*          fValue;
    00534     CreateReasons   fCreateReason;
    00535     bool            fExternalAttribute;
    00536 };
    00537
    00538
    00539
    00540 // ---------------------------------------------------------------------------
    00541 //  Getter methods
    00542 // ---------------------------------------------------------------------------
    00543 inline XMLAttDef::DefAttTypes XMLAttDef::getDefaultType() const
    00544 {
    00545     return fDefaultType;
    00546 }
    00547
    00548 inline const XMLCh* XMLAttDef::getEnumeration() const
    00549 {
    00550     return fEnumeration;
    00551 }
    00552
    00553 inline unsigned int XMLAttDef::getId() const
    00554 {
    00555     return fId;
    00556 }
    00557
    00558 inline bool XMLAttDef::getProvided() const
    00559 {
    00560     return fProvided;
    00561 }
    00562
    00563 inline XMLAttDef::AttTypes XMLAttDef::getType() const
    00564 {
    00565     return fType;
    00566 }
    00567
    00568 inline const XMLCh* XMLAttDef::getValue() const
    00569 {
    00570     return fValue;
    00571 }
    00572
    00573 inline XMLAttDef::CreateReasons XMLAttDef::getCreateReason() const
    00574 {
    00575     return fCreateReason;
    00576 }
    00577
    00578 inline bool XMLAttDef::isExternal() const
    00579 {
    00580     return fExternalAttribute;
    00581 }
    00582
    00583
    00584 // ---------------------------------------------------------------------------
    00585 //  XMLAttDef: Setter methods
    00586 // ---------------------------------------------------------------------------
    00587 inline void XMLAttDef::setDefaultType(const XMLAttDef::DefAttTypes newValue)
    00588 {
    00589     fDefaultType = newValue;
    00590 }
    00591
    00592 inline void XMLAttDef::setEnumeration(const XMLCh* const newValue)
    00593 {
    00594     delete [] fEnumeration;
    00595
    00596     if (newValue) {
    00597         fEnumeration = XMLString::replicate(newValue);
    00598     }
    00599     else {
    00600         fEnumeration = 0;
    00601     }
    00602 }
    00603
    00604 inline void XMLAttDef::setId(const unsigned int newId)
    00605 {
    00606     fId = newId;
    00607 }
    00608
    00609 inline void XMLAttDef::setProvided(const bool newValue)
    00610 {
    00611     fProvided = newValue;
    00612 }
    00613
    00614 inline void XMLAttDef::setType(const XMLAttDef::AttTypes newValue)
    00615 {
    00616     fType = newValue;
    00617 }
    00618
    00619 inline void XMLAttDef::setValue(const XMLCh* const newValue)
    00620 {
    00621     delete [] fValue;
    00622     fValue = XMLString::replicate(newValue);
    00623 }
    00624
    00625 inline void
    00626 XMLAttDef::setCreateReason(const XMLAttDef::CreateReasons newReason)
    00627 {
    00628     fCreateReason = newReason;
    00629 }
    00630
    00631 inline void XMLAttDef::setExternalAttDeclaration(const bool aValue)
    00632 {
    00633     fExternalAttribute = aValue;
    00634 }
    00635
    00636 #endif

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