org.jbake.app

Class Renderer

java.lang.Object

org.jbake.app.Renderer

public class Renderer
extends Object

Render output to a file.

Author:

Jonathan Bullock

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Renderer.ModelRenderingConfig

Constructor Summary

Constructors

Constructor and Description
Renderer(ContentStore db, File destination, File templatesPath, org.apache.commons.configuration.CompositeConfiguration config) Creates a new instance of Renderer with supplied references to folders.

Method Summary

Methods

Modifier and Type	Method and Description
void	render(Map<String,Object> content) Render the supplied content to a file.
void	renderArchive(String archiveFile) Render an archive file using the supplied content.
void	renderFeed(String feedFile) Render an XML feed file using the supplied content.
void	renderIndex(String indexFile) Render an index file using the supplied content.
void	renderSitemap(String sitemapFile) Render an XML sitemap file using the supplied content.
int	renderTags(String tagPath) Render tag files using the supplied content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Renderer

public Renderer(ContentStore db,
        File destination,
        File templatesPath,
        org.apache.commons.configuration.CompositeConfiguration config)

Creates a new instance of Renderer with supplied references to folders.

Parameters:

db - The database holding the content

destination - The destination folder

templatesPath - The templates folder

config -

Method Detail

render

public void render(Map<String,Object> content)
            throws Exception

Render the supplied content to a file.

Parameters:

content - The content to renderDocument

Throws:

Exception

renderIndex

public void renderIndex(String indexFile)
                 throws Exception

Render an index file using the supplied content.

Parameters:

indexFile - The name of the output file

Throws:

Exception

renderSitemap

public void renderSitemap(String sitemapFile)
                   throws Exception

Render an XML sitemap file using the supplied content.

Throws:

Exception

See Also:

About Sitemaps, Sitemap protocol

renderFeed

public void renderFeed(String feedFile)
                throws Exception

Render an XML feed file using the supplied content.

Parameters:

feedFile - The name of the output file

Throws:

Exception

renderArchive

public void renderArchive(String archiveFile)
                   throws Exception

Render an archive file using the supplied content.

Parameters:

archiveFile - The name of the output file

Throws:

Exception

renderTags

public int renderTags(String tagPath)
               throws Exception

Render tag files using the supplied content.

Parameters:

tagPath - The output path

Throws:

Exception