API Docs for SAX and DOM                 XMLAttr.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: XMLAttr.hpp,v $ * Revision 1.4 2002/11/28 20:12:45 knoaman * Allow creating/setting of XMLAttr using a rawname (i.e. 'prefix:localpart'). * * Revision 1.3 2002/11/04 15:00:21 tng * C++ Namespace Support. * * Revision 1.2 2002/02/20 18:17:01 tng * [Bug 5977] Warnings on generating apiDocs. * * Revision 1.1.1.1 2002/02/01 22:21:50 peiyongz * sane_include * * Revision 1.9 2001/11/02 14:21:18 knoaman * Add support for identity constraints. * * Revision 1.8 2001/05/11 13:25:31 tng * Copyright update. * * Revision 1.7 2001/02/27 18:33:55 tng * Schema: Use QName in XMLAttr. * * Revision 1.6 2000/04/10 22:42:53 roddey * Extended the buffer reuse to the QName field, to further increase * performance of attribute heavy applications. * * Revision 1.5 2000/03/02 19:54:24 roddey * This checkin includes many changes done while waiting for the * 1.1.0 code to be finished. I can't list them all here, but a list is * available elsewhere. * * Revision 1.4 2000/02/24 20:00:22 abagchi * Swat for removing Log from API docs * * 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:47 rahulj * Year 2K copyright swat. * * Revision 1.1.1.1 1999/11/09 01:08:28 twl * Initial checkin * * Revision 1.2 1999/11/08 20:44:35 rahul * Swat for adding in Product name and CVS comment log variable. * */ #if !defined(XMLATTR_HPP) #define XMLATTR_HPP #include <xercesc/util/XMLString.hpp> #include <xercesc/util/QName.hpp> #include <xercesc/framework/XMLAttDef.hpp> XERCES_CPP_NAMESPACE_BEGIN class XMLAttr { public: // ----------------------------------------------------------------------- // Constructors and Destructor // ----------------------------------------------------------------------- XMLAttr(); XMLAttr ( const unsigned int uriId , const XMLCh* const attrName , const XMLCh* const attrPrefix , const XMLCh* const attrValue , const XMLAttDef::AttTypes type = XMLAttDef::CData , const bool specified = true ); XMLAttr ( const unsigned int uriId , const XMLCh* const rawName , const XMLCh* const attrValue , const XMLAttDef::AttTypes type = XMLAttDef::CData , const bool specified = true ); ~XMLAttr(); // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- QName* getAttName() const; const XMLCh* getName() const; const XMLCh* getPrefix() const; const XMLCh* getQName() const; bool getSpecified() const; XMLAttDef::AttTypes getType() const; const XMLCh* getValue() const; unsigned int getURIId() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void set ( const unsigned int uriId , const XMLCh* const attrName , const XMLCh* const attrPrefix , const XMLCh* const attrValue , const XMLAttDef::AttTypes type = XMLAttDef::CData ); void set ( const unsigned int uriId , const XMLCh* const attrRawName , const XMLCh* const attrValue , const XMLAttDef::AttTypes type = XMLAttDef::CData ); void setName ( const unsigned int uriId , const XMLCh* const attrName , const XMLCh* const attrPrefix ); void setSpecified(const bool newValue); void setType(const XMLAttDef::AttTypes newType); void setValue(const XMLCh* const newValue); void setURIId(const unsigned int uriId); private : // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- XMLAttr(const XMLAttr&); XMLAttr& operator=(const XMLAttr&); // ----------------------------------------------------------------------- // Private, helper methods // ----------------------------------------------------------------------- void cleanUp(); // ----------------------------------------------------------------------- // Private instance variables // // fAttName // The Attribute Name; // // fSpecified // True if this attribute appeared in the element; else, false if // it was defaulted from an AttDef. // // fType // The attribute type enum value for this attribute. Indicates what // type of attribute it was. // // fValue // fValueBufSz // The attribute value that was given in the attribute instance, and // its current buffer size (minus one, where the null is.) // // ----------------------------------------------------------------------- bool fSpecified; XMLAttDef::AttTypes fType; XMLCh* fValue; unsigned int fValueBufSz; QName* fAttName; }; // --------------------------------------------------------------------------- // XMLAttr: Constructors and Destructor // --------------------------------------------------------------------------- inline XMLAttr::~XMLAttr() { cleanUp(); } // --------------------------------------------------------------------------- // XMLAttr: Getter methods // --------------------------------------------------------------------------- inline QName* XMLAttr::getAttName() const { return fAttName; } inline const XMLCh* XMLAttr::getName() const { return fAttName->getLocalPart(); } inline const XMLCh* XMLAttr::getPrefix() const { return fAttName->getPrefix(); } inline bool XMLAttr::getSpecified() const { return fSpecified; } inline XMLAttDef::AttTypes XMLAttr::getType() const { return fType; } inline const XMLCh* XMLAttr::getValue() const { return fValue; } inline unsigned int XMLAttr::getURIId() const { return fAttName->getURI(); } // --------------------------------------------------------------------------- // XMLAttr: Setter methods // --------------------------------------------------------------------------- inline void XMLAttr::set(const unsigned int uriId , const XMLCh* const attrName , const XMLCh* const attrPrefix , const XMLCh* const attrValue , const XMLAttDef::AttTypes type) { // Set the name info and the value via their respective calls fAttName->setName(attrPrefix, attrName, uriId); setValue(attrValue); // And store the type fType = type; } inline void XMLAttr::set(const unsigned int uriId , const XMLCh* const attrRawName , const XMLCh* const attrValue , const XMLAttDef::AttTypes type) { // Set the name info and the value via their respective calls fAttName->setName(attrRawName, uriId); setValue(attrValue); // And store the type fType = type; } inline void XMLAttr::setType(const XMLAttDef::AttTypes newValue) { fType = newValue; } inline void XMLAttr::setSpecified(const bool newValue) { fSpecified = newValue; } XERCES_CPP_NAMESPACE_END #endif

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