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 java.lang.Object
implements Renderer

The basic implementation of the Renderer contract.

Author:

Steve Ebersole

Field Summary

protected Options

options

Constructor Summary

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

Method Summary

protected javax.xml.transform.Result	buildResult(java.io.File targetFile)
protected javax.xml.transform.Transformer	buildTransformer(java.io.File targetFile, FormatPlan formatPlan, java.io.File stagingDirectory)
java.io.File	getAttachableBundle(java.io.File source)
protected void	releaseResult(javax.xml.transform.Result transformationResult)
void	render(java.io.File sourceFile, FormatPlan formatPlan, java.io.File renderingDirectory, java.io.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 java.io.File getAttachableBundle(java.io.File source)

Specified by:

getAttachableBundle in interface Renderer

render

public void render(java.io.File sourceFile,
                   FormatPlan formatPlan,
                   java.io.File renderingDirectory,
                   java.io.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 javax.xml.transform.Transformer buildTransformer(java.io.File targetFile,
                                                           FormatPlan formatPlan,
                                                           java.io.File stagingDirectory)
                                                    throws RenderingException,
                                                           XSLTException

Throws:

RenderingException

XSLTException

buildResult

protected javax.xml.transform.Result buildResult(java.io.File targetFile)
                                          throws RenderingException,
                                                 XSLTException

Throws:

RenderingException

XSLTException

releaseResult

protected void releaseResult(javax.xml.transform.Result transformationResult)