org.openxml.dom.traversal

Class ElementFilter

java.lang.Object

org.openxml.dom.traversal.ElementFilter

All Implemented Interfaces:

org.w3c.dom.traversal.NodeFilter

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

Implements a filter for elements with the specified tag name, When this filter is used with a node iterator, the iterator will only return elements with a matching tag name, or all if the pattern "*" is used.

If a namespace URI is provided, the namespace and local name are compared. If the namespace URI is "*", all namespaces are matched and only the local name is compared. If the namespace is not provided, standard lookup occurs.

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, java.lang.String, boolean) and should be used for named filters that are routinely reused.

Author:

Assaf Arkin

See Also:

NodeFilter, NodeIterator

Field Summary

Fields

Modifier and Type	Field and Description
static String	MATCH_ALL This pattern can be used for the local name to indicate that all elements should be returned or in the namespace URI to indicate that all namespace URIs must be matched.

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 namespaceURI, String localName, boolean ignoreCase) Returns an element filter for the specified tag name.

Methods inherited from class java.lang.Object

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

Field Detail

MATCH_ALL

public static final String MATCH_ALL

This pattern can be used for the local name to indicate that all elements should be returned or in the namespace URI to indicate that all namespace URIs must be matched.

See Also:

Constant Field Values

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 namespaceURI,
                                                      String localName,
                                                      boolean ignoreCase)

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

Parameters:

ignoreCase - True if case should be ignored (for HTML)

Returns:

The element tag name