DOMWriterFilter.hpp Source File

00001 #ifndef DOMWriterFilter_HEADER_GUARD_
00002 #define DOMWriterFilter_HEADER_GUARD_
00003 
00004 /*
00005  * Copyright 2002,2004 The Apache Software Foundation.
00006  * 
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  * 
00011  *      http://www.apache.org/licenses/LICENSE-2.0
00012  * 
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  */
00019 
00020 /*
00021  * $Id: DOMWriterFilter.hpp,v 1.10 2004/09/08 13:55:39 peiyongz Exp $
00022  * $Log: DOMWriterFilter.hpp,v $
00023  * Revision 1.10  2004/09/08 13:55:39  peiyongz
00024  * Apache License Version 2.0
00025  *
00026  * Revision 1.9  2003/03/07 19:59:09  tng
00027  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
00028  *
00029  * Revision 1.8  2002/11/04 15:09:25  tng
00030  * C++ Namespace Support.
00031  *
00032  * Revision 1.7  2002/08/22 15:04:57  tng
00033  * Remove unused parameter variables in inline functions.
00034  *
00035  * Revision 1.6  2002/06/06 20:53:07  tng
00036  * Documentation Fix: Update the API Documentation for DOM headers
00037  *
00038  * Revision 1.5  2002/06/04 14:24:04  peiyongz
00039  * Make DOMWriterFilter pure abstract class w/o implementing any method
00040  * and data
00041  *
00042  * Revision 1.4  2002/06/03 22:34:53  peiyongz
00043  * DOMWriterFilter: setter provided, and allows any SHOW setting
00044  *
00045  * Revision 1.3  2002/05/31 20:59:40  peiyongz
00046  * Add "introduced in DOM3"
00047  *
00048  * Revision 1.2  2002/05/30 16:25:33  tng
00049  * Fix doxygen warning message.
00050  *
00051  * Revision 1.1  2002/05/28 22:38:55  peiyongz
00052  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
00053  *
00054  */
00055 
00073 #include <xercesc/dom/DOMNodeFilter.hpp>
00074 
00075 XERCES_CPP_NAMESPACE_BEGIN
00076 
00077 
00078 class  DOMWriterFilter : public DOMNodeFilter {
00079 protected:
00080     // -----------------------------------------------------------------------
00081     //  Hidden constructors
00082     // -----------------------------------------------------------------------
00085     DOMWriterFilter() {};
00087 
00088 private:
00089     // -----------------------------------------------------------------------
00090     // Unimplemented constructors and operators
00091     // -----------------------------------------------------------------------
00094     DOMWriterFilter(const DOMWriterFilter &);
00095     DOMWriterFilter & operator = (const DOMWriterFilter &);
00097 
00098 
00099 public:
00100     // -----------------------------------------------------------------------
00101     //  All constructors are hidden, just the destructor is available
00102     // -----------------------------------------------------------------------
00109     virtual ~DOMWriterFilter() {};
00111 
00112     // -----------------------------------------------------------------------
00113     //  Virtual DOMWriterFilter interface
00114     // -----------------------------------------------------------------------
00121     virtual short acceptNode(const DOMNode* node) const = 0;
00122 
00135     virtual unsigned long getWhatToShow() const =0;
00136 
00147     virtual void          setWhatToShow(unsigned long toShow) =0;
00149 
00150 private:
00151 
00152     // -----------------------------------------------------------------------
00153     //  Private data members
00154     //
00155     //  fWhatToShow
00156     //
00157     //      The whatToShow mask.
00158     //      Tells the DOMWriter what types of nodes to show to the filter.
00159     //      See NodeFilter for definition of the constants.
00160     //      The constants
00161     //      SHOW_ATTRIBUTE,
00162     //      SHOW_DOCUMENT,
00163     //      SHOW_DOCUMENT_TYPE,
00164     //      SHOW_NOTATION, and
00165     //      SHOW_DOCUMENT_FRAGMENT are meaningless here,
00166     //      Entity nodes are not passed to the filter.
00167     //
00168     //      Those nodes will never be passed to a DOMWriterFilter.
00169     //
00170     //   Derived class shall add this data member:
00171     //
00172     //   unsigned long fWhatToShow;
00173     // -----------------------------------------------------------------------
00174 
00175 };
00176 
00177 XERCES_CPP_NAMESPACE_END
00178 
00179 #endif