http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

XSAnnotation.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 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: XSAnnotation.hpp,v $
00059  * Revision 1.8  2003/12/01 23:23:26  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.7  2003/11/28 14:55:11  neilg
00063  * fix for compilation error on HPUX
00064  *
00065  * Revision 1.6  2003/11/27 21:29:05  neilg
00066  * implement writeAnnotation; thanks to Dave Cargill
00067  *
00068  * Revision 1.5  2003/11/14 22:47:53  neilg
00069  * fix bogus log message from previous commit...
00070  *
00071  * Revision 1.4  2003/11/14 22:33:30  neilg
00072  * Second phase of schema component model implementation.  
00073  * Implement XSModel, XSNamespaceItem, and the plumbing necessary
00074  * to connect them to the other components.
00075  * Thanks to David Cargill.
00076  *
00077  * Revision 1.3  2003/11/11 22:48:13  knoaman
00078  * Serialization of XSAnnotation.
00079  *
00080  * Revision 1.2  2003/11/06 19:28:11  knoaman
00081  * PSVI support for annotations.
00082  *
00083  * Revision 1.1  2003/09/16 14:33:36  neilg
00084  * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
00085  *
00086  */
00087 
00088 #if !defined(XSANNOTATION_HPP)
00089 #define XSANNOTATION_HPP
00090 
00091 #include <xercesc/framework/psvi/XSObject.hpp>
00092 #include <xercesc/internal/XSerializable.hpp>
00093 
00094 XERCES_CPP_NAMESPACE_BEGIN
00095 
00103 // forward declarations
00104 class DOMNode;
00105 class ContentHandler;
00106 
00107 class  XSAnnotation : public XSerializable, public XSObject
00108 {
00109 public:
00110 
00111     // TargetType
00112     enum ANNOTATION_TARGET {
00116         W3C_DOM_ELEMENT           = 1,
00120         W3C_DOM_DOCUMENT          = 2
00121     };
00122 
00123     //  Constructors and Destructor
00124     // -----------------------------------------------------------------------
00127 
00134     XSAnnotation
00135     (
00136         const XMLCh* const contents
00137         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00138     );
00139 
00141 
00144     ~XSAnnotation();
00146 
00147     //---------------------
00151 
00162     void writeAnnotation(DOMNode* node, ANNOTATION_TARGET targetType);  
00163 
00171     void writeAnnotation(ContentHandler* handler);
00172 
00176     const XMLCh *getAnnotationString() const;
00177     XMLCh *getAnnotationString();
00178 
00180 
00181     //----------------------------------
00184     void            setNext(XSAnnotation* const nextAnnotation);
00185     XSAnnotation*   getNext();
00187 
00188     /***
00189      * Support for Serialization/De-serialization
00190      ***/
00191     DECL_XSERIALIZABLE(XSAnnotation)
00192     XSAnnotation(MemoryManager* const manager);
00193 
00194 private:
00195 
00196     // -----------------------------------------------------------------------
00197     //  Unimplemented constructors and operators
00198     // -----------------------------------------------------------------------
00199     XSAnnotation(const XSAnnotation&);
00200     XSAnnotation & operator=(const XSAnnotation &);
00201 
00202 protected:
00203 
00204     // -----------------------------------------------------------------------
00205     //  data members
00206     // -----------------------------------------------------------------------
00207     XMLCh*        fContents;
00208     XSAnnotation* fNext;
00209 };
00210 
00211 inline const XMLCh *XSAnnotation::getAnnotationString() const
00212 {
00213     return fContents;
00214 }
00215 
00216 inline XMLCh *XSAnnotation::getAnnotationString()
00217 {
00218     return fContents;
00219 }
00220 
00221 XERCES_CPP_NAMESPACE_END
00222 
00223 #endif


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