org.apache.maven.doxia.docrenderer.itext
Class AbstractITextRender

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.doxia.docrenderer.itext.AbstractITextRender

All Implemented Interfaces:

DocRenderer, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

DefaultPdfRenderer, DefaultRtfRenderer

public abstract class AbstractITextRender
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements DocRenderer

Abstract document render with the iText framework

Version:

$Id: AbstractITextRender.java 571131 2007-08-30 12:24:21Z vsiveton $

Author:

Vincent Siveton

Field Summary

private static javax.xml.parsers.DocumentBuilderFactory	DOCUMENT_BUILDER_FACTORY
protected org.apache.maven.doxia.Doxia	doxia
protected org.apache.maven.doxia.module.site.manager.SiteModuleManager	siteModuleManager
private static javax.xml.transform.TransformerFactory	TRANSFORMER_FACTORY
private static java.lang.String	XSLT_RESOURCE

Fields inherited from interface org.apache.maven.doxia.docrenderer.DocRenderer

ROLE

Constructor Summary

AbstractITextRender()

Method Summary

private void	addTransformerParameters(javax.xml.transform.Transformer transformer, org.apache.maven.doxia.docrenderer.document.DocumentModel documentModel) Add transformer parameters
private org.w3c.dom.Document	generateDocument(java.util.List iTextFiles) Merge all iTextFiles to a single one
abstract void	generateOutput(java.io.File iTextFile, java.io.File iTextOutput) Generate an ouput file with the iText framework
private javax.xml.transform.Transformer	initTransformer() Init the transformer object
private void	parse(java.lang.String fullPathDoc, org.apache.maven.doxia.module.site.SiteModule module, java.io.File outputITextFile) Parse a sink
void	render(java.io.File siteDirectory, java.io.File outputDirectory) Render all files from a site directory to an output directory
void	render(java.io.File siteDirectory, java.io.File outputDirectory, java.io.File documentDescriptor) Render a document depending a context and a document descriptor
private void	transform(org.apache.maven.doxia.docrenderer.document.DocumentModel documentModel, org.w3c.dom.Document document, java.io.File iTextFile) Transform a document to an iTextFile

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.doxia.docrenderer.DocRenderer

getOutputExtension

Field Detail

XSLT_RESOURCE

private static java.lang.String XSLT_RESOURCE

TRANSFORMER_FACTORY

private static final javax.xml.transform.TransformerFactory TRANSFORMER_FACTORY

DOCUMENT_BUILDER_FACTORY

private static final javax.xml.parsers.DocumentBuilderFactory DOCUMENT_BUILDER_FACTORY

siteModuleManager

protected org.apache.maven.doxia.module.site.manager.SiteModuleManager siteModuleManager

doxia

protected org.apache.maven.doxia.Doxia doxia

Constructor Detail

AbstractITextRender

public AbstractITextRender()

Method Detail

render

public void render(java.io.File siteDirectory,
                   java.io.File outputDirectory)
            throws DocRendererException,
                   java.io.IOException

Description copied from interface: DocRenderer

Render all files from a site directory to an output directory

Specified by:

render in interface DocRenderer

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where files are generated

Throws:

DocRendererException - if any

java.io.IOException - if any

See Also:

DocRenderer.render(java.io.File, java.io.File)

render

public void render(java.io.File siteDirectory,
                   java.io.File outputDirectory,
                   java.io.File documentDescriptor)
            throws DocRendererException,
                   java.io.IOException

Description copied from interface: DocRenderer

Render a document depending a context and a document descriptor

Specified by:

render in interface DocRenderer

Parameters:

siteDirectory - the input directory contains files to be generated

outputDirectory - the output directory where file are generated

documentDescriptor - the document descriptor

Throws:

DocRendererException - if any

java.io.IOException - if any

See Also:

DocRenderer.render(java.io.File, java.io.File, java.io.File)

generateOutput

public abstract void generateOutput(java.io.File iTextFile,
                                    java.io.File iTextOutput)
                             throws DocRendererException,
                                    java.io.IOException

Generate an ouput file with the iText framework

Parameters:

iTextFile -

iTextOutput -

Throws:

DocRendererException - if any

java.io.IOException - if any

parse

private void parse(java.lang.String fullPathDoc,
                   org.apache.maven.doxia.module.site.SiteModule module,
                   java.io.File outputITextFile)
            throws DocRendererException,
                   java.io.IOException

Parse a sink

Parameters:

fullPathDoc -

module -

outputITextFile -

Throws:

DocRendererException

java.io.IOException

generateDocument

private org.w3c.dom.Document generateDocument(java.util.List iTextFiles)
                                       throws DocRendererException,
                                              java.io.IOException

Merge all iTextFiles to a single one

Parameters:

iTextFiles -

Returns:

a document

Throws:

DocRendererException - if any

java.io.IOException - if any

initTransformer

private javax.xml.transform.Transformer initTransformer()
                                                 throws DocRendererException

Init the transformer object

Returns:

an instanced transformer object

Throws:

DocRendererException - if any

addTransformerParameters

private void addTransformerParameters(javax.xml.transform.Transformer transformer,
                                      org.apache.maven.doxia.docrenderer.document.DocumentModel documentModel)

Add transformer parameters

Parameters:

transformer -

documentModel -

transform

private void transform(org.apache.maven.doxia.docrenderer.document.DocumentModel documentModel,
                       org.w3c.dom.Document document,
                       java.io.File iTextFile)
                throws DocRendererException

Transform a document to an iTextFile

Parameters:

documentModel -

document -

iTextFile -

Throws:

DocRendererException