fr.opensagres.xdocreport.document.preprocessor

Class AbstractXDocPreprocessor<T>

java.lang.Object

fr.opensagres.xdocreport.document.preprocessor.AbstractXDocPreprocessor<T>

All Implemented Interfaces:

IXDocPreprocessor

Direct Known Subclasses:

DOMPreprocessor, SAXXDocPreprocessor

public abstract class AbstractXDocPreprocessor<T>
extends java.lang.Object
implements IXDocPreprocessor

Abstract class for IXDocPreprocessor.

Constructor Summary

Constructors

Constructor and Description
AbstractXDocPreprocessor()

Method Summary

Modifier and Type	Method and Description
protected abstract void	closeSource(T reader)
boolean	create(java.lang.String entryName, XDocArchive outputArchive, FieldsMetadata fieldsMetadata, IDocumentFormatter formatter, java.util.Map<java.lang.String,java.lang.Object> sharedContext) Create the XML file identify with te entry name from the archive.
protected void	createAndProcess(java.lang.String entryName, XDocArchive outputArchive, FieldsMetadata fieldsMetadata, IDocumentFormatter formatter, java.util.Map<java.lang.String,java.lang.Object> sharedContext, java.io.InputStream input)
protected abstract T	getSource(XDocArchive documentArchive, java.lang.String entryName)
abstract boolean	preprocess(java.lang.String entryName, T reader, java.io.Writer writer, FieldsMetadata fieldsMetadata, IDocumentFormatter formater, java.util.Map<java.lang.String,java.lang.Object> context)
void	preprocess(java.lang.String entryName, XDocArchive documentArchive, FieldsMetadata fieldsMetadata, IDocumentFormatter formater, java.util.Map<java.lang.String,java.lang.Object> sharedContext) Modify the XML file identify with te entry name from the archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXDocPreprocessor

public AbstractXDocPreprocessor()

Method Detail

preprocess

public void preprocess(java.lang.String entryName,
                       XDocArchive documentArchive,
                       FieldsMetadata fieldsMetadata,
                       IDocumentFormatter formater,
                       java.util.Map<java.lang.String,java.lang.Object> sharedContext)
                throws XDocReportException,
                       java.io.IOException

Description copied from interface: IXDocPreprocessor

Modify the XML file identify with te entry name from the archive.

Specified by:

preprocess in interface IXDocPreprocessor

Parameters:

entryName - Zip entry name fo the XML file to modify.

documentArchive - the zip of the XML document.

fieldsMetadata - metdata fields.

sharedContext - shared context between the whole processor to execute. This Map can be used to share information between processors (according the order of the processor registration).

Throws:

XDocReportException

java.io.IOException

closeSource

protected abstract void closeSource(T reader)
                             throws XDocReportException,
                                    java.io.IOException

Throws:

XDocReportException

java.io.IOException

create

public boolean create(java.lang.String entryName,
                      XDocArchive outputArchive,
                      FieldsMetadata fieldsMetadata,
                      IDocumentFormatter formatter,
                      java.util.Map<java.lang.String,java.lang.Object> sharedContext)
               throws XDocReportException,
                      java.io.IOException

Description copied from interface: IXDocPreprocessor

Create the XML file identify with te entry name from the archive.

Specified by:

create in interface IXDocPreprocessor

Parameters:

entryName - Zip entry name fo the XML file to modify.

outputArchive - the zip of the XML document.

fieldsMetadata - metdata fields.

sharedContext - shared context between the whole processor to execute. This Map can be used to share information between processors (according the order of the processor registration).

Returns:

true if processing can create entry and false otherwise.

Throws:

XDocReportException

java.io.IOException

createAndProcess

protected void createAndProcess(java.lang.String entryName,
                                XDocArchive outputArchive,
                                FieldsMetadata fieldsMetadata,
                                IDocumentFormatter formatter,
                                java.util.Map<java.lang.String,java.lang.Object> sharedContext,
                                java.io.InputStream input)
                         throws java.io.IOException,
                                XDocReportException

Throws:

java.io.IOException

XDocReportException

preprocess

public abstract boolean preprocess(java.lang.String entryName,
                                   T reader,
                                   java.io.Writer writer,
                                   FieldsMetadata fieldsMetadata,
                                   IDocumentFormatter formater,
                                   java.util.Map<java.lang.String,java.lang.Object> context)
                            throws XDocReportException,
                                   java.io.IOException

Throws:

XDocReportException

java.io.IOException

getSource

protected abstract T getSource(XDocArchive documentArchive,
                               java.lang.String entryName)
                        throws XDocReportException,
                               java.io.IOException

Throws:

XDocReportException

java.io.IOException