org.apache.maven.doxia.siterenderer

Interface Renderer

All Known Implementing Classes:

DefaultSiteRenderer

public interface Renderer

Renderer interface.

Version:

$Id: Renderer.java 1087124 2011-03-30 22:45:41Z hboutemy $

Author:

Emmanuel Venisse

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROLE Plexus lookup role.

Method Summary

Modifier and Type	Method and Description
void	copyResources(SiteRenderingContext siteRenderingContext, java.io.File resourcesDirectory, java.io.File outputDirectory) Copy resource files.
SiteRenderingContext	createContextForSkin(java.io.File skinFile, java.util.Map<java.lang.String,?> attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) Return a SiteRenderingContext.
SiteRenderingContext	createContextForTemplate(java.io.File templateFile, java.io.File skinFile, java.util.Map<java.lang.String,?> attributes, DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale) Return a SiteRenderingContext.
void	generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) Generate a document.
java.util.Map<java.lang.String,DocumentRenderer>	locateDocumentFiles(SiteRenderingContext siteRenderingContext) Return the document files in a Map.
void	render(java.util.Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory) Render a collection of documents.
void	renderDocument(java.io.Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext context) Render a document.

Field Detail

ROLE

static final java.lang.String ROLE

Plexus lookup role.

Method Detail

render

void render(java.util.Collection<DocumentRenderer> documents,
            SiteRenderingContext siteRenderingContext,
            java.io.File outputDirectory)
     throws RendererException,
            java.io.IOException

Render a collection of documents.

Parameters:

documents - the documents to render.

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - the output directory to write results.

Throws:

RendererException - if it bombs.

java.io.IOException - if it bombs.

generateDocument

void generateDocument(java.io.Writer writer,
                      SiteRendererSink sink,
                      SiteRenderingContext siteRenderingContext)
               throws RendererException

Generate a document.

Parameters:

writer - the Writer to use.

sink - the Sink to receive the events.

siteRenderingContext - the SiteRenderingContext to use.

Throws:

RendererException - if it bombs.

createContextForSkin

SiteRenderingContext createContextForSkin(java.io.File skinFile,
                                          java.util.Map<java.lang.String,?> attributes,
                                          DecorationModel decoration,
                                          java.lang.String defaultWindowTitle,
                                          java.util.Locale locale)
                                   throws java.io.IOException

Return a SiteRenderingContext.

Parameters:

skinFile -

attributes -

decoration -

defaultWindowTitle -

locale -

Returns:

a SiteRenderingContext.

Throws:

java.io.IOException - if it bombs.

createContextForTemplate

SiteRenderingContext createContextForTemplate(java.io.File templateFile,
                                              java.io.File skinFile,
                                              java.util.Map<java.lang.String,?> attributes,
                                              DecorationModel decoration,
                                              java.lang.String defaultWindowTitle,
                                              java.util.Locale locale)
                                       throws java.net.MalformedURLException

Return a SiteRenderingContext.

Parameters:

templateFile -

skinFile -

attributes -

decoration -

defaultWindowTitle -

locale -

Returns:

a SiteRenderingContext.

Throws:

java.net.MalformedURLException - if it bombs.

copyResources

void copyResources(SiteRenderingContext siteRenderingContext,
                   java.io.File resourcesDirectory,
                   java.io.File outputDirectory)
            throws java.io.IOException

Copy resource files.

Parameters:

siteRenderingContext -

resourcesDirectory -

outputDirectory -

Throws:

java.io.IOException - if it bombs.

locateDocumentFiles

java.util.Map<java.lang.String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                                              throws java.io.IOException,
                                                                     RendererException

Return the document files in a Map.

Parameters:

siteRenderingContext -

Returns:

the document files in a Map.

Throws:

java.io.IOException - if it bombs.

RendererException - if it bombs.

renderDocument

void renderDocument(java.io.Writer writer,
                    org.apache.maven.doxia.sink.render.RenderingContext renderingContext,
                    SiteRenderingContext context)
             throws RendererException,
                    java.io.FileNotFoundException,
                    java.io.UnsupportedEncodingException

Render a document.

Parameters:

writer - the writer to render the document to.

renderingContext - the document's rendering context

context - the site's rendering context

Throws:

RendererException - if it bombs.

java.io.FileNotFoundException - if it bombs.

java.io.UnsupportedEncodingException - if it bombs.