Package adams.flow.transformer.pdfproclet

Interface PdfProclet

All Superinterfaces:

Destroyable, OptionHandler

All Known Subinterfaces:

PdfProcletWithAbsolutePosition, PdfProcletWithFilenameOutput, PdfProcletWithOptionalAbsolutePosition, PdfProcletWithPageBreaks, PdfProcletWithVariableFileExtension

All Known Implementing Classes:

AbstractMetaPdfProclet, AbstractPdfProclet, AbstractPdfProcletWithFilenameOutput, AbstractPdfProcletWithPageBreaks, AbstractSpreadSheetPdfProclet, Circle, ConfusionMatrix, FixedText, Headline, Image, Line, MetaHeadline, NewPage, PlainText, Rectangle, SpreadSheet

public interface PdfProclet
extends OptionHandler

Interface for PDF proclets.

Version:

$Revision: 13483 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
boolean	canProcess(PDFGenerator generator, File file)	Whether the processor can handle this particular file.
boolean	canProcess(PDFGenerator generator, Object obj)	Whether the processor can handle this particular object.
BaseString[]	getExtensions()	Returns the extensions that the processor can process.
BaseRegExp	getRegExpFilename()	Returns the regular expression that the filename must match.
boolean	process(PDFGenerator generator, File file)	Processes the given file.
boolean	process(PDFGenerator generator, Object obj)	Processes the given object.
String	regExpFilenameTipText()	Returns the tip text for this property.
void	setRegExpFilename(BaseRegExp value)	Sets the regular expression that the filename must match.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

getExtensions

BaseString[] getExtensions()

Returns the extensions that the processor can process.

Returns:

the extensions (no dot)

setRegExpFilename

void setRegExpFilename(BaseRegExp value)

Sets the regular expression that the filename must match.

Parameters:

value - the expression

getRegExpFilename

BaseRegExp getRegExpFilename()

Returns the regular expression that the filename must match.

Returns:

the expression

regExpFilenameTipText

String regExpFilenameTipText()

Returns the tip text for this property.

Returns:

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

canProcess

boolean canProcess(PDFGenerator generator,
                   File file)

Whether the processor can handle this particular file.

Parameters:

generator - the context

file - the file to check

Returns:

true if the file can be handled

process

boolean process(PDFGenerator generator,
                File file)

Processes the given file.

Parameters:

generator - the context

file - the file to add

Returns:

true if successfully added

canProcess

boolean canProcess(PDFGenerator generator,
                   Object obj)

Whether the processor can handle this particular object.

Parameters:

generator - the context

obj - the object to check

Returns:

true if the object can be handled

process

boolean process(PDFGenerator generator,
                Object obj)

Processes the given object.

Parameters:

generator - the context

obj - the object to process

Returns:

true if successfully added