Package adams.flow.transformer.pdfgenerate

Class Proclets

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.pdfgenerate.AbstractPDFGenerator

adams.flow.transformer.pdfgenerate.Proclets

All Implemented Interfaces:

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

public class Proclets
extends AbstractPDFGenerator

Processes an array of files using the specified PDF proclets.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PageOrientation	m_PageOrientation	the page orientation.
protected PageSize	m_PageSize	the page size.
protected PdfProclet[]	m_Proclets	the PDF processors.

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
Proclets()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	The type of data the generator accepts.
protected String	check(Object[] objects)	Hook method for checking the objects before processing them.
void	defineOptions()	Adds options to the internal list of options.
protected String	doProcess(Object[] objects, File outputFile)	Processes the objects to generate the PDF.
PageOrientation	getPageOrientation()	Returns the page orientation.
PageSize	getPageSize()	Returns the page size.
PdfProclet[]	getProclets()	Returns the processors in use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.
String	pageOrientationTipText()	Returns the tip text for this property.
String	pageSizeTipText()	Returns the tip text for this property.
String	procletsTipText()	Returns the tip text for this property.
void	setPageOrientation(PageOrientation value)	Sets the page orientation.
void	setPageSize(PageSize value)	Sets the page size.
void	setProclets(PdfProclet[] value)	Sets the processors for processing the files.

Methods inherited from class adams.flow.transformer.pdfgenerate.AbstractPDFGenerator

process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

m_PageSize

protected PageSize m_PageSize

the page size.

m_PageOrientation

protected PageOrientation m_PageOrientation

the page orientation.

m_Proclets

protected PdfProclet[] m_Proclets

the PDF processors.

Constructor Detail

Proclets

public Proclets()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPageSize

public void setPageSize(PageSize value)

Sets the page size.

Parameters:

value - the size

getPageSize

public PageSize getPageSize()

Returns the page size.

Returns:

the size

pageSizeTipText

public String pageSizeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPageOrientation

public void setPageOrientation(PageOrientation value)

Sets the page orientation.

Parameters:

value - the orientation

getPageOrientation

public PageOrientation getPageOrientation()

Returns the page orientation.

Returns:

the orientation

pageOrientationTipText

public String pageOrientationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setProclets

public void setProclets(PdfProclet[] value)

Sets the processors for processing the files.

Parameters:

value - the processors to use

getProclets

public PdfProclet[] getProclets()

Returns the processors in use.

Returns:

the processors in use

procletsTipText

public String procletsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractPDFGenerator

Returns:

null if no info available, otherwise short string

check

protected String check(Object[] objects)

Hook method for checking the objects before processing them.

Overrides:

check in class AbstractPDFGenerator

Parameters:

objects - the objects to check

Returns:

null if successful, otherwise error message

accepts

public Class[] accepts()

The type of data the generator accepts.

Specified by:

accepts in class AbstractPDFGenerator

Returns:

the classes

doProcess

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

Processes the objects to generate the PDF.

Specified by:

doProcess in class AbstractPDFGenerator

Parameters:

objects - the objects to process

outputFile - the output file to generate

Returns:

null if successful, otherwise error message