Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jaxen

Class ContextSupport

Implemented Interfaces:
Serializable
public class ContextSupport
extends java.lang.Object
implements 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: ContextSupport.java,v 1.13 2006/06/03 20:06:06 elharo Exp $
Author:
bob mcwhirter
See Also:
XPath for dom4j, XPath for JDOM, XPath for W3C DOM

Field Summary

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

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

Method Summary

Function
getFunction(String namespaceURI, String prefix, 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.
Object
getVariableValue(String namespaceURI, String prefix, 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.
String
translateNamespacePrefixToUri(String prefix)
Translate a namespace prefix to its URI.

Field Details

functionContext

private FunctionContext functionContext
Function context.

namespaceContext

private NamespaceContext namespaceContext
Namespace context.

navigator

private Navigator navigator
Model navigator.

serialVersionUID

private static final long serialVersionUID
Field Value:
4494082174713652559L

variableContext

private VariableContext variableContext
Variable context.

Constructor Details

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 Details

getFunction

public Function getFunction(String namespaceURI,
                            String prefix,
                            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

getFunctionContext

public FunctionContext getFunctionContext()
Retrieve the FunctionContext.
Returns:
the function context

getNamespaceContext

public NamespaceContext getNamespaceContext()
Retrieve the NamespaceContext.
Returns:
the namespace context

getNavigator

public Navigator getNavigator()
Retrieve the Navigator.
Returns:
the navigator

getVariableContext

public VariableContext getVariableContext()
Retrieve the VariableContext.
Returns:
the variable context

getVariableValue

public Object getVariableValue(String namespaceURI,
                               String prefix,
                               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.

setFunctionContext

public void setFunctionContext(FunctionContext functionContext)
Set the FunctionContext.
Parameters:
functionContext - the function context

setNamespaceContext

public void setNamespaceContext(NamespaceContext namespaceContext)
Set the NamespaceContext.
Parameters:
namespaceContext - the namespace context

setVariableContext

public void setVariableContext(VariableContext variableContext)
Set the VariableContext.
Parameters:
variableContext - the variable context

translateNamespacePrefixToUri

public String translateNamespacePrefixToUri(String prefix)
Translate a namespace prefix to its URI.
Parameters:
prefix - The prefix
Returns:
the namespace URI mapped to the prefix

Overview Package Class Use Tree Index Deprecated About