-
- All Known Subinterfaces:
LSSerializerFilter
public interface NodeFilterFilters are objects that know how to "filter out" nodes. If aNodeIteratororTreeWalkeris given aNodeFilter, 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.
NodeFilteris just an interface that users can implement to provide their own filters.NodeFiltersdo 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:
- 9, DOM Level 2
-
-
Field Summary
Fields Modifier and Type Field Description static shortFILTER_ACCEPTAccept the node.static shortFILTER_REJECTReject the node.static shortFILTER_SKIPSkip this single node.static intSHOW_ALLShow allNodes.static intSHOW_ATTRIBUTEShowAttrnodes.static intSHOW_CDATA_SECTIONShowCDATASectionnodes.static intSHOW_COMMENTShowCommentnodes.static intSHOW_DOCUMENTShowDocumentnodes.static intSHOW_DOCUMENT_FRAGMENTShowDocumentFragmentnodes.static intSHOW_DOCUMENT_TYPEShowDocumentTypenodes.static intSHOW_ELEMENTShowElementnodes.static intSHOW_ENTITYShowEntitynodes.static intSHOW_ENTITY_REFERENCEShowEntityReferencenodes.static intSHOW_NOTATIONShowNotationnodes.static intSHOW_PROCESSING_INSTRUCTIONShowProcessingInstructionnodes.static intSHOW_TEXTShowTextnodes.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description shortacceptNode(Node n)Test whether a specified node is visible in the logical view of aTreeWalkerorNodeIterator.
-
-
-
Field Detail
-
FILTER_ACCEPT
static final short FILTER_ACCEPT
Accept the node. Navigation methods defined forNodeIteratororTreeWalkerwill return this node.- See Also:
- Constant Field Values
-
FILTER_REJECT
static final short FILTER_REJECT
Reject the node. Navigation methods defined forNodeIteratororTreeWalkerwill not return this node. ForTreeWalker, the children of this node will also be rejected.NodeIteratorstreat this as a synonym forFILTER_SKIP.- See Also:
- Constant Field Values
-
FILTER_SKIP
static final short FILTER_SKIP
Skip this single node. Navigation methods defined forNodeIteratororTreeWalkerwill not return this node. For bothNodeIteratorandTreeWalker, the children of this node will still be considered.- See Also:
- Constant Field Values
-
SHOW_ALL
static final int SHOW_ALL
Show allNodes.- See Also:
- Constant Field Values
-
SHOW_ELEMENT
static final int SHOW_ELEMENT
ShowElementnodes.- See Also:
- Constant Field Values
-
SHOW_ATTRIBUTE
static final int SHOW_ATTRIBUTE
ShowAttrnodes. This is meaningful only when creating anNodeIteratororTreeWalkerwith an attribute node as itsroot; 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.- See Also:
- Constant Field Values
-
SHOW_TEXT
static final int SHOW_TEXT
ShowTextnodes.- See Also:
- Constant Field Values
-
SHOW_CDATA_SECTION
static final int SHOW_CDATA_SECTION
ShowCDATASectionnodes.- See Also:
- Constant Field Values
-
SHOW_ENTITY_REFERENCE
static final int SHOW_ENTITY_REFERENCE
ShowEntityReferencenodes.- See Also:
- Constant Field Values
-
SHOW_ENTITY
static final int SHOW_ENTITY
ShowEntitynodes. This is meaningful only when creating anNodeIteratororTreeWalkerwith anEntitynode as itsroot; in this case, it means that theEntitynode 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.- See Also:
- Constant Field Values
-
SHOW_PROCESSING_INSTRUCTION
static final int SHOW_PROCESSING_INSTRUCTION
ShowProcessingInstructionnodes.- See Also:
- Constant Field Values
-
SHOW_COMMENT
static final int SHOW_COMMENT
ShowCommentnodes.- See Also:
- Constant Field Values
-
SHOW_DOCUMENT
static final int SHOW_DOCUMENT
ShowDocumentnodes.- See Also:
- Constant Field Values
-
SHOW_DOCUMENT_TYPE
static final int SHOW_DOCUMENT_TYPE
ShowDocumentTypenodes.- See Also:
- Constant Field Values
-
SHOW_DOCUMENT_FRAGMENT
static final int SHOW_DOCUMENT_FRAGMENT
ShowDocumentFragmentnodes.- See Also:
- Constant Field Values
-
SHOW_NOTATION
static final int SHOW_NOTATION
ShowNotationnodes. This is meaningful only when creating anNodeIteratororTreeWalkerwith aNotationnode as itsroot; in this case, it means that theNotationnode 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.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptNode
short acceptNode(Node n)
Test whether a specified node is visible in the logical view of aTreeWalkerorNodeIterator. This function will be called by the implementation ofTreeWalkerandNodeIterator; 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.)- Parameters:
n- The node to check to see if it passes the filter or not.- Returns:
- A constant to determine whether the node is accepted, rejected, or skipped, as defined above.
-
-