uk.ac.ox.cs.diadem.webapi.dom

Interface DOMVisitor

public interface DOMVisitor

Interface for a DOM tree visitor. The actual visit follows the algorithm:

  
 init();
 walkRecursively(documentElement);
 finish();
 
 

where:

 
 void walkRecursively(DOMNode node){
  startElement(node);
  visitNode(node); //per type node
 for (final DOMNode child : node.getChildNodes())} 
   walkRecursively(child);
   
  endElement(node);
 }
 

Author:

Giovanni Grasso (giovannigrasso@gmail.com) Oxford University, Department of Computer Science

Method Summary

Modifier and Type	Method and Description
void	endElement(DOMNode node) Called after visiting allElements node's descendant
boolean	filterOut(DOMNode node) Returns true is the current node must be skipped during the visit, false otherwise
void	finish() Called at the very end of the visit
void	init() Initialize the visitor.
void	startElement(DOMNode node) Called before visiting the node's children and descendants.
void	visitComment(DOMNode node) Called in case of the current DOMNode is of type DOMNode.Type.COMMENT
void	visitProcessingInstruction(DOMNode node) Called in case of the current DOMNode is of type DOMNode.Type.PROCESSING_INSTRUCTION
void	visitText(DOMNode node) Called in case of the current DOMNode is of type DOMNode.Type.TEXT

Method Detail

init

void init()

Initialize the visitor. This is the first method called before starting walking the DOM tree. It is called only once.

startElement

void startElement(DOMNode node)

Called before visiting the node's children and descendants.

Parameters:

node - the node under visit

endElement

void endElement(DOMNode node)

Called after visiting allElements node's descendant

Parameters:

node - the node under visit

finish

void finish()

Called at the very end of the visit

visitComment

void visitComment(DOMNode node)

Called in case of the current DOMNode is of type DOMNode.Type.COMMENT

Parameters:

node - the node under visit

visitText

void visitText(DOMNode node)

Called in case of the current DOMNode is of type DOMNode.Type.TEXT

Parameters:

node - the node under visit

visitProcessingInstruction

void visitProcessingInstruction(DOMNode node)

Called in case of the current DOMNode is of type DOMNode.Type.PROCESSING_INSTRUCTION

Parameters:

node - the node under visit

filterOut

boolean filterOut(DOMNode node)

Returns true is the current node must be skipped during the visit, false otherwise

Parameters:

node - the node under visit

Returns:

true is the current node must be skipped during the visit, false otherwise