DOMTreeWalker.hpp Source File

00001 #ifndef DOMTreeWalker_HEADER_GUARD_
00002 #define DOMTreeWalker_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001-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: DOMTreeWalker.hpp,v 1.7 2003/03/07 19:59:09 tng Exp $
00062  */
00063 
00064 #include "DOMNode.hpp"
00065 #include "DOMNodeFilter.hpp"
00066 
00067 XERCES_CPP_NAMESPACE_BEGIN
00068 
00069 
00089 class  DOMTreeWalker {
00090 protected:
00091     // -----------------------------------------------------------------------
00092     //  Hidden constructors
00093     // -----------------------------------------------------------------------
00096     DOMTreeWalker() {};
00098 
00099 private:
00100     // -----------------------------------------------------------------------
00101     // Unimplemented constructors and operators
00102     // -----------------------------------------------------------------------
00105     DOMTreeWalker(const DOMTreeWalker &);
00106     DOMTreeWalker & operator = (const DOMTreeWalker &);
00108 
00109 public:
00110     // -----------------------------------------------------------------------
00111     //  All constructors are hidden, just the destructor is available
00112     // -----------------------------------------------------------------------
00119     virtual ~DOMTreeWalker() {};
00121 
00122     // -----------------------------------------------------------------------
00123     //  Virtual DOMTreeWalker interface
00124     // -----------------------------------------------------------------------
00127     // -----------------------------------------------------------------------
00128     //  Getter methods
00129     // -----------------------------------------------------------------------
00130 
00137     virtual DOMNode*          getRoot() = 0;
00148     virtual unsigned long       getWhatToShow()= 0;
00149 
00155     virtual DOMNodeFilter*     getFilter()= 0;
00156 
00174     virtual bool              getExpandEntityReferences()= 0;
00175 
00181     virtual DOMNode*          getCurrentNode()= 0;
00182 
00183     // -----------------------------------------------------------------------
00184     //  Query methods
00185     // -----------------------------------------------------------------------
00197     virtual DOMNode*          parentNode()= 0;
00198 
00209     virtual DOMNode*          firstChild()= 0;
00210 
00221     virtual DOMNode*          lastChild()= 0;
00222 
00233     virtual DOMNode*          previousSibling()= 0;
00234 
00244     virtual DOMNode*          nextSibling()= 0;
00245 
00258     virtual DOMNode*          previousNode()= 0;
00259 
00271     virtual DOMNode*          nextNode()= 0;
00272 
00273     // -----------------------------------------------------------------------
00274     //  Setter methods
00275     // -----------------------------------------------------------------------
00293     virtual void              setCurrentNode(DOMNode* currentNode)= 0;
00295 
00296     // -----------------------------------------------------------------------
00297     //  Non-standard Extension
00298     // -----------------------------------------------------------------------
00307     virtual void              release() = 0;
00309 };
00310 
00311 XERCES_CPP_NAMESPACE_END
00312 
00313 #endif