org.docx4j.convert.out.common

Class AbstractExporter<CS extends AbstractConversionSettings,CC extends AbstractConversionContext,PK extends OpcPackage>

java.lang.Object

org.docx4j.convert.out.common.AbstractExporter<CS,CC,PK>

All Implemented Interfaces:

Exporter<CS>

Direct Known Subclasses:

AbstractWmlExporter

public abstract class AbstractExporter<CS extends AbstractConversionSettings,CC extends AbstractConversionContext,PK extends OpcPackage>
extends Object
implements Exporter<CS>

Exporter are responsible to create the environment for the export process. They take care of the pre- and post processing (FORenderer). The conversion process itself is done with the …ExporterDelegate

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LocalLog

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExporter()

Method Summary

Modifier and Type	Method and Description
protected abstract CC	createContext(CS conversionSettings, PK preprocessedPackage, ConversionSectionWrappers sectionWrappers)
protected OutputStream	createIntermediateOutputStream(OutputStream outputStream)
protected abstract ConversionSectionWrappers	createWrappers(CS conversionSettings, PK preprocessedPackage)
void	export(CS conversionSettings, OutputStream outputStream)
protected long	logDebugStep(org.slf4j.Logger log, String stepLabel, long startTime)
protected void	postprocess(CS conversionSettings, AbstractConversionContext conversionContext, OutputStream intermediateOutputStream, OutputStream outputStream)
protected abstract PK	preprocess(CS conversionSettings)
protected abstract void	process(CS conversionSettings, CC conversionContext, OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Field Detail

LocalLog

protected static org.slf4j.Logger LocalLog

Constructor Detail

AbstractExporter

protected AbstractExporter()

Method Detail

export

public void export(CS conversionSettings,
                   OutputStream outputStream)
            throws Docx4JException

Specified by:

export in interface Exporter<CS extends AbstractConversionSettings>

Throws:

Docx4JException

logDebugStep

protected long logDebugStep(org.slf4j.Logger log,
                            String stepLabel,
                            long startTime)

preprocess

protected abstract PK preprocess(CS conversionSettings)
                          throws Docx4JException

Parameters:

conversionSettings -

Returns:

Throws:

Docx4JException

createWrappers

protected abstract ConversionSectionWrappers createWrappers(CS conversionSettings,
                                                            PK preprocessedPackage)
                                                     throws Docx4JException

Parameters:

conversionSettings -

preprocessedPackage -

Returns:

Throws:

Docx4JException

createContext

protected abstract CC createContext(CS conversionSettings,
                                    PK preprocessedPackage,
                                    ConversionSectionWrappers sectionWrappers)

Parameters:

conversionSettings -

preprocessedPackage -

sectionWrappers -

Returns:

createIntermediateOutputStream

protected OutputStream createIntermediateOutputStream(OutputStream outputStream)
                                               throws Docx4JException

Parameters:

outputStream -

Returns:

Throws:

Docx4JException

process

protected abstract void process(CS conversionSettings,
                                CC conversionContext,
                                OutputStream outputStream)
                         throws Docx4JException

Parameters:

conversionSettings -

conversionContext -

outputStream -

Throws:

Docx4JException

postprocess

protected void postprocess(CS conversionSettings,
                           AbstractConversionContext conversionContext,
                           OutputStream intermediateOutputStream,
                           OutputStream outputStream)
                    throws Docx4JException

Parameters:

conversionSettings -

conversionContext -

intermediateOutputStream -

outputStream -

Throws:

Docx4JException