com.screenscraper.webbrowser

Class DOMHelper

java.lang.Object

com.screenscraper.webbrowser.DOMHelper

public class DOMHelper
extends java.lang.Object

A helper class to print DOM nodes and to find DOM nodes

Constructor Summary

Constructors

Constructor and Description
DOMHelper()
DOMHelper(java.io.Writer out)

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Node	findNodeByAttributes(org.w3c.dom.Node root, java.util.Map<java.lang.String,java.lang.String> attributes) Finds the node that matches the given attributes starting at the given node
static org.w3c.dom.Element	findNodeByID(org.w3c.dom.Document doc, java.lang.String id) Finds the node with the given ID in the given DOM tree
void	followNode(org.w3c.dom.Node node, int tabSize) Prints the given DOM tree to the provided out stream.
static java.util.Map<java.lang.String,java.lang.String>	getAttributeMap(org.w3c.dom.Node node, java.lang.String[] atts) Returns a map of the attributes from the node that match the attributes in the given list.
java.lang.String	getNodeAsString(org.w3c.dom.Node node, int tabSize) Returns the given node as a formatted string
static void	printNode(org.w3c.dom.Node node) Prints the given DOM tree to standard out
void	printNode(org.w3c.dom.Node node, int tabSize) Prints a single node to the provided stream

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMHelper

public DOMHelper(java.io.Writer out)

DOMHelper

public DOMHelper()

Method Detail

findNodeByID

public static org.w3c.dom.Element findNodeByID(org.w3c.dom.Document doc,
                                               java.lang.String id)

Finds the node with the given ID in the given DOM tree

Parameters:

doc - the root of the DOM tree to search

id - the desired node's id

Returns:

the Node or null

findNodeByAttributes

public static org.w3c.dom.Node findNodeByAttributes(org.w3c.dom.Node root,
                                                    java.util.Map<java.lang.String,java.lang.String> attributes)

Finds the node that matches the given attributes starting at the given node

Parameters:

root - The DOM tree to search in

attributes - the attributes of the desired node

Returns:

The desired node or null

getAttributeMap

public static java.util.Map<java.lang.String,java.lang.String> getAttributeMap(org.w3c.dom.Node node,
                                                                               java.lang.String[] atts)

Returns a map of the attributes from the node that match the attributes in the given list. Attributes with the default values will be filtered out. Default values are in JSConstants.

Parameters:

node - the node to get the attributes from

atts - the desired attributes to match

Returns:

a map of the matched attributes

printNode

public static void printNode(org.w3c.dom.Node node)

Prints the given DOM tree to standard out

Parameters:

node - The root of the tree to print

printNode

public void printNode(org.w3c.dom.Node node,
                      int tabSize)

Prints a single node to the provided stream

Parameters:

node - the node to print

tabSize - the desired tab size

followNode

public void followNode(org.w3c.dom.Node node,
                       int tabSize)

Prints the given DOM tree to the provided out stream.

Parameters:

node - the root of the tree to print

tabSize - The starting tab size for the nodes

getNodeAsString

public java.lang.String getNodeAsString(org.w3c.dom.Node node,
                                        int tabSize)

Returns the given node as a formatted string

Parameters:

node - the node

tabSize - the desired tab size

Returns:

the node as a formatted string