Package adams.flow.transformer.pdfproclet

Class NewPage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.pdfproclet.AbstractPdfProclet

adams.flow.transformer.pdfproclet.NewPage

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PdfProclet, PdfProcletWithVariableFileExtension, Serializable

public class NewPage
extends AbstractPdfProclet
implements PdfProcletWithVariableFileExtension

Adds a new page whenever a file with the specified extension is processed.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-regexp-filename <adams.core.base.BaseRegExp> (property: regExpFilename)
    The regular expression that the filename must match.
    default: .*
 

-extension <adams.core.base.BaseString> [-extension ...] (property: extensions)
    The file extension(s) that the processor will be used for.
    default: *
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_Extensions	the file extensions.

Fields inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProclet

m_RegExpFilename, MATCH_ALL_EXTENSION

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

Method Summary

Modifier and Type	Method	Description
boolean	canProcess(PDFGenerator generator, Object obj)	Whether the processor can handle this particular object.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doProcess(PDFGenerator generator, File file)	The actual processing of the document.
protected boolean	doProcess(PDFGenerator generator, Object obj)	The actual processing of the document.
String	extensionsTipText()	Returns the tip text for this property.
BaseString[]	getExtensions()	Returns the extensions that the processor can process.
String	globalInfo()	Returns a short description of the writer.
void	setExtensions(BaseString[] value)	Sets the extensions that the processor can process.

Methods inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProclet

addColumnTextAt, addElement, canProcess, getRegExpFilename, postProcess, postProcess, preProcess, preProcess, process, process, regExpFilenameTipText, setRegExpFilename

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.transformer.pdfproclet.PdfProclet

canProcess, getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename

Field Detail

m_Extensions

protected BaseString[] m_Extensions

the file extensions.

Constructor Detail

NewPage

public NewPage()

Method Detail

globalInfo

public String globalInfo()

Returns a short description of the writer.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description of the writer

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractPdfProclet

getExtensions

public BaseString[] getExtensions()

Returns the extensions that the processor can process.

Specified by:

getExtensions in interface PdfProclet

Specified by:

getExtensions in interface PdfProcletWithVariableFileExtension

Specified by:

getExtensions in class AbstractPdfProclet

Returns:

the extensions (no dot)

setExtensions

public void setExtensions(BaseString[] value)

Sets the extensions that the processor can process.

Specified by:

setExtensions in interface PdfProcletWithVariableFileExtension

Parameters:

value - the extensions (no dot)

extensionsTipText

public String extensionsTipText()

Returns the tip text for this property.

Specified by:

extensionsTipText in interface PdfProcletWithVariableFileExtension

Returns:

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

doProcess

protected boolean doProcess(PDFGenerator generator,
                            File file)
                     throws Exception

The actual processing of the document.

Specified by:

doProcess in class AbstractPdfProclet

Parameters:

generator - the context

file - the file to add

Returns:

true if successfully added

Throws:

Exception - if something goes wrong

canProcess

public boolean canProcess(PDFGenerator generator,
                          Object obj)

Whether the processor can handle this particular object.

Specified by:

canProcess in interface PdfProclet

Specified by:

canProcess in class AbstractPdfProclet

Parameters:

generator - the context

obj - the object to check

Returns:

true if the object can be handled

doProcess

protected boolean doProcess(PDFGenerator generator,
                            Object obj)
                     throws Exception

The actual processing of the document.

Specified by:

doProcess in class AbstractPdfProclet

Parameters:

generator - the context

obj - the object to add

Returns:

true if successfully added

Throws:

Exception - if something goes wrong