Java Doc for XPath.java in » 6.0-JDK-Core » xml » javax » xml » xpath » Java Source Code / Java DocumentationJava Source Code and Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server
26.	ERP CRM Financial
27.	ESB
28.	Forum
29.	Game
30.	GIS
31.	Graphic 3D
32.	Graphic Library
33.	Groupware
34.	HTML Parser
35.	IDE
36.	IDE Eclipse
37.	IDE Netbeans
38.	Installer
39.	Internationalization Localization
40.	Inversion of Control
41.	Issue Tracking
42.	J2EE
43.	J2ME
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Music
50.	Net
51.	Parser
52.	PDF
53.	Portal
54.	Profiler
55.	Project Management
56.	Report
57.	RSS RDF
58.	Rule Engine
59.	Science
60.	Scripting
61.	Search Engine
62.	Security
63.	Sevlet Container
64.	Source Control
65.	Swing Library
66.	Template Engine
67.	Test Coverage
68.	Testing
69.	UML
70.	Web Crawler
71.	Web Framework
72.	Web Mail
73.	Web Server
74.	Web Services
75.	Web Services apache cxf 2.2.6
76.	Web Services AXIS2
77.	Wiki Engine
78.	Workflow Engines
79.	XML
80.	XML UI

Java Source Code / Java Documentation » 6.0 JDK Core » xml » javax.xml.xpath

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.xml.xpath .XPath

XPath

public interface XPath (Code)

XPath provides access to the XPath evaluation environment and expressions.

Evaluation of XPath Expressions.
context	If a request is made to evaluate the expression in the absence of a context item, an empty document node will be used for the context. For the purposes of evaluating XPath expressions, a DocumentFragment is treated like a Document node.
variables	If the expression contains a variable reference, its value will be found through the XPathVariableResolver set with XPath.setXPathVariableResolver(XPathVariableResolver resolver) . An XPathExpressionException is raised if the variable resolver is undefined or the resolver returns `null` for the variable. The value of a variable must be immutable through the course of any single evaluation.
functions	If the expression contains a function reference, the function will be found through the XPathFunctionResolver set with XPath.setXPathFunctionResolver(XPathFunctionResolver resolver) . An XPathExpressionException is raised if the function resolver is undefined or the function resolver returns `null` for the function.
QNames	QNames in the expression are resolved against the XPath namespace context set with XPath.setNamespaceContext(NamespaceContext nsContext) .
result	This result of evaluating an expression is converted to an instance of the desired return type. Valid return types are defined in XPathConstants . Conversion to the return type follows XPath conversion rules.

An XPath object is not thread-safe and not reentrant. In other words, it is the application's responsibility to make sure that one XPath object is not used from more than one thread at any given time, and while the evaluate method is invoked, applications may not recursively call the evaluate method.

author:
   Norman Walsh
author:
   Jeff Suttor
version:
   $Revision: 1.5 $, $Date: 2005/10/13 17:00:49 $
See Also:    XML Path Language (XPath) Version 1.0
since:
   1.5

Method Summary
public XPathExpression	compile(String expression) Compile an XPath expression for later evaluation. If `expression` contains any XPathFunction s, they must be available via the XPathFunctionResolver . An XPathExpressionException will be thrown if the `XPathFunction` cannot be resovled with the `XPathFunctionResolver`. If `expression` contains any variables, the XPathVariableResolver in effect at compile time will be used to resolve them. If `expression` is `null`, a `NullPointerException` is thrown. Parameters: expression - The XPath expression.
public Object	evaluate(String expression, Object item, QName returnType) Evaluate an `XPath` expression in the specified context and return the result as the specified type. See Evaluation of XPath Expressions for context item evaluation, variable, function and `QName` resolution and return type conversion. If `returnType` is not one of the types defined in XPathConstants ( XPathConstants.NUMBER NUMBER , XPathConstants.STRING STRING , XPathConstants.BOOLEAN BOOLEAN , XPathConstants.NODE NODE or XPathConstants.NODESET NODESET ) then an `IllegalArgumentException` is thrown. If a `null` value is provided for `item`, an empty document will be used for the context. If `expression` or `returnType` is `null`, then a `NullPointerException` is thrown. Parameters: expression - The XPath expression. Parameters: item - The starting context (a node, for example). Parameters: returnType - The desired return type.
public String	evaluate(String expression, Object item) Evaluate an XPath expression in the specified context and return the result as a `String`. This method calls XPath.evaluate(String expression,Object item,QName returnType) with a `returnType` of XPathConstants.STRING . See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion. If a `null` value is provided for `item`, an empty document will be used for the context. If `expression` is `null`, then a `NullPointerException` is thrown. Parameters: expression - The XPath expression. Parameters: item - The starting context (a node, for example).
public Object	evaluate(String expression, InputSource source, QName returnType) Evaluate an XPath expression in the context of the specified `InputSource` and return the result as the specified type. This method builds a data model for the InputSource and calls XPath.evaluate(String expression,Object item,QName returnType) on the resulting document object. See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion. If `returnType` is not one of the types defined in XPathConstants , then an `IllegalArgumentException` is thrown. If `expression`, `source` or `returnType` is `null`, then a `NullPointerException` is thrown. Parameters: expression - The XPath expression. Parameters: source - The input source of the document to evaluate over. Parameters: returnType - The desired return type.
public String	evaluate(String expression, InputSource source) Evaluate an XPath expression in the context of the specified `InputSource` and return the result as a `String`. This method calls XPath.evaluate(String expression,InputSource source,QName returnType) with a `returnType` of XPathConstants.STRING . See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion. If `expression` or `source` is `null`, then a `NullPointerException` is thrown. Parameters: expression - The XPath expression. Parameters: source - The `InputSource` of the document to evaluate over.
public NamespaceContext	getNamespaceContext()
public XPathFunctionResolver	getXPathFunctionResolver()
public XPathVariableResolver	getXPathVariableResolver()
public void	reset() Reset this `XPath` to its original configuration. `XPath` is reset to the same state as when it was created with XPathFactory.newXPath . `reset()` is designed to allow the reuse of existing `XPath`s thus saving resources associated with the creation of new `XPath`s. The reset `XPath` is not guaranteed to have the same XPathFunctionResolver , XPathVariableResolver or NamespaceContext `Object`s, e.g.
public void	setNamespaceContext(NamespaceContext nsContext)
public void	setXPathFunctionResolver(XPathFunctionResolver resolver)
public void	setXPathVariableResolver(XPathVariableResolver resolver)

Method Detail

compile

public XPathExpression compile(String expression) throws XPathExpressionException(Code)

Compile an XPath expression for later evaluation.

If expression contains any XPathFunction s, they must be available via the XPathFunctionResolver . An XPathExpressionException will be thrown if the XPathFunction cannot be resovled with the XPathFunctionResolver.

If expression contains any variables, the XPathVariableResolver in effect at compile time will be used to resolve them.

If expression is null, a NullPointerException is thrown.

Parameters:
  expression - The XPath expression. Compiled XPath expression.
throws:
  XPathExpressionException - If expression cannot be compiled.
throws:
  NullPointerException - If expression is null.

evaluate

public Object evaluate(String expression, Object item, QName returnType) throws XPathExpressionException(Code)

Evaluate an XPath expression in the specified context and return the result as the specified type.

See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.

If returnType is not one of the types defined in XPathConstants ( XPathConstants.NUMBER NUMBER , XPathConstants.STRING STRING , XPathConstants.BOOLEAN BOOLEAN , XPathConstants.NODE NODE or XPathConstants.NODESET NODESET ) then an IllegalArgumentException is thrown.

If a null value is provided for item, an empty document will be used for the context. If expression or returnType is null, then a NullPointerException is thrown.

Parameters:
  expression - The XPath expression.
Parameters:
  item - The starting context (a node, for example).
Parameters:
  returnType - The desired return type. Result of evaluating an XPath expression as an Object of returnType.
throws:
  XPathExpressionException - If expression cannot be evaluated.
throws:
  IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.
