org.apache.maven.doxia.siterenderer
Class DefaultSiteRenderer

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

All Implemented Interfaces:

Renderer, org.codehaus.plexus.logging.LogEnabled

public class DefaultSiteRenderer
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements Renderer

Version:

$Id:DefaultSiteRenderer.java 348612 2005-11-24 12:54:19 +1100 (Thu, 24 Nov 2005) brett $

Author:

Emmanuel Venisse, Vincent Siveton

Field Summary

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

ROLE

Constructor Summary

DefaultSiteRenderer()

Method Summary

protected void	copyDirectory(java.io.File source, java.io.File destination) Copy the directory
void	copyResources(SiteRenderingContext siteContext, java.io.File resourcesDirectory, java.io.File outputDirectory)
SiteRenderingContext	createContextForSkin(java.io.File skinFile, java.util.Map attributes, org.apache.maven.doxia.site.decoration.DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale)
SiteRenderingContext	createContextForTemplate(java.io.File templateFile, java.io.File skinFile, java.util.Map attributes, org.apache.maven.doxia.site.decoration.DecorationModel decoration, java.lang.String defaultWindowTitle, java.util.Locale locale)
void	generateDocument(java.io.Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext)
java.util.Map	locateDocumentFiles(SiteRenderingContext siteRenderingContext)
void	render(java.util.Collection documents, SiteRenderingContext siteRenderingContext, java.io.File outputDirectory)
void	renderDocument(java.io.Writer writer, org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext renderingContext, SiteRenderingContext context)

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(java.util.Collection documents,
                   SiteRenderingContext siteRenderingContext,
                   java.io.File outputDirectory)
            throws RendererException,
                   java.io.IOException

Specified by:

render in interface Renderer

Throws:

RendererException

java.io.IOException

locateDocumentFiles

public java.util.Map locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                  throws java.io.IOException,
                                         RendererException

Specified by:

locateDocumentFiles in interface Renderer

Throws:

java.io.IOException

RendererException

renderDocument

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

Specified by:

renderDocument in interface Renderer

Throws:

RendererException

java.io.FileNotFoundException

java.io.UnsupportedEncodingException

generateDocument

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

Specified by:

generateDocument in interface Renderer

Throws:

RendererException

createContextForSkin

public SiteRenderingContext createContextForSkin(java.io.File skinFile,
                                                 java.util.Map attributes,
                                                 org.apache.maven.doxia.site.decoration.DecorationModel decoration,
                                                 java.lang.String defaultWindowTitle,
                                                 java.util.Locale locale)
                                          throws java.io.IOException

Specified by:

createContextForSkin in interface Renderer

Throws:

java.io.IOException

createContextForTemplate

public SiteRenderingContext createContextForTemplate(java.io.File templateFile,
                                                     java.io.File skinFile,
                                                     java.util.Map attributes,
                                                     org.apache.maven.doxia.site.decoration.DecorationModel decoration,
                                                     java.lang.String defaultWindowTitle,
                                                     java.util.Locale locale)
                                              throws java.net.MalformedURLException

Specified by:

createContextForTemplate in interface Renderer

Throws:

java.net.MalformedURLException

copyResources

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

Specified by:

copyResources in interface Renderer

Throws:

java.io.IOException

copyDirectory

protected void copyDirectory(java.io.File source,
                             java.io.File destination)
                      throws java.io.IOException

Copy the directory

Parameters:

source - source file to be copied

destination - destination file

Throws:

java.io.IOException - if any