| API Docs for SAX and DOM |

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

# DOMWriterFilter.hpp

Go to the documentation of this file.

    00001 #ifndef DOMWriterFilter_HEADER_GUARD_
    00002 #define DOMWriterFilter_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) 2001, 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: DOMWriterFilter.hpp,v 1.7 2002/08/22 15:04:57 tng Exp $
    00062  * $Log: DOMWriterFilter.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/06 20:53:07  tng
    00067  * Documentation Fix: Update the API Documentation for DOM headers
    00068  *
    00069  * Revision 1.5  2002/06/04 14:24:04  peiyongz
    00070  * Make DOMWriterFilter pure abstract class w/o implementing any method
    00071  * and data
    00072  *
    00073  * Revision 1.4  2002/06/03 22:34:53  peiyongz
    00074  * DOMWriterFilter: setter provided, and allows any SHOW setting
    00075  *
    00076  * Revision 1.3  2002/05/31 20:59:40  peiyongz
    00077  * Add "introduced in DOM3"
    00078  *
    00079  * Revision 1.2  2002/05/30 16:25:33  tng
    00080  * Fix doxygen warning message.
    00081  *
    00082  * Revision 1.1  2002/05/28 22:38:55  peiyongz
    00083  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
    00084  *
    00085  */
    00086
    00102
    00103
    00104 #include <xercesc/dom/DOMNodeFilter.hpp>
    00105
    00106 class  DOMWriterFilter : public DOMNodeFilter {
    00107 protected :
    00108     // -----------------------------------------------------------------------
    00109     //  Hidden constructors
    00110     // -----------------------------------------------------------------------
    00113     DOMWriterFilter() {};
    00114     DOMWriterFilter(const DOMWriterFilter &) {};
    00115     DOMWriterFilter & operator = (const DOMWriterFilter &) {return *this;};
    00117
    00118
    00119 public:
    00120     // -----------------------------------------------------------------------
    00121     //  All constructors are hidden, just the destructor is available
    00122     // -----------------------------------------------------------------------
    00125
    00129     virtual ~DOMWriterFilter() {};
    00131
    00132     // -----------------------------------------------------------------------
    00133     //  Virtual DOMWriterFilter interface
    00134     // -----------------------------------------------------------------------
    00137
    00141     virtual short acceptNode(const DOMNode* node) const = 0;
    00142
    00155     virtual unsigned long getWhatToShow() const =0;
    00156
    00167     virtual void          setWhatToShow(unsigned long toShow) =0;
    00169
    00170 private:
    00171
    00172     // -----------------------------------------------------------------------
    00173     //  Private data members
    00174     //
    00175     //  fWhatToShow
    00176     //
    00177     //      The whatToShow mask.
    00178     //      Tells the DOMWriter what types of nodes to show to the filter.
    00179     //      See NodeFilter for definition of the constants.
    00180     //      The constants
    00181     //      SHOW_ATTRIBUTE,
    00182     //      SHOW_DOCUMENT,
    00183     //      SHOW_DOCUMENT_TYPE,
    00184     //      SHOW_NOTATION, and
    00185     //      SHOW_DOCUMENT_FRAGMENT are meaningless here,
    00186     //      Entity nodes are not passed to the filter.
    00187     //
    00188     //      Those nodes will never be passed to a DOMWriterFilter.
    00189     //
    00190     //   Derived class shall add this data member:
    00191     //
    00192     //   unsigned long fWhatToShow;
    00193     // -----------------------------------------------------------------------
    00194
    00195 };
    00196
    00197 #endif

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