org.openxml.dom.traversal

Class NamedNodeFilter

java.lang.Object

org.openxml.dom.traversal.NamedNodeFilter

All Implemented Interfaces:

org.w3c.dom.traversal.NodeFilter

public final class NamedNodeFilter
extends Object
implements org.w3c.dom.traversal.NodeFilter

Implements a filter for nodes with the specified name, When this filter is used with a node iterator, the iterator will only return nodes with a matching name. This filter was designed to retrieve elements with a specific tag name, by combining it with a whatToShow value of NodeIterator#SHOW_ELEMENT. It can also be used to retrieve processing instructions with a specific target name or entity references, by selecting a different whatToShow value.

A node filter can be shared by multiple iterators. When a filters is reused, it is better to retrieve a copy of the filter from a static list. This mechanism is supported by calling the static method lookup(java.lang.String) and should be used for named filters that are routinely reused.

Author:

Assaf Arkin

See Also:

NodeFilter, NodeIterator

Field Summary

Fields inherited from interface org.w3c.dom.traversal.NodeFilter

FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP, SHOW_ALL, SHOW_ATTRIBUTE, SHOW_CDATA_SECTION, SHOW_COMMENT, SHOW_DOCUMENT, SHOW_DOCUMENT_FRAGMENT, SHOW_DOCUMENT_TYPE, SHOW_ELEMENT, SHOW_ENTITY, SHOW_ENTITY_REFERENCE, SHOW_NOTATION, SHOW_PROCESSING_INSTRUCTION, SHOW_TEXT

Method Summary

Modifier and Type	Method and Description
short	acceptNode(Node node)
static org.w3c.dom.traversal.NodeFilter	lookup(String nodeName) Returns a node filter for the specified node name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

acceptNode

public short acceptNode(Node node)

Specified by:

acceptNode in interface org.w3c.dom.traversal.NodeFilter

lookup

public static org.w3c.dom.traversal.NodeFilter lookup(String nodeName)

Returns a node filter for the specified node name. This method should be used for recurring filter names as only one filter is held for each filtered name.

Parameters:

nodeName - The name to filter by

Returns:

The named node filter