org.apache.maven.doxia.docrenderer.pdf

Class AbstractPdfRenderer

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer

All Implemented Interfaces:

DocumentRenderer, PdfRenderer, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

FoPdfRenderer, ITextPdfRenderer

public abstract class AbstractPdfRenderer
extends AbstractDocumentRenderer
implements PdfRenderer

Abstract pdf renderer, this doesn't depend on the framework.

Since:

1.1

Author:

ltheussl

Field Summary

Fields inherited from class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

doxia, parserModuleManager

Fields inherited from interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractPdfRenderer()

Method Summary

Modifier and Type	Method and Description
String	getOutputExtension() Get the output extension associated with this DocumentRenderer.
void	render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess, File outputDirectory, org.apache.maven.doxia.document.DocumentModel documentModel) Render an aggregate document from the files found in a Map.

Methods inherited from class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer

copyDirectory, copyResources, endsWithIgnoreCase, endsWithIgnoreCase, getBaseDir, getExtensions, getFilesToProcess, getFilesToProcess, getOutputName, parse, parse, readDocumentModel, render, render, render, render, render, render, renderIndividual, renderIndividual, setBaseDir

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.pdf.PdfRenderer

generatePdf

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

readDocumentModel, render, render

Constructor Detail

AbstractPdfRenderer

public AbstractPdfRenderer()

Method Detail

getOutputExtension

public String getOutputExtension()

Get the output extension associated with this DocumentRenderer.

Specified by:

getOutputExtension in interface DocumentRenderer

Returns:

the ouput extension.

render

public void render(Map<String,org.apache.maven.doxia.parser.module.ParserModule> filesToProcess,
                   File outputDirectory,
                   org.apache.maven.doxia.document.DocumentModel documentModel)
            throws DocumentRendererException,
                   IOException

Render an aggregate document from the files found in a Map.

Specified by:

render in class AbstractDocumentRenderer

Parameters:

filesToProcess - the Map of Files to process. The Map should contain as keys the paths of the source files (relative to baseDir), and the corresponding ParserModule as values.

outputDirectory - the output directory where the aggregate document should be generated.

documentModel - the document model, containing all the metadata, etc.

Throws:

DocumentRendererException - if any

IOException - if any