|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentRenderer
Base interface for rendering documents from a set of input files.
Field Summary | |
---|---|
static String |
ROLE
Plexus lookup role. |
Method Summary | |
---|---|
String |
getOutputExtension()
Get the output extension associated with this DocumentRenderer. |
DocumentModel |
readDocumentModel(File documentDescriptor)
Read a document model from a file. |
void |
render(Collection<String> files,
File outputDirectory,
DocumentModel documentModel)
Render a document from a set of files, depending on a rendering context. |
void |
render(File baseDirectory,
File outputDirectory,
DocumentModel documentModel)
Render a document from the files found in a source directory, depending on a rendering context. |
Field Detail |
---|
static final String ROLE
Method Detail |
---|
void render(Collection<String> files, File outputDirectory, DocumentModel documentModel) throws DocumentRendererException, IOException
files
- the path name Strings (relative to a common base directory)
of files to include in the document generation.outputDirectory
- the output directory where the document should be generated.documentModel
- the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files from the Collection of files will be processed.
If the model is null, render all files individually.
DocumentRendererException
- if any.
IOException
- if any.void render(File baseDirectory, File outputDirectory, DocumentModel documentModel) throws DocumentRendererException, IOException
baseDirectory
- the directory containing the source files.
This should follow the standard Maven convention, ie containing all the site modules.outputDirectory
- the output directory where the document should be generated.documentModel
- the document model, containing all the metadata, etc.
If the model contains a TOC, only the files found in this TOC are rendered,
otherwise all files found under baseDirectory will be processed.
If the model is null, render all files from baseDirectory individually.
DocumentRendererException
- if any
IOException
- if any
// * @deprecated since 1.1.2, use #render(File, File, DocumentModel, DocumentRendererContext)
DocumentModel readDocumentModel(File documentDescriptor) throws DocumentRendererException, IOException
documentDescriptor
- a document descriptor file that contains the document model.
DocumentRendererException
- if any
IOException
- if anyString getOutputExtension()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |