|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--weblogic.apache.xpath.XPath
The XPath class wraps an expression object and provides general services for execution of that expression.
This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.
Field Summary | |
static int |
MATCH
Represents a match type expression. |
static double |
MATCH_SCORE_NODETEST
The match score if the pattern consists of just a NodeTest. |
static double |
MATCH_SCORE_NONE
The match score if no match is made. |
static double |
MATCH_SCORE_NSWILD
The match score if the pattern pattern has the form NCName:*. |
static double |
MATCH_SCORE_OTHER
The match score if the pattern consists of something other than just a NodeTest or just a qname. |
static double |
MATCH_SCORE_QNAME
The match score if the pattern has the form of a QName optionally preceded by an @ character. |
static int |
SELECT
Represents a select type expression. |
Constructor Summary | |
XPath(java.lang.String exprString,
javax.xml.transform.SourceLocator locator,
PrefixResolver prefixResolver,
int type)
Construct an XPath object. |
|
XPath(java.lang.String exprString,
javax.xml.transform.SourceLocator locator,
PrefixResolver prefixResolver,
int type,
javax.xml.transform.ErrorListener errorListener)
Construct an XPath object. |
Method Summary | |
void |
assert(boolean b,
java.lang.String msg)
Tell the user of an assertion error, and probably throw an exception. |
void |
error(XPathContext xctxt,
org.w3c.dom.Node sourceNode,
int msg,
java.lang.Object[] args)
Tell the user of an error, and probably throw an exception. |
XObject |
execute(XPathContext xctxt,
org.w3c.dom.Node contextNode,
PrefixResolver namespaceContext)
Given an expression and a context, evaluate the XPath and call the callback as nodes are found. |
Expression |
getExpression()
Get the raw Expression object that this class wraps. |
javax.xml.transform.SourceLocator |
getLocator()
Get the SourceLocator on the expression object. |
double |
getMatchScore(XPathContext xctxt,
org.w3c.dom.Node context)
Get the match score of the given node. |
java.lang.String |
getPatternString()
Return the XPath string associated with this object. |
void |
installFunction(java.lang.String name,
int funcIndex,
Function func)
Install a built-in function. |
void |
setExpression(Expression exp)
Set the raw expression object for this object. |
void |
setLocator(javax.xml.transform.SourceLocator l)
Set the SourceLocator on the expression object. |
void |
warn(XPathContext xctxt,
org.w3c.dom.Node sourceNode,
int msg,
java.lang.Object[] args)
Warn the user of an problem. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int SELECT
public static final int MATCH
public static final double MATCH_SCORE_NONE
public static final double MATCH_SCORE_QNAME
public static final double MATCH_SCORE_NSWILD
public static final double MATCH_SCORE_NODETEST
public static final double MATCH_SCORE_OTHER
Constructor Detail |
public XPath(java.lang.String exprString, javax.xml.transform.SourceLocator locator, PrefixResolver prefixResolver, int type, javax.xml.transform.ErrorListener errorListener) throws javax.xml.transform.TransformerException
exprString
- The XPath expression.locator
- The location of the expression, may be null.prefixResolver
- A prefix resolver to use to resolve prefixes to
namespace URIs.type
- one of SELECT
or MATCH
.errorListener
- The error listener, or null if default should be used.public XPath(java.lang.String exprString, javax.xml.transform.SourceLocator locator, PrefixResolver prefixResolver, int type) throws javax.xml.transform.TransformerException
exprString
- The XPath expression.locator
- The location of the expression, may be null.prefixResolver
- A prefix resolver to use to resolve prefixes to
namespace URIs.type
- one of SELECT
or MATCH
.Method Detail |
public Expression getExpression()
public void setExpression(Expression exp)
exp
- the raw Expression object, which should not normally be null.public javax.xml.transform.SourceLocator getLocator()
public void setLocator(javax.xml.transform.SourceLocator l)
l
- the SourceLocator on the expression object, which may be null.public java.lang.String getPatternString()
public XObject execute(XPathContext xctxt, org.w3c.dom.Node contextNode, PrefixResolver namespaceContext) throws javax.xml.transform.TransformerException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.callback
- Interface that implements the processLocatedNode method.callbackInfo
- Object that will be passed to the processLocatedNode method.stopAtFirst
- True if the search should stop once the first node in document
order is found.public double getMatchScore(XPathContext xctxt, org.w3c.dom.Node context) throws javax.xml.transform.TransformerException
xctxt
- XPath runtime context.context
- The current source tree context node.MATCH_SCORE_NODETEST
,
MATCH_SCORE_NONE
, MATCH_SCORE_OTHER
,
or MATCH_SCORE_QNAME
.public void installFunction(java.lang.String name, int funcIndex, Function func)
name
- The unqualified name of the function.funcIndex
- The index of the function in the table.func
- A Implementation of an XPath Function object.public void warn(XPathContext xctxt, org.w3c.dom.Node sourceNode, int msg, java.lang.Object[] args) throws javax.xml.transform.TransformerException
xctxt
- The XPath runtime context.sourceNode
- Not used.msg
- An error number that corresponds to one of the numbers found
in XPATHErrorResources
, which is
a key for a format string.args
- An array of arguments represented in the format string, which
may be null.public void assert(boolean b, java.lang.String msg)
b
- If false, a runtime exception will be thrown.msg
- The assertion message, which should be informative.public void error(XPathContext xctxt, org.w3c.dom.Node sourceNode, int msg, java.lang.Object[] args) throws javax.xml.transform.TransformerException
xctxt
- The XPath runtime context.sourceNode
- Not used.msg
- An error number that corresponds to one of the numbers found
in XPATHErrorResources
, which is
a key for a format string.args
- An array of arguments represented in the format string, which
may be null.
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs61 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |