@Singleton @Named public class DefaultSiteRenderer extends Object implements Renderer
DefaultSiteRenderer class.
Constructor and Description |
---|
DefaultSiteRenderer() |
Modifier and Type | Method and Description |
---|---|
protected void |
copyDirectory(File source,
File destination)
Copy the directory
|
void |
copyResources(SiteRenderingContext siteRenderingContext,
File outputDirectory)
Copy resource files from skin, template, and site resources.
|
void |
copyResources(SiteRenderingContext siteRenderingContext,
File resourcesDirectory,
File outputDirectory) |
SiteRenderingContext |
createContextForSkin(org.apache.maven.artifact.Artifact skin,
Map<String,?> attributes,
DecorationModel decoration,
String defaultTitle,
Locale locale)
Create a Site Rendering Context for a site using a skin.
|
protected org.apache.velocity.context.Context |
createDocumentVelocityContext(RenderingContext renderingContext,
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) |
Map<String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext) |
Map<String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext,
boolean editable)
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,
RenderingContext docRenderingContext,
SiteRenderingContext siteContext)
Render a document written in a Doxia markup language.
|
public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException
IOException
RendererException
public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext, boolean editable) throws IOException, RendererException
locateDocumentFiles
in interface Renderer
siteRenderingContext
- the SiteRenderingContext to useeditable
- Doxia document renderer as editable? (should not set editable if generated Doxia source)IOException
- if it bombs.RendererException
- if it bombs.public void render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory) throws RendererException, IOException
render
in interface Renderer
documents
- the documents to render.siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- the output directory to write results.RendererException
- if it bombs.IOException
- if it bombs.public void renderDocument(Writer writer, RenderingContext docRenderingContext, SiteRenderingContext siteContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
DoxiaDocumentRenderer
.renderDocument
in interface Renderer
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 contextRendererException
- if it bombs.FileNotFoundException
- if it bombs.UnsupportedEncodingException
- if it bombs.protected org.apache.velocity.context.Context createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext)
siteRenderingContext
- the site rendering contextprotected org.apache.velocity.context.Context createDocumentVelocityContext(RenderingContext renderingContext, SiteRenderingContext siteRenderingContext)
renderingContext
- the document's RenderingContextsiteRenderingContext
- the site rendering contextprotected org.apache.velocity.context.Context createSiteTemplateVelocityContext(DocumentContent content, SiteRenderingContext siteRenderingContext)
SiteRendererSink
during document rendering.content
- the document content to be merged into the templatesiteRenderingContext
- the site rendering contextpublic void generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
RendererException
public void mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext) throws RendererException
mergeDocumentIntoSite
in interface Renderer
writer
- the Writer to use.content
- the document content to be merged.siteRenderingContext
- the SiteRenderingContext to use.RendererException
- if it bombs.public SiteRenderingContext createContextForSkin(org.apache.maven.artifact.Artifact skin, Map<String,?> attributes, DecorationModel decoration, String defaultTitle, Locale locale) throws IOException, RendererException
createContextForSkin
in interface Renderer
skin
- a skinattributes
- attributes to usedecoration
- a decoration modeldefaultTitle
- default titlelocale
- locale to useIOException
- if it bombs.RendererException
- if it bombs.public void copyResources(SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory) throws IOException
IOException
public void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException
copyResources
in interface Renderer
siteRenderingContext
- the SiteRenderingContext to use.outputDirectory
- output directory as fileIOException
- if it bombs.protected void copyDirectory(File source, File destination) throws IOException
source
- source file to be copieddestination
- destination fileIOException
- if anyCopyright © 2005–2023 The Apache Software Foundation. All rights reserved.