org.jaxen

Class ContextSupport

java.lang.Object

org.jaxen.ContextSupport

All Implemented Interfaces:

java.io.Serializable

public class ContextSupport
extends java.lang.Object
implements java.io.Serializable

Supporting context information for resolving namespace prefixes, functions, and variables.

NOTE: This class is not typically used directly, but is exposed for writers of implementation-specific XPath packages.

Version:

$Id$

See Also:

XPath for dom4j, XPath for JDOM, XPath for W3C DOM, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private FunctionContext	functionContext Function context.
private NamespaceContext	namespaceContext Namespace context.
private Navigator	navigator Model navigator.
private static long	serialVersionUID
private VariableContext	variableContext Variable context.

Constructor Summary

Constructors

Constructor and Description
ContextSupport() Construct an empty ContextSupport.
ContextSupport(NamespaceContext namespaceContext, FunctionContext functionContext, VariableContext variableContext, Navigator navigator) Create a new ContextSupport object.

Method Summary

Modifier and Type	Method and Description
Function	getFunction(java.lang.String namespaceURI, java.lang.String prefix, java.lang.String localName) Retrieve a Function.
FunctionContext	getFunctionContext() Retrieve the FunctionContext.
NamespaceContext	getNamespaceContext() Retrieve the NamespaceContext.
Navigator	getNavigator() Retrieve the Navigator.
VariableContext	getVariableContext() Retrieve the VariableContext.
java.lang.Object	getVariableValue(java.lang.String namespaceURI, java.lang.String prefix, java.lang.String localName) Retrieve a variable value.
void	setFunctionContext(FunctionContext functionContext) Set the FunctionContext.
void	setNamespaceContext(NamespaceContext namespaceContext) Set the NamespaceContext.
void	setVariableContext(VariableContext variableContext) Set the VariableContext.
java.lang.String	translateNamespacePrefixToUri(java.lang.String prefix) Translate a namespace prefix to its URI.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

functionContext

private transient FunctionContext functionContext

Function context.

namespaceContext

private NamespaceContext namespaceContext

Namespace context.

variableContext

private VariableContext variableContext

Variable context.

navigator

private Navigator navigator

Model navigator.

Constructor Detail

ContextSupport

public ContextSupport()

Construct an empty ContextSupport.

ContextSupport

public ContextSupport(NamespaceContext namespaceContext,
                      FunctionContext functionContext,
                      VariableContext variableContext,
                      Navigator navigator)

Create a new ContextSupport object.

Parameters:

namespaceContext - the NamespaceContext

functionContext - the FunctionContext

variableContext - the VariableContext

navigator - the model navigator

Method Detail

setNamespaceContext

public void setNamespaceContext(NamespaceContext namespaceContext)

Set the NamespaceContext.

Parameters:

namespaceContext - the namespace context

getNamespaceContext

public NamespaceContext getNamespaceContext()

Retrieve the NamespaceContext.

Returns:

the namespace context

setFunctionContext

public void setFunctionContext(FunctionContext functionContext)

Set the FunctionContext.

Parameters:

functionContext - the function context

getFunctionContext

public FunctionContext getFunctionContext()

Retrieve the FunctionContext.

Returns:

the function context

setVariableContext

public void setVariableContext(VariableContext variableContext)

Set the VariableContext.

Parameters:

variableContext - the variable context

getVariableContext

public VariableContext getVariableContext()

Retrieve the VariableContext.

Returns:

the variable context

getNavigator

public Navigator getNavigator()

Retrieve the Navigator.

Returns:

the navigator

translateNamespacePrefixToUri

public java.lang.String translateNamespacePrefixToUri(java.lang.String prefix)

Translate a namespace prefix to its URI.

Parameters:

prefix - The prefix

Returns:

the namespace URI mapped to the prefix

getVariableValue

public java.lang.Object getVariableValue(java.lang.String namespaceURI,
                                         java.lang.String prefix,
                                         java.lang.String localName)
                                  throws UnresolvableException

Retrieve a variable value.

Parameters:

namespaceURI - the function namespace URI

prefix - the function prefix

localName - the function name

Returns:

the variable value.

Throws:

UnresolvableException - if unable to locate a bound variable.

getFunction

public Function getFunction(java.lang.String namespaceURI,
                            java.lang.String prefix,
                            java.lang.String localName)
                     throws UnresolvableException

Retrieve a Function.

Parameters:

namespaceURI - the function namespace URI

prefix - the function prefix

localName - the function name

Returns:

the function object

Throws:

UnresolvableException - if unable to locate a bound function