com.bmc.arsys.plugins.ftsconfig.helper.shared

Class XPATHHelper

java.lang.Object

com.bmc.arsys.plugins.ftsconfig.helper.shared.XPATHHelper

public final class XPATHHelper
extends Object

A stateless helper class for extracting slices/nodes/attributes using XPATH

Method Summary

Methods

Modifier and Type	Method and Description
static List<Attr>	attrFilter(Collection<Node> nodes) Extract only the Nodes which are implementations of Attr from the given collection.
static List<Attr>	attrFilter(Collection<Node> nodes, String attributeName) Extract only the Nodes which are implementations of Attr from the given collection and that has a given name.
static List<Comment>	commentFilter(Collection<Node> nodes) Extract only the Nodes which are implementations of Comment from the given collection.
static List<Element>	elementFilter(Collection<Node> nodes) Extract only the Nodes which are implementations of Element from the given collection.
static Node	getNode(Node rootNode, String xpathString) Gets a node matching the given XPath applied to the DOM.
static List<Node>	getNodes(Node rootNode, String xpathString) Get a collection of nodes matching the given XPath applied to the DOM.
static String	getStringValue(Node rootNode, String xpathString) Get the string value of the node matching the given XPath applied to the DOM node.
static String	getStringValue(Node rootNode, String xpathString, String defaultValue) Get the string value of the node matching the given XPath applied to the DOM node.
static List<String>	getStringValues(Node rootNode, String xpathString) Get the collection of string values of the matching the given XPath applied to the DOM rootNode.
static List<ProcessingInstruction>	processingInstructionFilter(Collection<Node> nodes) Extract only the Nodes which are implementations of ProcessingInstruction from the given collection.
static List<Text>	textFilter(Collection<Node> nodes) Extract only the Nodes which are implementations of Text from the given collection.

Methods inherited from class java.lang.Object

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

Method Detail

getNodes

public static List<Node> getNodes(Node rootNode,
                  String xpathString)

Get a collection of nodes matching the given XPath applied to the DOM. The XPath is applied to the DOM node and the resulting nodes collected and returned.
Given an XPath of '/doc/name[@first='David']'
and a doc

       <doc>
          <name first='David' last='Smith'/>
          <name first='Joe' last='Jones'/>
          <name first='David' last='Frost'/>
       </doc>
 

Would return the nodes representing

          <name first='David' last='Smith'/>
          <name first='David' last='Frost'/>
 

Note that this API can also be used to retrieve Attr or Text Nodes. If you want Elements use elementFilter()

Parameters:

rootNode - Node we want to apply the xpath to

xpathString - XPath

Returns:

array of matching nodes

getNode

public static Node getNode(Node rootNode,
           String xpathString)

Gets a node matching the given XPath applied to the DOM. Same as calling getNodes(Node,String) and extracting the first element. If no such node exists, null is returned.

Parameters:

rootNode - Node we want to apply the xpath to

xpathString - XPath

Returns:

matching node or null if no such node exists

getStringValue

public static String getStringValue(Node rootNode,
                    String xpathString,
                    String defaultValue)

Get the string value of the node matching the given XPath applied to the DOM node. The XPath is applied to the DOM node and the FIRST match is returned. Given an XPath of '/doc/name[@first='David']/@last' and a doc

       <doc>
          <name first='David' last='Smith'/>
          <name first='Joe' last='Jones'/>
          <name first='David' last='Frost'/>
       </doc>
 

Would return the String 'Smith'

Parameters:

rootNode - Node we want to apply the xpath to

xpathString - XPath

defaultValue - default value

Returns:

String value of the match or defaultValue if no match was found

getStringValue

public static String getStringValue(Node rootNode,
                    String xpathString)

Get the string value of the node matching the given XPath applied to the DOM node. Equivalent of calling getStringValue(rootNode, xpathString, "")

Parameters:

rootNode - Node we want to apply the xpath to

xpathString - XPath

Returns:

String value of the match or "" if no match was found

getStringValues

public static List<String> getStringValues(Node rootNode,
                           String xpathString)

Get the collection of string values of the matching the given XPath applied to the DOM rootNode. The XPath is applied to the DOM rootNode and the results returned as a collection of Strings. Given an xPathString of '/doc/name[@first='David']/@last' and a rootNode pointing to the document

       <doc>
          <name first='David' last='Smith'/>
          <name first='Joe' last='Jones'/>
          <name first='David' last='Frost'/>
       </doc>
 

Would return a collection containing 'Smith', 'Frost'

Parameters:

rootNode - Node we want to apply the xpath to

xpathString - XPath

Returns:

String array of matches

attrFilter

public static List<Attr> attrFilter(Collection<Node> nodes)

Extract only the Nodes which are implementations of Attr from the given collection.

Parameters:

nodes - Collection of Nodes

Returns:

subset of Element implementions

attrFilter

public static List<Attr> attrFilter(Collection<Node> nodes,
                    String attributeName)

Extract only the Nodes which are implementations of Attr from the given collection and that has a given name.

Parameters:

nodes - Collection of Nodes

attributeName - attribute name

Returns:

subset of Element implementions

commentFilter

public static List<Comment> commentFilter(Collection<Node> nodes)

Extract only the Nodes which are implementations of Comment from the given collection.

Parameters:

nodes - Collection of Nodes

Returns:

subset of Comment implementions

elementFilter

public static List<Element> elementFilter(Collection<Node> nodes)

Extract only the Nodes which are implementations of Element from the given collection.

Parameters:

nodes - Collection of Nodes

Returns:

subset of Element implementions

processingInstructionFilter

public static List<ProcessingInstruction> processingInstructionFilter(Collection<Node> nodes)

Extract only the Nodes which are implementations of ProcessingInstruction from the given collection.

Parameters:

nodes - Collection of Nodes

Returns:

subset of Element implementions

textFilter

public static List<Text> textFilter(Collection<Node> nodes)

Extract only the Nodes which are implementations of Text from the given collection.

Parameters:

nodes - Collection of Nodes

Returns:

subset of Text implementions