org.apache.maven.doxia.siterenderer
Class DefaultSiteRenderer

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled, Renderer

public class DefaultSiteRenderer

extends org.codehaus.plexus.logging.AbstractLogEnabled

implements Renderer

DefaultSiteRenderer class.

Since:

1.0

Version:

$Id: DefaultSiteRenderer.java 772924 2009-05-08 10:22:12Z vsiveton $

Author:

Emmanuel Venisse, Vincent Siveton

Plexus component:

role-hint:

"default"

Field Summary

Fields inherited from interface org.apache.maven.doxia.siterenderer.Renderer

ROLE

Constructor Summary

DefaultSiteRenderer()

Method Summary

protected void	copyDirectory(File source, File destination) Copy the directory
void	copyResources(SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory) Copy resource files.
SiteRenderingContext	createContextForSkin(File skinFile, Map attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) Return a SiteRenderingContext.
SiteRenderingContext	createContextForTemplate(File templateFile, File skinFile, Map attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) Return a SiteRenderingContext.
void	generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) Generate a document.
Map	locateDocumentFiles(SiteRenderingContext siteRenderingContext) Return the document files in a Map.
void	render(Collection documents, SiteRenderingContext siteRenderingContext, File outputDirectory) Render a collection of documents.
void	renderDocument(Writer writer, org.apache.maven.doxia.sink.render.RenderingContext renderingContext, SiteRenderingContext context) Render a document.

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSiteRenderer

public DefaultSiteRenderer()

Method Detail

render

public void render(Collection documents,
                   SiteRenderingContext siteRenderingContext,
                   File outputDirectory)
            throws RendererException,
                   IOException

Render a collection of documents.

Specified by:

render in interface Renderer

Parameters:

documents - the documents to render.

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - the output directory to write results.

Throws:

RendererException - if it bombs.

IOException - if it bombs.

locateDocumentFiles

public Map locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                        throws IOException,
                               RendererException

Return the document files in a Map.

Specified by:

locateDocumentFiles in interface Renderer

Parameters:

siteRenderingContext -

Returns:

the document files in a Map.

Throws:

IOException - if it bombs.

RendererException - if it bombs.

renderDocument

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

Render a document.

Specified by:

renderDocument in interface Renderer

Parameters:

writer -

renderingContext -

context -

Throws:

UnsupportedEncodingException - if it bombs.

FileNotFoundException - if it bombs.

RendererException - if it bombs.

generateDocument

public void generateDocument(Writer writer,
                             SiteRendererSink sink,
                             SiteRenderingContext siteRenderingContext)
                      throws RendererException

Generate a document.

Specified by:

generateDocument in interface Renderer

Parameters:

writer - the Writer to use.

sink - the Sink to receive the events.

siteRenderingContext - the SiteRenderingContext to use.

Throws:

RendererException - if it bombs.

createContextForSkin

public SiteRenderingContext createContextForSkin(File skinFile,
                                                 Map attributes,
                                                 DecorationModel decoration,
                                                 String defaultWindowTitle,
                                                 Locale locale)
                                          throws IOException

Return a SiteRenderingContext.

Specified by:

createContextForSkin in interface Renderer

Parameters:

skinFile -

attributes -

decoration -

defaultWindowTitle -

locale -

Returns:

a SiteRenderingContext.

Throws:

IOException - if it bombs.

createContextForTemplate

public SiteRenderingContext createContextForTemplate(File templateFile,
                                                     File skinFile,
                                                     Map attributes,
                                                     DecorationModel decoration,
                                                     String defaultWindowTitle,
                                                     Locale locale)
                                              throws MalformedURLException

Return a SiteRenderingContext.

Specified by:

createContextForTemplate in interface Renderer

Parameters:

templateFile -

skinFile -

attributes -

decoration -

defaultWindowTitle -

locale -

Returns:

a SiteRenderingContext.

Throws:

MalformedURLException - if it bombs.

copyResources

public void copyResources(SiteRenderingContext siteRenderingContext,
                          File resourcesDirectory,
                          File outputDirectory)
                   throws IOException

Copy resource files.

Specified by:

copyResources in interface Renderer

Parameters:

siteRenderingContext -

resourcesDirectory -

outputDirectory -

Throws:

IOException - if it bombs.

copyDirectory

protected void copyDirectory(File source,
                             File destination)
                      throws IOException

Copy the directory

Parameters:

source - source file to be copied

destination - destination file

Throws:

IOException - if any