#ifndef DOMNodeFilter_HEADER_GUARD_
#define DOMNodeFilter_HEADER_GUARD_
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache\@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 2001, International
* Business Machines, Inc., http://www.ibm.com . For more information
* on the Apache Software Foundation, please see
* DOMNodeIterator
or DOMTreeWalker
is given a
* DOMNodeFilter
, it applies the filter before it returns the next
* node. If the filter says to accept the node, the traversal logic returns
* it; otherwise, traversal looks for the next node and pretends that the
* node that was rejected was not there.
*
The DOM does not provide any filters. DOMNodeFilter
is just an
* interface that users can implement to provide their own filters.
*
DOMNodeFilters
do not need to know how to traverse from node
* to node, nor do they need to know anything about the data structure that
* is being traversed. This makes it very easy to write filters, since the
* only thing they have to know how to do is evaluate a single node. One
* filter may be used with a number of different kinds of traversals,
* encouraging code reuse.
*
See also the Document Object Model (DOM) Level 2 Traversal and Range Specification. * @since DOM Level 2 */ class CDOM_EXPORT DOMNodeFilter { protected: // ----------------------------------------------------------------------- // Hidden constructors // ----------------------------------------------------------------------- /** @name Hidden constructors */ //@{ DOMNodeFilter() {}; //@} private: // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- /** @name Unimplemented constructors and operators */ //@{ DOMNodeFilter(const DOMNodeFilter &); DOMNodeFilter & operator = (const DOMNodeFilter &); //@} public: // ----------------------------------------------------------------------- // All constructors are hidden, just the destructor is available // ----------------------------------------------------------------------- /** @name Destructor */ //@{ /** * Destructor * */ virtual ~DOMNodeFilter() {}; //@} // ----------------------------------------------------------------------- // Class Types // ----------------------------------------------------------------------- /** @name Public Contants */ //@{ /** * Constants returned by acceptNode. * *
FILTER_ACCEPT:
* Accept the node. Navigation methods defined for
* DOMNodeIterator
or DOMTreeWalker
will return this
* node.
FILTER_REJECT:
* Reject the node. Navigation methods defined for
* DOMNodeIterator
or DOMTreeWalker
will not return
* this node. For DOMTreeWalker
, the children of this node
* will also be rejected. DOMNodeIterators
treat this as a
* synonym for FILTER_SKIP.
FILTER_SKIP:
* Skip this single node. Navigation methods defined for
* DOMNodeIterator
or DOMTreeWalker
will not return
* this node. For both DOMNodeIterator
and
* DOMTreeWalker
, the children of this node will still be
* considered.
SHOW_ALL:
* Show all DOMNode(s)
.
SHOW_ELEMENT:
* Show DOMElement
nodes.
SHOW_ATTRIBUTE:
* Show DOMAttr
nodes. This is meaningful only when creating an
* DOMNodeIterator
or DOMTreeWalker
with an
* attribute node as its root
; in this case, it means that
* the attribute node will appear in the first position of the iteration
* or traversal. Since attributes are never children of other nodes,
* they do not appear when traversing over the document tree.
SHOW_TEXT:
* Show DOMText
nodes.
SHOW_CDATA_SECTION:
* Show DOMCDATASection
nodes.
SHOW_ENTITY_REFERENCE:
* Show DOMEntityReference
nodes.
SHOW_ENTITY:
* Show DOMEntity
nodes. This is meaningful only when creating
* an DOMNodeIterator
or DOMTreeWalker
with an
* DOMEntity
node as its root
; in this case, it
* means that the DOMEntity
node will appear in the first
* position of the traversal. Since entities are not part of the
* document tree, they do not appear when traversing over the document
* tree.
SHOW_PROCESSING_INSTRUCTION:
* Show DOMProcessingInstruction
nodes.
SHOW_COMMENT:
* Show DOMComment
nodes.
SHOW_DOCUMENT:
* Show DOMDocument
nodes.
SHOW_DOCUMENT_TYPE:
* Show DOMDocumentType
nodes.
SHOW_DOCUMENT_FRAGMENT:
* Show DOMDocumentFragment
nodes.
SHOW_NOTATION:
* Show DOMNotation
nodes. This is meaningful only when creating
* an DOMNodeIterator
or DOMTreeWalker
with a
* DOMNotation
node as its root
; in this case, it
* means that the DOMNotation
node will appear in the first
* position of the traversal. Since notations are not part of the
* document tree, they do not appear when traversing over the document
* tree.
DOMTreeWalker
or DOMNodeIterator
. This function
* will be called by the implementation of DOMTreeWalker
and
* DOMNodeIterator
; it is not normally called directly from
* user code. (Though you could do so if you wanted to use the same
* filter to guide your own application logic.)
* @param node The node to check to see if it passes the filter or not.
* @return A constant to determine whether the node is accepted,
* rejected, or skipped, as defined above.
* @since DOM Level 2
*/
virtual short acceptNode (const DOMNode* node) const =0;
//@}
};
XERCES_CPP_NAMESPACE_END
#endif