public Interface DTMFilter

Show all Nodes.

Show Attr nodes. This is meaningful only when creating an iterator or tree-walker 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 main document tree.

Special bit for filters implementing match patterns starting with a function. Make sure this does not conflict with org.w3c.dom.traversal.NodeFilter.

%REVIEW% Might be safer to start from higher bits and work down, to leave room for the DOM to expand its set of constants... Or, possibly, to create a DTM-specific field for these additional bits.

Show CDATASection nodes.

Show Comment nodes.

Show Document nodes. (Of course, as with Attributes and such, this is meaningful only when the iteration root is the Document itself, since Document has no parent.)

Show DocumentFragment nodes. (Of course, as with Attributes and such, this is meaningful only when the iteration root is the Document itself, since DocumentFragment has no parent.)

Show DocumentType nodes.

Show Element nodes.

Show Entity nodes. This is meaningful only when creating an iterator or tree-walker with an Entity node as its root; in this case, it means that the Entity 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 main document tree.

Show EntityReference nodes. Note that if Entity References have been fully expanded while the tree was being constructed, these nodes will not appear and this mask has no effect.

This bit instructs the iterator to show namespace nodes, which are modeled by DTM but not by the DOM. Make sure this does not conflict with org.w3c.dom.traversal.NodeFilter.

%REVIEW% Might be safer to start from higher bits and work down, to leave room for the DOM to expand its set of constants... Or, possibly, to create a DTM-specific field for these additional bits.

Show Notation nodes. This is meaningful only when creating an iterator or tree-walker with a Notation node as its root; in this case, it means that the Notation 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 main document tree.

Show ProcessingInstruction nodes.

Show Text nodes.

Test whether a specified node is visible in the logical view of a DTMIterator. Normally, this function will be called by the implementation of DTMIterator; it is not normally called directly from user code.

Parameters

nodeHandle:int

int Handle of the node.

whatToShow:int

one of SHOW_XXX values.

Returns:short

one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP.

Test whether a specified node is visible in the logical view of a DTMIterator. Normally, this function will be called by the implementation of DTMIterator; it is not normally called directly from user code.

%REVIEW% Under what circumstances will this be used? The cases I've considered are just as easy and just about as efficient if the name test is performed in the DTMIterator... -- Joe

%REVIEW% Should that 0xFFFF have a mnemonic assigned to it? Also: This representation is assuming the expanded name is indeed split into high/low 16-bit halfwords. If we ever change the balance between namespace and localname bits (eg because we decide there are many more localnames than namespaces, which is fairly likely), this is going to break. It might be safer to encapsulate the details with a makeExpandedName method and make that responsible for setting up the wildcard version as well.

Parameters

nodeHandle:int

int Handle of the node.

whatToShow:int

one of SHOW_XXX values.

expandedName:int

a value defining the exanded name as defined in the DTM interface. Wild cards will be defined by 0xFFFF in the namespace and/or localname portion of the expandedName.

Returns:short

one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP.