|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbiz.c24.io.api.data.jaxen.JaxenXPath
biz.c24.io.api.data.jaxen
for more information) this class has
been deprecated. See biz.c24.io.api.data.saxon
for more information on the preferred approach.
public class JaxenXPath
Concrete implementation of IOXPath interface using Jaxen.
biz.c24.io.api.data.jaxen
,
Jaxen for information on using Jaxen over C24 Integration Objects objects directly.,
Serialized FormConstructor Summary | |
---|---|
JaxenXPath(String expression)
Deprecated. |
|
JaxenXPath(XPathStatement statement)
Deprecated. |
Method Summary | |
---|---|
void |
addNamespace(String prefix,
String uri)
Deprecated. Add a namespace prefix-to-URI mapping for this XPath expression. |
boolean |
booleanValueOf(Object node)
Deprecated. Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context. |
protected org.jaxen.FunctionContext |
createFunctionContext()
Deprecated. Create a default FunctionContext . |
protected org.jaxen.NamespaceContext |
createNamespaceContext()
Deprecated. Create a default NamespaceContext . |
protected org.jaxen.VariableContext |
createVariableContext()
Deprecated. Create a default VariableContext . |
String |
debug()
Deprecated. Returns the string version of this xpath. |
Object |
evaluate(Object node)
Deprecated. Evaluate this XPath against a given context. |
boolean |
getBoolean(ComplexDataObject o)
Deprecated. Returns a boolean representation of the node specified by this object's XPath expression. |
protected org.jaxen.Context |
getContext(Object node)
Deprecated. Create a Context wrapper for the provided
implementation-specific object. |
protected org.jaxen.ContextSupport |
getContextSupport()
Deprecated. Retrieve the ContextSupport aggregation of
NamespaceContext , FunctionContext ,
VariableContext , and Navigator . |
org.jaxen.FunctionContext |
getFunctionContext()
Deprecated. Retrieve the FunctionContext used by this XPath
expression. |
List |
getList(ComplexDataObject o)
Deprecated. Returns a List representation of the node specified by this object's XPath expression. |
org.jaxen.NamespaceContext |
getNamespaceContext()
Deprecated. Retrieve the NamespaceContext used by this XPath
expression. |
org.jaxen.Navigator |
getNavigator()
Deprecated. Retrieve the XML object-model-specific Navigator
for us in evaluating this XPath expression. |
Number |
getNumber(ComplexDataObject o)
Deprecated. Returns a Number representation of the node specified by this object's XPath expression. |
Object |
getObject(ComplexDataObject o)
Deprecated. Returns an Object representation of the node specified by this object's XPath expression. |
org.jaxen.expr.Expr |
getRootExpr()
Deprecated. Retrieve the root expression of the internal compiled form of this XPath expression. |
String |
getString(ComplexDataObject o)
Deprecated. Returns a String representation of the node specified by this object's XPath expression. |
org.jaxen.VariableContext |
getVariableContext()
Deprecated. Retrieve the VariableContext used by this XPath
expression. |
Number |
numberValueOf(Object node)
Deprecated. Retrieve a number-value interpretation of this XPath expression when evaluated against a given context. |
List |
selectNodes(Object node)
Deprecated. Select all nodes that are selectable by this XPath expression. |
protected List |
selectNodesForContext(org.jaxen.Context context)
Deprecated. Select all nodes that are selectable by this XPath expression on the given Context object. |
Object |
selectSingleNode(Object node)
Deprecated. Select only the first node that is selectable by this XPath expression. |
protected Object |
selectSingleNodeForContext(org.jaxen.Context context)
Deprecated. Select only the first node that is selectable by this XPath expression. |
void |
setFunctionContext(org.jaxen.FunctionContext functionContext)
Deprecated. Set a FunctionContext for use with this XPath
expression. |
void |
setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
Deprecated. Set a NamespaceContext for use with this
XPath expression. |
void |
setVariableContext(org.jaxen.VariableContext variableContext)
Deprecated. Set a VariableContext for use with this XPath
expression. |
String |
stringValueOf(Object node)
Deprecated. |
String |
toString()
Deprecated. Return the normalized string of this XPath expression. |
String |
valueOf(Object node)
Deprecated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public JaxenXPath(String expression) throws org.jaxen.JaxenException
expression
- The xpath expression.
org.jaxen.JaxenException
- If the xpath expression is invalid.public JaxenXPath(XPathStatement statement) throws org.jaxen.JaxenException
Since Jaxen is not namespace aware, any namespaces specified in the XPath statement are ignored. This constructor is provided for compapability reasons with other IOXPath implementations.
statement
- The xpath statement.
org.jaxen.JaxenException
Method Detail |
---|
public Object getObject(ComplexDataObject o) throws IOXPathException
IOXPath
getObject
in interface IOXPath
o
- The ComplexDataObject
on which the expression will be evaluated.
IOXPathException
- If the underlying xpath implementation rejects the xpath expression.public List getList(ComplexDataObject o) throws IOXPathException
IOXPath
getList
in interface IOXPath
o
- The ComplexDataObject
on which the expression will be evaluated.
IOXPathException
- If the underlying xpath implementation rejects the xpath expression.public boolean getBoolean(ComplexDataObject o) throws IOXPathException
IOXPath
getBoolean
in interface IOXPath
o
- The ComplexDataObject
on which the expression will be evaluated.
true if the underlying implementation evaluates the XPath expression to true.
- Throws:
IOXPathException
- If the underlying xpath implementation rejects the xpath expression.
public Number getNumber(ComplexDataObject o) throws IOXPathException
IOXPath
getNumber
in interface IOXPath
o
- The ComplexDataObject
on which the expression will be evaluated.
IOXPathException
- If the underlying xpath implementation rejects the xpath expression.public String getString(ComplexDataObject o) throws IOXPathException
IOXPath
getString
in interface IOXPath
o
- The ComplexDataObject
on which the expression will be evaluated.
IOXPathException
- If the underlying xpath implementation rejects the xpath expression.public Object evaluate(Object node) throws org.jaxen.JaxenException
The context of evaluation my be a document, an element, or a set of elements.
If the expression evaluates to a single primitive
(String, Number or Boolean) type, it is returned
directly. Otherwise, the returned value is a
List (a node-set
, in the terms of the
specification) of values.
When using this method, one must be careful to
test the class of the returned objects, and of
each of the composite members if a List
is returned. If the returned members are XML entities,
they will be the actual Document
,
Element
or Attribute
objects
as defined by the concrete XML object-model implementation,
directly from the context document. This does not
return copies of anything, but merely returns
references to entities within the source document.
evaluate
in interface org.jaxen.XPath
node
- The node, nodeset or Context object for evaluation. This value can be null.
org.jaxen.JaxenException
public List selectNodes(Object node) throws org.jaxen.JaxenException
NOTE: In most cases, nodes will be returned
in document-order, as defined by the XML Canonicalization
specification. The exception occurs when using XPath
expressions involving the union
operator
(denoted with the pipe '|' character).
selectNodes
in interface org.jaxen.XPath
node
- The node, nodeset or Context object for evaluation. This value can be null.
node-set
of all items selected
by this XPath expression.
org.jaxen.JaxenException
selectSingleNode(java.lang.Object)
public Object selectSingleNode(Object node) throws org.jaxen.JaxenException
union
operator
(denoted with the pipe '|' character).
selectSingleNode
in interface org.jaxen.XPath
node
- The node, nodeset or Context object for evaluation. This value can be null.
node-set
of all items selected
by this XPath expression.
org.jaxen.JaxenException
selectNodes(java.lang.Object)
public String valueOf(Object node) throws org.jaxen.JaxenException
valueOf
in interface org.jaxen.XPath
org.jaxen.JaxenException
public String stringValueOf(Object node) throws org.jaxen.JaxenException
stringValueOf
in interface org.jaxen.XPath
org.jaxen.JaxenException
public boolean booleanValueOf(Object node) throws org.jaxen.JaxenException
The boolean-value of the expression is determined per
the boolean(..)
core function as defined
in the XPath specification. This means that an expression
that selects zero nodes will return false
,
while an expression that selects one-or-more nodes will
return true
.
booleanValueOf
in interface org.jaxen.XPath
node
- The node, nodeset or Context object for evaluation. This value can be null.
org.jaxen.JaxenException
public Number numberValueOf(Object node) throws org.jaxen.JaxenException
The number-value of the expression is determined per
the number(..)
core function as defined
in the XPath specification. This means that if this
expression selects multiple nodes, the number-value
of the first node is returned.
numberValueOf
in interface org.jaxen.XPath
node
- The node, nodeset or Context object for evaluation. This value can be null.
org.jaxen.JaxenException
public void addNamespace(String prefix, String uri) throws org.jaxen.JaxenException
Namespace prefix-to-URI mappings in an XPath are independant of those used within any document. Only the mapping explicitly added to this XPath will be available for resolving the XPath expression.
This is a convenience method for adding mappings to the
default NamespaceContext
in place for this XPath.
If you have installed a specific custom NamespaceContext
,
then this method will throw a JaxenException
.
addNamespace
in interface org.jaxen.XPath
prefix
- The namespace prefix.uri
- The namespace URI.
org.jaxen.JaxenException
- If a NamespaceContext
used by this XPath has been explicitly installed.public void setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
NamespaceContext
for use with this
XPath expression.
A NamespaceContext
is responsible for translating
namespace prefixes within the expression into namespace URIs.
setNamespaceContext
in interface org.jaxen.XPath
namespaceContext
- The NamespaceContext
to
install for this expression.NamespaceContext
,
NamespaceContext.translateNamespacePrefixToUri(java.lang.String)
public void setFunctionContext(org.jaxen.FunctionContext functionContext)
FunctionContext
for use with this XPath
expression.
A FunctionContext
is responsible for resolving
all function calls used within the expression.
setFunctionContext
in interface org.jaxen.XPath
functionContext
- The FunctionContext
to
install for this expression.FunctionContext
,
FunctionContext.getFunction(java.lang.String, java.lang.String, java.lang.String)
public void setVariableContext(org.jaxen.VariableContext variableContext)
VariableContext
for use with this XPath
expression.
A VariableContext
is responsible for resolving
all variables referenced within the expression.
setVariableContext
in interface org.jaxen.XPath
variableContext
- The VariableContext
to
install for this expression.VariableContext
,
VariableContext.getVariableValue(java.lang.String, java.lang.String, java.lang.String)
public org.jaxen.NamespaceContext getNamespaceContext()
NamespaceContext
used by this XPath
expression.
A FunctionContext
is responsible for resolving
all function calls used within the expression.
If this XPath expression has not previously had a NamespaceContext
installed, a new default NamespaceContext
will be created,
installed and returned.
getNamespaceContext
in interface org.jaxen.XPath
NamespaceContext
used by this expression.NamespaceContext
public org.jaxen.FunctionContext getFunctionContext()
FunctionContext
used by this XPath
expression.
A FunctionContext
is responsible for resolving
all function calls used within the expression.
If this XPath expression has not previously had a FunctionContext
installed, a new default FunctionContext
will be created,
installed and returned.
getFunctionContext
in interface org.jaxen.XPath
FunctionContext
used by this expression.FunctionContext
public org.jaxen.VariableContext getVariableContext()
VariableContext
used by this XPath
expression.
A VariableContext
is responsible for resolving
all variables referenced within the expression.
If this XPath expression has not previously had a VariableContext
installed, a new default VariableContext
will be created,
installed and returned.
getVariableContext
in interface org.jaxen.XPath
VariableContext
used by this expression.VariableContext
public org.jaxen.expr.Expr getRootExpr()
Internally, Jaxen maintains a form of Abstract Syntax Tree (AST) to represent the structure of the XPath expression. This is normally not required during normal consumer-grade usage of Jaxen. This method is provided for hard-core users who wish to manipulate or inspect a tree-based version of the expression.
public String toString()
During parsing, the XPath expression is normalized, removing abbreviations and other convenience notation. This method returns the fully normalized representation of the original expression.
toString
in class Object
public String debug()
toString()
protected org.jaxen.Context getContext(Object node)
Context
wrapper for the provided
implementation-specific object.
node
- The implementation-specific object
to be used as the context.
Context
wrapper around the object.protected org.jaxen.ContextSupport getContextSupport()
ContextSupport
aggregation of
NamespaceContext
, FunctionContext
,
VariableContext
, and Navigator
.
ContextSupport
for this
XPath expression.public org.jaxen.Navigator getNavigator()
Navigator
for us in evaluating this XPath expression.
getNavigator
in interface org.jaxen.XPath
Navigator
.protected org.jaxen.FunctionContext createFunctionContext()
FunctionContext
.
FunctionContext
.protected org.jaxen.NamespaceContext createNamespaceContext()
NamespaceContext
.
NamespaceContext
instance.protected org.jaxen.VariableContext createVariableContext()
VariableContext
.
VariableContext
instance.protected List selectNodesForContext(org.jaxen.Context context) throws org.jaxen.JaxenException
NOTE: In most cases, nodes will be returned
in document-order, as defined by the XML Canonicalization
specification. The exception occurs when using XPath
expressions involving the union
operator
(denoted with the pipe '|' character).
context
- is the Context which gets evaluated.
node-set
of all items selected
by this XPath expression.
org.jaxen.JaxenException
protected Object selectSingleNodeForContext(org.jaxen.Context context) throws org.jaxen.JaxenException
union
operator
(denoted with the pipe '|' character).
context
- is the Context which gets evaluated.
node-set
of all items selected
by this XPath expression.
org.jaxen.JaxenException
selectNodesForContext(org.jaxen.Context)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |