| API Docs for SAX and DOM |

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

# DOMWriter.hpp

Go to the documentation of this file.

    00001 #ifndef DOMWriter_HEADER_GUARD_
    00002 #define DOMWriter_HEADER_GUARD_
    00003
    00004 /*
    00005  * The Apache Software License, Version 1.1
    00006  *
    00007  * Copyright (c) 2002 The Apache Software Foundation.  All rights
    00008  * reserved.
    00009  *
    00010  * Redistribution and use in source and binary forms, with or without
    00011  * modification, are permitted provided that the following conditions
    00012  * are met:
    00013  *
    00014  * 1. Redistributions of source code must retain the above copyright
    00015  *    notice, this list of conditions and the following disclaimer.
    00016  *
    00017  * 2. Redistributions in binary form must reproduce the above copyright
    00018  *    notice, this list of conditions and the following disclaimer in
    00019  *    the documentation and/or other materials provided with the
    00020  *    distribution.
    00021  *
    00022  * 3. The end-user documentation included with the redistribution,
    00023  *    if any, must include the following acknowledgment:
    00024  *       "This product includes software developed by the
    00025  *        Apache Software Foundation (http://www.apache.org/)."
    00026  *    Alternately, this acknowledgment may appear in the software itself,
    00027  *    if and wherever such third-party acknowledgments normally appear.
    00028  *
    00029  * 4. The names "Xerces" and "Apache Software Foundation" must
    00030  *    not be used to endorse or promote products derived from this
    00031  *    software without prior written permission. For written
    00032  *    permission, please contact apache\@apache.org.
    00033  *
    00034  * 5. Products derived from this software may not be called "Apache",
    00035  *    nor may "Apache" appear in their name, without prior written
    00036  *    permission of the Apache Software Foundation.
    00037  *
    00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00049  * SUCH DAMAGE.
    00050  * ====================================================================
    00051  *
    00052  * This software consists of voluntary contributions made by many
    00053  * individuals on behalf of the Apache Software Foundation, and was
    00054  * originally based on software copyright (c) 1999, International
    00055  * Business Machines, Inc., http://www.ibm.com .  For more information
    00056  * on the Apache Software Foundation, please see
    00057  * <http://www.apache.org/>.
    00058  */
    00059
    00060 /*
    00061  * $Id: DOMWriter.hpp,v 1.7 2002/08/22 15:04:57 tng Exp $
    00062  * $Log: DOMWriter.hpp,v $
    00063  * Revision 1.7  2002/08/22 15:04:57  tng
    00064  * Remove unused parameter variables in inline functions.
    00065  *
    00066  * Revision 1.6  2002/06/25 16:04:49  tng
    00067  * DOM L3: add function release().
    00068  *
    00069  * Revision 1.5  2002/06/06 20:53:07  tng
    00070  * Documentation Fix: Update the API Documentation for DOM headers
    00071  *
    00072  * Revision 1.4  2002/06/03 22:33:21  peiyongz
    00073  * DOMWriter: constants moved to XMLUni
    00074  *
    00075  * Revision 1.3  2002/05/31 20:59:40  peiyongz
    00076  * Add "introduced in DOM3"
    00077  *
    00078  * Revision 1.2  2002/05/30 16:25:33  tng
    00079  * Fix doxygen warning message.
    00080  *
    00081  * Revision 1.1  2002/05/28 22:38:55  peiyongz
    00082  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
    00083  *
    00084  */
    00085
    00304
    00305
    00306 #include <xercesc/dom/DOMNode.hpp>
    00307 #include <xercesc/dom/DOMWriterFilter.hpp>
    00308 #include <xercesc/dom/DOMErrorHandler.hpp>
    00309 #include <xercesc/framework/XMLFormatter.hpp>
    00310
    00311 class  DOMWriter {
    00312 protected :
    00313     // -----------------------------------------------------------------------
    00314     //  Hidden constructors
    00315     // -----------------------------------------------------------------------
    00318     DOMWriter() {};
    00319     DOMWriter(const DOMWriter &) {};
    00320     DOMWriter & operator = (const DOMWriter &) {return *this;};
    00322
    00323
    00324 public:
    00325     // -----------------------------------------------------------------------
    00326     //  All constructors are hidden, just the destructor is available
    00327     // -----------------------------------------------------------------------
    00330
    00334     virtual ~DOMWriter() {};
    00336
    00337     // -----------------------------------------------------------------------
    00338     //  Virtual DOMWriter interface
    00339     // -----------------------------------------------------------------------
    00342     // -----------------------------------------------------------------------
    00343     //  Feature methods
    00344     // -----------------------------------------------------------------------
    00360     virtual bool           canSetFeature(const XMLCh* const featName
    00361                                        , bool               state) const = 0;
    00381     virtual void            setFeature(const XMLCh* const featName
    00382                                      , bool               state) = 0;
    00383
    00400     virtual bool               getFeature(const XMLCh* const featName) const = 0;
    00401
    00402     // -----------------------------------------------------------------------
    00403     //  Setter methods
    00404     // -----------------------------------------------------------------------
    00421     virtual void           setEncoding(const XMLCh* const encoding) = 0;
    00422
    00451     virtual void          setNewLine(const XMLCh* const newLine) = 0;
    00452
    00466     virtual void         setErrorHandler(DOMErrorHandler *errorHandler) = 0;
    00467
    00480     virtual void         setFilter(DOMWriterFilter *filter) = 0;
    00481
    00482     // -----------------------------------------------------------------------
    00483     //  Getter methods
    00484     // -----------------------------------------------------------------------
    00494      virtual const XMLCh*       getEncoding() const = 0;
    00495
    00506      virtual const XMLCh*       getNewLine() const = 0;
    00507
    00518      virtual DOMErrorHandler*   getErrorHandler() const = 0;
    00519
    00529      virtual DOMWriterFilter*   getFilter() const = 0;
    00530
    00531     // -----------------------------------------------------------------------
    00532     //  Write methods
    00533     // -----------------------------------------------------------------------
    00557     virtual bool       writeNode(XMLFormatTarget* const destination
    00558                                , const DOMNode         &nodeToWrite) = 0;
    00559
    00577     virtual XMLCh*     writeToString(const DOMNode &nodeToWrite) = 0;
    00578
    00580
    00581     // -----------------------------------------------------------------------
    00582     //  Non-standard Extension
    00583     // -----------------------------------------------------------------------
    00586
    00592     virtual void              release() = 0;
    00594
    00595
    00596 };
    00597
    00598 #endif

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