Package adams.flow.transformer.pdfgenerate

Class AbstractPDFGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.pdfgenerate.AbstractPDFGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractScript, AbstractScriptedPDFGenerator, Proclets

public abstract class AbstractPDFGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for schemes to generate PDFs.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractPDFGenerator()

Method Summary

Modifier and Type	Method	Description
abstract Class[]	accepts()	The type of data the generator accepts.
protected String	check(Object[] objects)	Hook method for checking the objects before processing them.
protected abstract String	doProcess(Object[] objects, File outputFile)	Processes the objects to generate the PDF.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	process(Object[] objects, File outputFile)	Processes the objects to generate the PDF.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractPDFGenerator

public AbstractPDFGenerator()

Method Detail

accepts

public abstract Class[] accepts()

The type of data the generator accepts.

Returns:

the classes

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(Object[] objects)

Hook method for checking the objects before processing them.
Default implementation does nothing.

Parameters:

objects - the objects to check

Returns:

null if successful, otherwise error message

doProcess

protected abstract String doProcess(Object[] objects,
                                    File outputFile)

Processes the objects to generate the PDF.

Parameters:

objects - the objects to process

outputFile - the output file to generate

Returns:

null if successful, otherwise error message

process

public String process(Object[] objects,
                      File outputFile)

Processes the objects to generate the PDF.

Parameters:

objects - the objects to process

outputFile - the output file to generate

Returns:

null if successful, otherwise error message