com.canoo.webtest.plugins.pdftest
Class PdfToTextFilter

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.plugins.pdftest.AbstractPdfStep
                  com.canoo.webtest.plugins.pdftest.AbstractPdfFilter
                      com.canoo.webtest.plugins.pdftest.PdfToTextFilter

All Implemented Interfaces:

IContentFilter, Serializable, Cloneable

public class PdfToTextFilter
extends AbstractPdfFilter

Extracts all text content from within the current PDF document.

Author:

Paul King, Marc Guillemot

See Also:

Serialized Form

Field Summary

Fields inherited from class com.canoo.webtest.plugins.pdftest.AbstractPdfStep

ANY_PAGE

Fields inherited from class com.canoo.webtest.steps.Step

DEFAULT_DESCRIPTION, ELEMENT_ATTRIBUTE_ID, ELEMENT_ATTRIBUTE_NAME, PROPERTY_TYPE_ANT, PROPERTY_TYPE_ANT_STRICT, PROPERTY_TYPE_DEFAULT, PROPERTY_TYPE_DYNAMIC

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

PdfToTextFilter()

Method Summary

protected void	doFilter(PDFPage pdfPage)
String	getFragSep()
String	getLineSep()
String	getMode()
String	getPageSep()
void	setFragSep(String fragSep)
void	setLineSep(String lineSep)
void	setMode(String mode)
void	setPageSep(String pageSep)
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

Methods inherited from class com.canoo.webtest.plugins.pdftest.AbstractPdfFilter

doExecute

Methods inherited from class com.canoo.webtest.plugins.pdftest.AbstractPdfStep

getPdfPage

Methods inherited from class com.canoo.webtest.steps.Step

addComputedParameters, clone, emptyParamCheck, execute, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, getParameterDictionary, getStepLabel, getVerifier, getWebtestProperties, getWebtestProperties, getWebtestProperty, getWebtestProperty, handleException, hasDescription, integerParamCheck, isCompleted, isPerformingAction, isStarted, isSuccessful, notifyCompleted, notifyStarted, notifyStepResultsListeners, notifySuccess, nullParamCheck, nullResponseCheck, optionalIntegerParamCheck, paramCheck, positiveOrZeroParamCheck, setStepid, setWebtestProperty, setWebtestProperty, toString

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfToTextFilter

public PdfToTextFilter()

Method Detail

getPageSep

public String getPageSep()

setPageSep

public void setPageSep(String pageSep)

Parameters:

pageSep -

getLineSep

public String getLineSep()

setLineSep

public void setLineSep(String lineSep)

Parameters:

lineSep -

getFragSep

public String getFragSep()

setFragSep

public void setFragSep(String fragSep)

Parameters:

fragSep -

getMode

public String getMode()

setMode

public void setMode(String mode)

Parameters:

mode -

verifyParameters

protected void verifyParameters()

Description copied from class: Step

Called to let the step's implementation validate its parameters. The method is called after parameter extensions but before Step.doExecute(). This implementation does nothing, overwrite as needed.

Overrides:

verifyParameters in class Step

doFilter

protected void doFilter(PDFPage pdfPage)

Specified by:

doFilter in class AbstractPdfFilter