@Component(role=Renderer.class) public class DefaultSiteRenderer extends org.codehaus.plexus.logging.AbstractLogEnabled 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)
Copy resource files.
|
SiteRenderingContext |
createContextForSkin(File skinFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Create a Site Rendering Context for a site using a skin.
|
SiteRenderingContext |
createContextForTemplate(File templateFile,
Map<String,?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
Locale locale)
Deprecated.
|
protected Context |
createDocumentVelocityContext(RenderingContext renderingContext,
SiteRenderingContext siteRenderingContext)
Create a Velocity Context for a Doxia document, containing every information about rendered document.
|
protected Context |
createSiteTemplateVelocityContext(SiteRendererSink siteRendererSink,
SiteRenderingContext siteRenderingContext)
Create a Velocity Context for the site template decorating the document.
|
protected 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)
Generate a document output from a Doxia SiteRenderer Sink.
|
Map<String,DocumentRenderer> |
locateDocumentFiles(SiteRenderingContext siteRenderingContext)
Locate Doxia document source files in the site source context.
|
void |
render(Collection<DocumentRenderer> documents,
SiteRenderingContext siteRenderingContext,
File outputDirectory)
Render a collection of documents into a site.
|
void |
renderDocument(Writer writer,
RenderingContext renderingContext,
SiteRenderingContext siteContext)
Render a document written in a Doxia markup language.
|
public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext) throws IOException, RendererException
locateDocumentFiles
in interface Renderer
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 renderingContext, SiteRenderingContext siteContext) throws RendererException, FileNotFoundException, UnsupportedEncodingException
DoxiaDocumentRenderer
.renderDocument
in interface Renderer
writer
- the writer to render the document to.renderingContext
- 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 Context createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext)
siteRenderingContext
- the site rendering contextprotected Context createDocumentVelocityContext(RenderingContext renderingContext, SiteRenderingContext siteRenderingContext)
sink
- the site renderer sink for the documentsiteRenderingContext
- the site rendering contextprotected Context createSiteTemplateVelocityContext(SiteRendererSink siteRendererSink, SiteRenderingContext siteRenderingContext)
SiteRendererSink
during document rendering.siteRendererSink
- the site renderer sink for the documentsiteRenderingContext
- the site rendering contextpublic void generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext) throws RendererException
generateDocument
in interface Renderer
writer
- the Writer to use.sink
- the Site Renderer Sink to receive the Doxia events.siteRenderingContext
- the SiteRenderingContext to use.RendererException
- if it bombs.public SiteRenderingContext createContextForSkin(File skinFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws IOException, RendererException
createContextForSkin
in interface Renderer
IOException
- if it bombs.RendererException
@Deprecated public SiteRenderingContext createContextForTemplate(File templateFile, Map<String,?> attributes, DecorationModel decoration, String defaultWindowTitle, Locale locale) throws MalformedURLException
createContextForTemplate
in interface Renderer
MalformedURLException
- if it bombs.Renderer.createContextForSkin(File, Map, DecorationModel, String, Locale)
public void copyResources(SiteRenderingContext siteRenderingContext, File resourcesDirectory, File outputDirectory) throws IOException
copyResources
in interface Renderer
IOException
- if it bombs.public void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException
copyResources
in interface Renderer
IOException
- if it bombs.protected void copyDirectory(File source, File destination) throws IOException
source
- source file to be copieddestination
- destination fileIOException
- if anyCopyright © 2005–2016 The Apache Software Foundation. All rights reserved.