org.radeox.api.engine
Interface RenderEngine

All Known Implementing Classes:
BaseRenderEngine

public interface RenderEngine

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


Method Summary
 InitialRenderContext getInitialRenderContext()
          Return the InitialRenderContext of the RenderEngine
 java.lang.String getName()
          Name of the RenderEngine.
 java.lang.String render(java.io.Reader in, RenderContext context)
          Render an input with text markup from a Reader and write the result to a writer
 java.lang.String render(java.lang.String content, RenderContext context)
          Render an input with text markup and return a String with e.g.
 void render(java.io.Writer out, java.lang.String content, RenderContext context)
          Render an input with text markup and an write the result e.g.
 

Method Detail

getName

java.lang.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

java.lang.String render(java.lang.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(java.io.Writer out,
            java.lang.String content,
            RenderContext context)
            throws java.io.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:
java.io.IOException

render

java.lang.String render(java.io.Reader in,
                        RenderContext context)
                        throws java.io.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:
java.io.IOException

getInitialRenderContext

InitialRenderContext getInitialRenderContext()
Return the InitialRenderContext of the RenderEngine

Returns:
initialRenderContext of the RenderEngine