org.radeox.api.engine.context

Interface RenderContext

All Known Subinterfaces:

InitialRenderContext

public interface RenderContext

RenderContext stores basic data for the context the RenderEngine is called in. RenderContext can be used by the Engine in whatever way it likes to. The Radeox RenderEngine uses RenderContext to construct FilterContext.

Version:

$Id: RenderContext.java 7707 2006-04-12 17:30:19Z ian@caret.cam.ac.uk $

Author:

Stephan J. Schmidt

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FORMATTER
static String	INPUT_BUNDLE_NAME
static String	INPUT_LOCALE
static String	LANGUAGE_BUNDLE_NAME
static String	LANGUAGE_LOCALE
static String	OUTPUT_BUNDLE_NAME
static String	OUTPUT_LOCALE

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String key)
Map	getParameters()
RenderEngine	getRenderEngine() Returns the RenderEngine handling this request.
void	set(String key, Object value)
void	setParameters(Map parameters) Set the parameters for this execution context.
void	setRenderEngine(RenderEngine engine) Stores the current RenderEngine of the request

Field Detail

INPUT_BUNDLE_NAME

static final String INPUT_BUNDLE_NAME

See Also:

Constant Field Values

OUTPUT_BUNDLE_NAME

static final String OUTPUT_BUNDLE_NAME

See Also:

Constant Field Values

LANGUAGE_BUNDLE_NAME

static final String LANGUAGE_BUNDLE_NAME

See Also:

Constant Field Values

LANGUAGE_LOCALE

static final String LANGUAGE_LOCALE

See Also:

Constant Field Values

INPUT_LOCALE

static final String INPUT_LOCALE

See Also:

Constant Field Values

OUTPUT_LOCALE

static final String OUTPUT_LOCALE

See Also:

Constant Field Values

DEFAULT_FORMATTER

static final String DEFAULT_FORMATTER

See Also:

Constant Field Values

Method Detail

getRenderEngine

RenderEngine getRenderEngine()

Returns the RenderEngine handling this request.

Returns:

engine RenderEngine handling the request within this context

setRenderEngine

void setRenderEngine(RenderEngine engine)

Stores the current RenderEngine of the request

Parameters:

engine - Current RenderEnginge

get

Object get(String key)

set

void set(String key,
       Object value)

getParameters

Map getParameters()

setParameters

void setParameters(Map parameters)

Set the parameters for this execution context. These parameters are read when encountering a variable in macros like {search:$query} or by ParamFilter in {$query}. Query is then read from the parameter map before given to the macro

Parameters:

parameters - Map of parameters with name,value pairs