Class DefaultSiteRenderer
java.lang.Object
org.apache.maven.doxia.siterenderer.DefaultSiteRenderer
- All Implemented Interfaces:
Renderer
,SiteRenderer
DefaultSiteRenderer class.
- Since:
- 1.0
- Author:
- Emmanuel Venisse, Vincent Siveton
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
copyDirectory
(File source, File destination) Copy the directoryvoid
copyResources
(SiteRenderingContext siteRenderingContext, File outputDirectory) Copy resource files from skin, template, and site resources.createContextForSkin
(org.apache.maven.artifact.Artifact skin, Map<String, ?> attributes, org.apache.maven.doxia.site.SiteModel siteModel, String defaultTitle, Locale locale) Create a Site Rendering Context for a site using a skin.protected org.apache.velocity.context.Context
createDocumentVelocityContext
(DocumentRenderingContext docRenderingContext, SiteRenderingContext siteRenderingContext) Create a Velocity Context for a Doxia document, containing every information about rendered document.protected org.apache.velocity.context.Context
createSiteTemplateVelocityContext
(DocumentContent content, SiteRenderingContext siteRenderingContext) Create a Velocity Context for the site template decorating the document.protected org.apache.velocity.context.Context
createToolManagedVelocityContext
(SiteRenderingContext siteRenderingContext) Creates a Velocity Context with all generic tools configured wit the site rendering context.void
generateDocument
(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) locateDocumentFiles
(SiteRenderingContext siteRenderingContext) Locate Doxia document source files in the site source context.void
mergeDocumentIntoSite
(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) Generate a document output integrated in a site from a document content, i.e.void
render
(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) Render a collection of documents into a site.void
renderDocument
(Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext) Render a document written in a Doxia markup language.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.maven.doxia.siterenderer.SiteRenderer
locateDocumentFiles
-
Constructor Details
-
DefaultSiteRenderer
public DefaultSiteRenderer()
-
-
Method Details
-
locateDocumentFiles
public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException Locate Doxia document source files in the site source context.- Specified by:
locateDocumentFiles
in interfaceSiteRenderer
- Parameters:
siteRenderingContext
- the SiteRenderingContext to use- Returns:
- the Doxia document renderers in a Map keyed by output file path.
- Throws:
IOException
- if it bombs.RendererException
- if it bombs.
-
render
public void render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) throws RendererException, IOException Render a collection of documents into a site.- Specified by:
render
in interfaceSiteRenderer
- 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.
-
renderDocument
public void renderDocument(Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext) throws RendererException Render a document written in a Doxia markup language. This method is an internal method, used byDoxiaDocumentRenderer
.- Specified by:
renderDocument
in interfaceSiteRenderer
- Parameters:
writer
- the writer to render the document to.docRenderingContext
- the document's rendering context, which is expected to have a non-null parser id.siteContext
- the site's rendering context- Throws:
RendererException
- if it bombs.
-
createToolManagedVelocityContext
protected org.apache.velocity.context.Context createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext) Creates a Velocity Context with all generic tools configured wit the site rendering context.- Parameters:
siteRenderingContext
- the site rendering context- Returns:
- a Velocity tools managed context
-
createDocumentVelocityContext
protected org.apache.velocity.context.Context createDocumentVelocityContext(DocumentRenderingContext docRenderingContext, SiteRenderingContext siteRenderingContext) Create a Velocity Context for a Doxia document, containing every information about rendered document.- Parameters:
docRenderingContext
- the document's rendering contextsiteRenderingContext
- the site rendering context- Returns:
- a Velocity tools managed context
-
createSiteTemplateVelocityContext
protected org.apache.velocity.context.Context createSiteTemplateVelocityContext(DocumentContent content, SiteRenderingContext siteRenderingContext) Create a Velocity Context for the site template decorating the document. In addition to all the informations from the document, this context contains data gathered inSiteRendererSink
during document rendering.- Parameters:
content
- the document content to be merged into the templatesiteRenderingContext
- the site rendering context- Returns:
- a Velocity tools managed context
-
generateDocument
public void generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException - Throws:
RendererException
-
mergeDocumentIntoSite
public void mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) throws RendererException Generate a document output integrated in a site from a document content, i.e. merge the document content into the site template.- Specified by:
mergeDocumentIntoSite
in interfaceSiteRenderer
- Parameters:
writer
- the Writer to use.content
- the document content to be merged.siteRenderingContext
- the SiteRenderingContext to use.- Throws:
RendererException
- if it bombs.
-
createContextForSkin
public SiteRenderingContext createContextForSkin(org.apache.maven.artifact.Artifact skin, Map<String, ?> attributes, org.apache.maven.doxia.site.SiteModel siteModel, String defaultTitle, Locale locale) throws IOException, RendererExceptionCreate a Site Rendering Context for a site using a skin.- Specified by:
createContextForSkin
in interfaceSiteRenderer
- Parameters:
skin
- a skinattributes
- attributes to usesiteModel
- a site modeldefaultTitle
- default titlelocale
- locale to use- Returns:
- a SiteRenderingContext.
- Throws:
IOException
- if it bombs.RendererException
- if it bombs.
-
copyResources
public void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException Copy resource files from skin, template, and site resources.- Specified by:
copyResources
in interfaceSiteRenderer
- Parameters:
siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- output directory as file- Throws:
IOException
- if it bombs.
-
copyDirectory
Copy the directory- Parameters:
source
- source file to be copieddestination
- destination file- Throws:
IOException
- if any
-