org.radeox.api.engine.context
Interface RenderContext

All Known Subinterfaces:
InitialRenderContext
All Known Implementing Classes:
BaseInitialRenderContext, BaseRenderContext

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,v 1.2 2004/01/30 08:42:56 stephan Exp $
Author:
Stephan J. Schmidt

Field Summary
static java.lang.String DEFAULT_FORMATTER
           
static java.lang.String INPUT_BUNDLE_NAME
           
static java.lang.String INPUT_LOCALE
           
static java.lang.String LANGUAGE_BUNDLE_NAME
           
static java.lang.String LANGUAGE_LOCALE
           
static java.lang.String OUTPUT_BUNDLE_NAME
           
static java.lang.String OUTPUT_LOCALE
           
 
Method Summary
 void commitCache()
           
 java.lang.Object get(java.lang.String key)
           
 java.util.Map getParameters()
           
 RenderEngine getRenderEngine()
          Returns the RenderEngine handling this request.
 boolean isCacheable()
           
 void set(java.lang.String key, java.lang.Object value)
           
 void setCacheable(boolean cacheable)
           
 void setParameters(java.util.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

public static final java.lang.String INPUT_BUNDLE_NAME
See Also:
Constant Field Values

OUTPUT_BUNDLE_NAME

public static final java.lang.String OUTPUT_BUNDLE_NAME
See Also:
Constant Field Values

LANGUAGE_BUNDLE_NAME

public static final java.lang.String LANGUAGE_BUNDLE_NAME
See Also:
Constant Field Values

LANGUAGE_LOCALE

public static final java.lang.String LANGUAGE_LOCALE
See Also:
Constant Field Values

INPUT_LOCALE

public static final java.lang.String INPUT_LOCALE
See Also:
Constant Field Values

OUTPUT_LOCALE

public static final java.lang.String OUTPUT_LOCALE
See Also:
Constant Field Values

DEFAULT_FORMATTER

public static final java.lang.String DEFAULT_FORMATTER
See Also:
Constant Field Values
Method Detail

getRenderEngine

public RenderEngine getRenderEngine()
Returns the RenderEngine handling this request.

Returns:
engine RenderEngine handling the request within this context

setRenderEngine

public void setRenderEngine(RenderEngine engine)
Stores the current RenderEngine of the request

Parameters:
engine - Current RenderEnginge

get

public java.lang.Object get(java.lang.String key)

set

public void set(java.lang.String key,
                java.lang.Object value)

getParameters

public java.util.Map getParameters()

setParameters

public void setParameters(java.util.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

setCacheable

public void setCacheable(boolean cacheable)

commitCache

public void commitCache()

isCacheable

public boolean isCacheable()


Copyright © 2003 Matthias L. Jugel, Stephan J. Schmidt. All Rights Reserved.