throws:
  NullPointerException - If expression or returnType is null.

evaluate

public String evaluate(String expression, Object item) throws XPathExpressionException(Code)

Evaluate an XPath expression in the specified context and return the result as a String.

This method calls XPath.evaluate(String expression,Object item,QName returnType) with a returnType of XPathConstants.STRING .

See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.

If a null value is provided for item, an empty document will be used for the context. If expression is null, then a NullPointerException is thrown.

Parameters:
  expression - The XPath expression.
Parameters:
  item - The starting context (a node, for example). The String that is the result of evaluating the expression andconverting the result to a String.
throws:
  XPathExpressionException - If expression cannot be evaluated.
throws:
  NullPointerException - If expression is null.

evaluate

public Object evaluate(String expression, InputSource source, QName returnType) throws XPathExpressionException(Code)

Evaluate an XPath expression in the context of the specified InputSource and return the result as the specified type.

This method builds a data model for the InputSource and calls XPath.evaluate(String expression,Object item,QName returnType) on the resulting document object.

See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.

If returnType is not one of the types defined in XPathConstants , then an IllegalArgumentException is thrown.

If expression, source or returnType is null, then a NullPointerException is thrown.

Parameters:
  expression - The XPath expression.
Parameters:
  source - The input source of the document to evaluate over.
Parameters:
  returnType - The desired return type. The Object that encapsulates the result of evaluating the expression.
throws:
  XPathExpressionException - If expression cannot be evaluated.
throws:
  IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.
throws:
  NullPointerException - If expression, source or returnTypeis null.

evaluate

public String evaluate(String expression, InputSource source) throws XPathExpressionException(Code)

Evaluate an XPath expression in the context of the specified InputSource and return the result as a String.

This method calls XPath.evaluate(String expression,InputSource source,QName returnType) with a returnType of XPathConstants.STRING .

See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.

If expression or source is null, then a NullPointerException is thrown.

Parameters:
  expression - The XPath expression.
Parameters:
  source - The InputSource of the document to evaluate over. The String that is the result of evaluating the expression andconverting the result to a String.
throws:
  XPathExpressionException - If expression cannot be evaluated.
throws:
  NullPointerException - If expression or source is null.

getNamespaceContext

public NamespaceContext getNamespaceContext()(Code)

Return the current namespace context.

null is returned in no namespace context is in effect.

Current Namespace context.

getXPathFunctionResolver

public XPathFunctionResolver getXPathFunctionResolver()(Code)

Return the current function resolver.

null is returned in no function resolver is in effect.

Current function resolver.

getXPathVariableResolver

public XPathVariableResolver getXPathVariableResolver()(Code)

Return the current variable resolver.

null is returned in no variable resolver is in effect.

Current variable resolver.

reset

public void reset()(Code)

Reset this XPath to its original configuration.

XPath is reset to the same state as when it was created with XPathFactory.newXPath . reset() is designed to allow the reuse of existing XPaths thus saving resources associated with the creation of new XPaths.

The reset XPath is not guaranteed to have the same XPathFunctionResolver , XPathVariableResolver or NamespaceContext Objects, e.g. Object.equals(Object obj) . It is guaranteed to have a functionally equal XPathFunctionResolver, XPathVariableResolver and NamespaceContext.

setNamespaceContext

public void setNamespaceContext(NamespaceContext nsContext)(Code)

Establish a namespace context.

A NullPointerException is thrown if nsContext is null.

Parameters:
nsContext - Namespace context to use.
throws:
NullPointerException - If nsContext is null.

setXPathFunctionResolver

public void setXPathFunctionResolver(XPathFunctionResolver resolver)(Code)

Establish a function resolver.

A NullPointerException is thrown if resolver is null.

Parameters:
resolver - XPath function resolver.
throws:
NullPointerException - If resolver is null.

setXPathVariableResolver

public void setXPathVariableResolver(XPathVariableResolver resolver)(Code)

Establish a variable resolver.

A NullPointerException is thrown if resolver is null.

Parameters:
resolver - Variable resolver.
throws:
NullPointerException - If resolver is null.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.