Package org.radeox.engine

Class BaseRenderEngine

java.lang.Object

org.radeox.engine.BaseRenderEngine

All Implemented Interfaces:

org.radeox.api.engine.RenderEngine

public class BaseRenderEngine
extends Object
implements org.radeox.api.engine.RenderEngine

Base implementation of RenderEngine

Version:

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

Author:

Stephan J. Schmidt

Field Summary

Fields

Modifier and Type	Field	Description
protected FilterPipe	fp
protected org.radeox.api.engine.context.InitialRenderContext	initialContext

Constructor Summary

Constructors

Constructor	Description
BaseRenderEngine()
BaseRenderEngine(org.radeox.api.engine.context.InitialRenderContext context)

Method Summary

Modifier and Type	Method	Description
void	addMacro(org.radeox.api.macro.Macro macro)
String	getName()	Name of the RenderEngine.
protected void	init()
String	render(Reader in, org.radeox.api.engine.context.RenderContext context)	Render an input with text markup from a Reader and write the result to a writer
void	render(Writer out, String content, org.radeox.api.engine.context.RenderContext context)
String	render(String content, org.radeox.api.engine.context.RenderContext context)	Render an input with text markup and return a String with e.g.

Methods inherited from class java.lang.Object

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

Field Detail

initialContext

protected org.radeox.api.engine.context.InitialRenderContext initialContext

fp

protected FilterPipe fp

Constructor Detail

BaseRenderEngine

public BaseRenderEngine(org.radeox.api.engine.context.InitialRenderContext context)

BaseRenderEngine

public BaseRenderEngine()

Method Detail

init

protected void init()

getName

public String getName()

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

Specified by:

getName in interface org.radeox.api.engine.RenderEngine

Returns:

name Name of the engine

render

public String render(String content,
                     org.radeox.api.engine.context.RenderContext context)

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

Specified by:

render in interface org.radeox.api.engine.RenderEngine

Parameters:

content - String with the input to render

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

Returns:

result Output with rendered content

render

public String render(Reader in,
                     org.radeox.api.engine.context.RenderContext context)
              throws IOException

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

Specified by:

render in interface org.radeox.api.engine.RenderEngine

Parameters:

in - Reader to read the input from

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

Throws:

IOException

render

public void render(Writer out,
                   String content,
                   org.radeox.api.engine.context.RenderContext context)
            throws IOException

Specified by:

render in interface org.radeox.api.engine.RenderEngine

Throws:

IOException

addMacro

public void addMacro(org.radeox.api.macro.Macro macro)

Specified by:

addMacro in interface org.radeox.api.engine.RenderEngine