org.jboss.jdocbook.render.impl

Class BasicRenderer

java.lang.Object

org.jboss.jdocbook.render.impl.BasicRenderer

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

PDFRenderer

public class BasicRenderer
extends Object
implements Renderer

The basic implementation of the Renderer contract.

Author:

Steve Ebersole

Field Summary

Fields

Modifier and Type	Field and Description
protected Options	options

Constructor Summary

Constructors

Constructor and Description
BasicRenderer(Options options) Construct a renderer instance using the given options.

Method Summary

Methods

Modifier and Type	Method and Description
protected Result	buildResult(File targetFile)
protected Transformer	buildTransformer(File targetFile, FormatPlan formatPlan, File stagingDirectory)
File	getAttachableBundle(File source)
protected void	releaseResult(Result transformationResult)
void	render(File sourceFile, FormatPlan formatPlan, File renderingDirectory, File stagingDirectory) Performs the actual rendering or transforming of the DocBook sources into the respective output format.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected final Options options

Constructor Detail

BasicRenderer

public BasicRenderer(Options options)

Construct a renderer instance using the given options.

Parameters:

options - The options.

Method Detail

getAttachableBundle

public File getAttachableBundle(File source)

Specified by:

getAttachableBundle in interface Renderer

render

public void render(File sourceFile,
          FormatPlan formatPlan,
          File renderingDirectory,
          File stagingDirectory)
            throws RenderingException,
                   XSLTException

Performs the actual rendering or transforming of the DocBook sources into the respective output format.

Specified by:

render in interface Renderer

Parameters:

sourceFile - The source DocBook file.

formatPlan - The formatting plan.

renderingDirectory - The directory into which to render

stagingDirectory - The directory where images resources were staged

Throws:

RenderingException - Problem writing the output file(s).

XSLTException - Problem performing XSL transformation.

buildTransformer

protected Transformer buildTransformer(File targetFile,
                           FormatPlan formatPlan,
                           File stagingDirectory)
                                throws RenderingException,
                                       XSLTException

Throws:

RenderingException

XSLTException

buildResult

protected Result buildResult(File targetFile)
                      throws RenderingException,
                             XSLTException

Throws:

RenderingException

XSLTException

releaseResult

protected void releaseResult(Result transformationResult)