com.formos.tapestry.xpath

Class TapestryXPath

java.lang.Object

org.jaxen.BaseXPath

com.formos.tapestry.xpath.TapestryXPath

All Implemented Interfaces:

Serializable, org.jaxen.XPath

public class TapestryXPath
extends org.jaxen.BaseXPath
implements org.jaxen.XPath

Implements XPath for the Tapestry DOM.

Author:

Paul Field

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TapestryXPath(String xpath)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	normalizedDescendantText(Object node) Selects nodes and then, for each node found, concatenates all the descendant text nodes and applies normalizeText(String).
static String	normalizeText(String text) Normalises text from the DOM so that is more like what is displayed to a user by a browser (for Latin scripts): whitespace is replaced with space, multiple space is collapsed into single spaces and any space at the beginning or end is trimmed.
List<org.apache.tapestry5.dom.Attribute>	selectAttributes(Object node) As selectNodes(Object) but assumes the result will be a collection of Attributes.
List<org.apache.tapestry5.dom.Element>	selectElements(Object node) As selectNodes(Object) but assumes the result will be a collection of Elements.
List<String>	selectElementsAttribute(Object node, String attributeName) Returns the Element.getAttribute(String) from each element identified by selectElements(Object).
List<String>	selectElementsChildMarkup(Object node) Returns the Element.getChildMarkup() from each element identified by selectElements(Object).
List<org.apache.tapestry5.dom.Node>	selectNodes(Object node)
org.apache.tapestry5.dom.Element	selectSingleElement(Object node) As BaseXPath.selectSingleNode(Object) but assumes the result will be an Element.
String	singleNormalizedDescendantText(Object node) Selects a single node and then concatenates all the descendant text nodes and applies normalizeText(String).
List<String>	stringValuesOf(Object node) As selectNodes(Object) but converts each of the selected nodes into its XPath string-value.
static TapestryXPath	xpath(String xpath) Creates a new TapestryXPath object.

Methods inherited from class org.jaxen.BaseXPath

addNamespace, booleanValueOf, createFunctionContext, createNamespaceContext, createVariableContext, debug, evaluate, getContext, getContextSupport, getFunctionContext, getNamespaceContext, getNavigator, getRootExpr, getVariableContext, numberValueOf, selectNodesForContext, selectSingleNode, selectSingleNodeForContext, setFunctionContext, setNamespaceContext, setVariableContext, stringValueOf, toString, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jaxen.XPath

addNamespace, booleanValueOf, evaluate, getFunctionContext, getNamespaceContext, getNavigator, getVariableContext, numberValueOf, selectSingleNode, setFunctionContext, setNamespaceContext, setVariableContext, stringValueOf, valueOf

Constructor Detail

TapestryXPath

public TapestryXPath(String xpath)
              throws org.jaxen.JaxenException

Throws:

org.jaxen.JaxenException

Method Detail

xpath

public static TapestryXPath xpath(String xpath)
                           throws org.jaxen.JaxenException

Creates a new TapestryXPath object.

Parameters:

xpath - the XPath expression as a string (not null)

Returns:

the new instance (not null)

Throws:

org.jaxen.JaxenException

selectNodes

public List<org.apache.tapestry5.dom.Node> selectNodes(Object node)
                                                throws org.jaxen.JaxenException

Specified by:

selectNodes in interface org.jaxen.XPath

Overrides:

selectNodes in class org.jaxen.BaseXPath

Throws:

org.jaxen.JaxenException

selectElements

public List<org.apache.tapestry5.dom.Element> selectElements(Object node)
                                                      throws org.jaxen.JaxenException

As selectNodes(Object) but assumes the result will be a collection of Elements.

Throws:

org.jaxen.JaxenException

selectAttributes

public List<org.apache.tapestry5.dom.Attribute> selectAttributes(Object node)
                                                          throws org.jaxen.JaxenException

As selectNodes(Object) but assumes the result will be a collection of Attributes.

Throws:

org.jaxen.JaxenException

stringValuesOf

public List<String> stringValuesOf(Object node)
                            throws org.jaxen.JaxenException

As selectNodes(Object) but converts each of the selected nodes into its XPath string-value.

Throws:

org.jaxen.JaxenException

See Also:

XPath Spec: string-value, normalizedDescendantText(Object)

selectElementsChildMarkup

public List<String> selectElementsChildMarkup(Object node)
                                       throws org.jaxen.JaxenException

Returns the Element.getChildMarkup() from each element identified by selectElements(Object).

Throws:

org.jaxen.JaxenException

selectElementsAttribute

public List<String> selectElementsAttribute(Object node,
                                   String attributeName)
                                     throws org.jaxen.JaxenException

Returns the Element.getAttribute(String) from each element identified by selectElements(Object). Note this is different from using XPath to match the attributes - if the attribute is missing then XPath can't match it whereas this will include a "null" in the list.

Throws:

org.jaxen.JaxenException

selectSingleElement

public org.apache.tapestry5.dom.Element selectSingleElement(Object node)
                                                     throws org.jaxen.JaxenException

As BaseXPath.selectSingleNode(Object) but assumes the result will be an Element.

Throws:

org.jaxen.JaxenException

singleNormalizedDescendantText

public String singleNormalizedDescendantText(Object node)
                                      throws org.jaxen.JaxenException

Selects a single node and then concatenates all the descendant text nodes and applies normalizeText(String). Useful to get a sense of what would be displayed as text to a user by a browser.

Throws:

org.jaxen.JaxenException

See Also:

BaseXPath.selectSingleNode(Object)

normalizedDescendantText

public List<String> normalizedDescendantText(Object node)
                                      throws org.jaxen.JaxenException

Selects nodes and then, for each node found, concatenates all the descendant text nodes and applies normalizeText(String). Useful to get a sense of what would be displayed as text to a user by a browser.

Returns:

the list of text (not null; same size as the number of nodes selected by the XPath)

Throws:

org.jaxen.JaxenException

See Also:

BaseXPath.selectSingleNode(Object)

normalizeText

public static String normalizeText(String text)

Normalises text from the DOM so that is more like what is displayed to a user by a browser (for Latin scripts): whitespace is replaced with space, multiple space is collapsed into single spaces and any space at the beginning or end is trimmed.