org.radeox.api.engine

Interface RenderEngine

public interface RenderEngine

Interface for RenderEngines. A RenderEngine renders a input string to an output string with the help of filters.

Version:

$Id$

Author:

Stephan J. Schmidt

Method Summary

Modifier and Type	Method and Description
void	addMacro(Macro macro) Add a macro to the render engine, this can be performed from a component or a webapp and will be keyed on its name.
String	getName() Name of the RenderEngine.
String	render(Reader in, RenderContext context) Render an input with text markup from a Reader and write the result to a writer
String	render(String content, RenderContext context) Render an input with text markup and return a String with e.g.
void	render(Writer out, String content, RenderContext context) Render an input with text markup and an write the result e.g.

Method Detail

getName

String getName()

Name of the RenderEngine. This is used to get a RenderEngine instance with EngineManager.getInstance(name);

Returns:

name Name of the engine

render

String render(String content,
              RenderContext context)

Render an input with text markup and return a String with e.g. HTML

Parameters:

content - String with the input to render

context - Special context for the render engine, e.g. with configuration information

Returns:

result Output with rendered content

render

void render(Writer out,
            String content,
            RenderContext context)
     throws IOException

Render an input with text markup and an write the result e.g. HTML to a writer

Parameters:

out - Writer to write the output to

content - String with the input to render

context - Special context for the render engine, e.g. with configuration information

Throws:

IOException

render

String render(Reader in,
              RenderContext context)
       throws IOException

Render an input with text markup from a Reader and write the result to a writer

Parameters:

in - Reader to read the input from

context - Special context for the render engine, e.g. with configuration information

Throws:

IOException

addMacro

void addMacro(Macro macro)

Add a macro to the render engine, this can be performed from a component or a webapp and will be keyed on its name. If the webapp is reloaded, the macro will be replaced. When a webapp is unloaded it will be removed from the engine.

Parameters:

macro -