org.nuiton.jrst

Class JrstSiteRenderer

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

org.nuiton.jrst.JrstSiteRenderer

All Implemented Interfaces:

org.apache.maven.doxia.siterenderer.Renderer, org.codehaus.plexus.logging.LogEnabled

@Component(role=org.apache.maven.doxia.siterenderer.Renderer.class,
           hint="default")
public class JrstSiteRenderer
extends org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Override of the DefaultSiteRenderer to add pdf generation of the site.

Since:

2.0

Author:

jpages, tchemit (chemit@codelutin.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PDF_FILENAME
protected AbstractJrstParser	jrstParser
protected Locale	locale Current locale used to render.
protected List<Locale>	locales All locales used to render sites.
protected org.apache.maven.project.MavenProject	mavenProject Current maven project to render.
protected boolean	pdfGenerationEnabled
protected boolean	verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JrstSiteRenderer()

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	buildDocMap(Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents)
protected Collection<String>	buildListPathsFromMenuItem(org.apache.maven.doxia.site.decoration.MenuItem item, Collection<String> paths)
protected boolean	getBooleanProperty(String propertyName)
protected List<String>	getDocumentRefs(Map<String,String> relatifPaths, List<String> relativPathsFromMenu)
protected List<String>	getDocumentRelativePathsFromMenu(org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)
protected String	getPdfFileName()
protected String	getStringProperty(String propertyName)
protected org.apache.velocity.context.Context	preparePdfVelocityContext(org.codehaus.plexus.i18n.I18N i18n, List<String> documentRefs)
void	render(Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext, File outputDirectory)
void	renderDocument(Writer writer, org.apache.maven.doxia.siterenderer.RenderingContext renderingContext, org.apache.maven.doxia.siterenderer.SiteRenderingContext context)
protected void	renderPdf(org.codehaus.plexus.i18n.I18N i18n, List<String> documentRefs, org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext, File outputDirectory, String pdfFilename)

Methods inherited from class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

copyDirectory, copyResources, copyResources, createContextForSkin, createContextForTemplate, createDocumentVelocityContext, createSiteTemplateVelocityContext, createToolManagedVelocityContext, generateDocument, locateDocumentFiles

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

Field Detail

DEFAULT_PDF_FILENAME

public static final String DEFAULT_PDF_FILENAME

See Also:

Constant Field Values

locales

protected List<Locale> locales

All locales used to render sites.

locale

protected Locale locale

Current locale used to render.

mavenProject

protected org.apache.maven.project.MavenProject mavenProject

Current maven project to render.

pdfGenerationEnabled

protected boolean pdfGenerationEnabled

verbose

protected boolean verbose

jrstParser

@Requirement(role=org.apache.maven.doxia.parser.Parser.class,
             hint="jrst",
             optional=true)
protected AbstractJrstParser jrstParser

Constructor Detail

JrstSiteRenderer

public JrstSiteRenderer()

Method Detail

render

public void render(Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents,
                   org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext,
                   File outputDirectory)
            throws org.apache.maven.doxia.siterenderer.RendererException,
                   IOException

Specified by:

render in interface org.apache.maven.doxia.siterenderer.Renderer

Overrides:

render in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Throws:

org.apache.maven.doxia.siterenderer.RendererException

IOException

renderDocument

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

Specified by:

renderDocument in interface org.apache.maven.doxia.siterenderer.Renderer

Overrides:

renderDocument in class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

Throws:

org.apache.maven.doxia.siterenderer.RendererException

FileNotFoundException

UnsupportedEncodingException

getPdfFileName

protected String getPdfFileName()

renderPdf

protected void renderPdf(org.codehaus.plexus.i18n.I18N i18n,
                         List<String> documentRefs,
                         org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext,
                         File outputDirectory,
                         String pdfFilename)
                  throws org.apache.maven.doxia.siterenderer.RendererException,
                         FileNotFoundException,
                         UnsupportedEncodingException

Throws:

org.apache.maven.doxia.siterenderer.RendererException

FileNotFoundException

UnsupportedEncodingException

preparePdfVelocityContext

protected org.apache.velocity.context.Context preparePdfVelocityContext(org.codehaus.plexus.i18n.I18N i18n,
                                                                        List<String> documentRefs)

getDocumentRelativePathsFromMenu

protected List<String> getDocumentRelativePathsFromMenu(org.apache.maven.doxia.siterenderer.SiteRenderingContext siteRenderingContext)

getDocumentRefs

protected List<String> getDocumentRefs(Map<String,String> relatifPaths,
                                       List<String> relativPathsFromMenu)

buildDocMap

protected Map<String,String> buildDocMap(Collection<org.apache.maven.doxia.siterenderer.DocumentRenderer> documents)

buildListPathsFromMenuItem

protected Collection<String> buildListPathsFromMenuItem(org.apache.maven.doxia.site.decoration.MenuItem item,
                                                        Collection<String> paths)

getStringProperty

protected String getStringProperty(String propertyName)

getBooleanProperty

protected boolean getBooleanProperty(String propertyName)