PSEK-Fitnesse-Fixtures

A fixture that can read a PDF file (local or from a url) and extract text from it. More...

Public Member Functions
	PdfTextReaderFixture ()
	Instantiates a new Pdf text reader fixture. More...

void	closePdf ()
	Close pdf. More...

boolean	loadPdfFromBase64String (String base64Encoded)
	Load pdf from base 64 string boolean. More...

boolean	loadPdfFromDatabase (String databaseDriver, String url, String username, String password, String sql)
	Load pdf from database boolean. More...

boolean	loadPdfFromFile (String file)
	Load pdf from file boolean. More...

boolean	loadPdfFromStream (InputStream is)
	Load pdf from stream boolean. More...

boolean	loadPdfFromUrl (String url)
	Load pdf from url boolean. More...

boolean	loadPdfFromUrl (String url, final String username, String password)
	Load pdf from url boolean. More...

boolean	pdfContainsTextBetweenOnPage (int page, String fromText, String toText, String expectedText)
	Pdf contains text between on page boolean. More...

boolean	pdfContainsTextBetweenOnPageInsideBlock (int page, String fromText, int fromTextBlockNr, String toText, String expectedText)
	Pdf contains text between on page inside block boolean. More...

boolean	pdfContainsTextLine (String text)
	Pdf contains text line boolean. More...

boolean	pdfContainsTextLineCaseInsensitive (String text)
	Pdf contains text line case insensitive boolean. More...

boolean	pdfContainsTextLineThatContainsText (String text)
	Pdf contains text line that contains text boolean. More...

boolean	pdfContainsTextLineWithPrefix (String prefix)
	Pdf contains text line with prefix boolean. More...

boolean	pdfContainsTextLineWithSuffix (String suffix)
	Controleert of een regel met de aangeleverde eindigt. More...

boolean	pdfContainsTextOnPage (int page, String expectedText)
	Pdf contains text on page boolean. More...

int	pdfCountTextPresence (String expectedText)
	Pdf count text presence int. More...

boolean	pdfNotContainsTextBetweenOnPage (int page, String fromText, String toText, String unexpectedText)
	Pdf not contains text between on page boolean. More...

String	pdfToString (boolean sortByPosition)
	Pdf to string string. More...

String[]	pdfToTextLines ()
	Pdf to text lines string [ ]. More...

void	writePdfToFile (String filename)
	Write pdf to file. More...

Private Attributes
PDDocument	pdf = null

Static Private Attributes
static final String	ERROR_LOADING_DOCUMENT = "Error loading PDF document '%s', the following exception occurred '%s'"

Detailed Description

A fixture that can read a PDF file (local or from a url) and extract text from it.

Definition at line 23 of file PdfTextReaderFixture.java.

Constructor & Destructor Documentation

◆ PdfTextReaderFixture()

nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.PdfTextReaderFixture ( )

Instantiates a new Pdf text reader fixture.

Definition at line 32 of file PdfTextReaderFixture.java.

Member Function Documentation

◆ closePdf()

void nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.closePdf ( )

Close pdf.

Definition at line 150 of file PdfTextReaderFixture.java.

◆ loadPdfFromBase64String()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromBase64String ( String base64Encoded )

Load pdf from base 64 string boolean.

Parameters

base64Encoded the base 64 encoded

Returns: the boolean

Definition at line 116 of file PdfTextReaderFixture.java.

◆ loadPdfFromDatabase()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromDatabase	(	String	databaseDriver,
		String	url,
		String	username,
		String	password,
		String	sql
	)

Load pdf from database boolean.

Parameters

databaseDriver	the database driver
url	the URL to connect to, provided als plain text or with prefix 'p:' with a string that points to a System.property
username	the username, provided als plain text or with prefix 'p:' with a string that points to a System.property
password	the password , provided als plain text or with prefix 'p:' with a string that points to a System.property
sql	the sql

Returns: the boolean

Definition at line 134 of file PdfTextReaderFixture.java.

◆ loadPdfFromFile()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromFile ( String file )

Load pdf from file boolean.

Parameters

file the file

Returns: the boolean

Definition at line 43 of file PdfTextReaderFixture.java.

◆ loadPdfFromStream()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromStream ( InputStream is )

Load pdf from stream boolean.

Parameters

is the is

Returns: the boolean

Definition at line 99 of file PdfTextReaderFixture.java.

◆ loadPdfFromUrl() [1/2]

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromUrl ( String url )

Load pdf from url boolean.

Parameters

url the url

Returns: the boolean

Definition at line 60 of file PdfTextReaderFixture.java.

◆ loadPdfFromUrl() [2/2]

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.loadPdfFromUrl	(	String	url,
		final String	username,
		String	password
	)

Load pdf from url boolean.

Parameters

url	the url
username	the username
password	the password

Returns: the boolean

Definition at line 78 of file PdfTextReaderFixture.java.

◆ pdfContainsTextBetweenOnPage()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextBetweenOnPage	(	int	page,
		String	fromText,
		String	toText,
		String	expectedText
	)

Pdf contains text between on page boolean.

Parameters

page	the page
fromText	the from text
toText	the to text
expectedText	the expected text

Returns: the boolean

Definition at line 276 of file PdfTextReaderFixture.java.

◆ pdfContainsTextBetweenOnPageInsideBlock()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextBetweenOnPageInsideBlock	(	int	page,
		String	fromText,
		int	fromTextBlockNr,
		String	toText,
		String	expectedText
	)

Pdf contains text between on page inside block boolean.

Parameters

page	the page
fromText	the from text
fromTextBlockNr	the from text block nr
toText	the to text
expectedText	the expected text

Returns: the boolean

Definition at line 295 of file PdfTextReaderFixture.java.

◆ pdfContainsTextLine()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextLine ( String text )

Pdf contains text line boolean.

Parameters

text the text

Returns: the boolean

Definition at line 198 of file PdfTextReaderFixture.java.

◆ pdfContainsTextLineCaseInsensitive()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextLineCaseInsensitive ( String text )

Pdf contains text line case insensitive boolean.

Parameters

text the text

Returns: the boolean

Definition at line 213 of file PdfTextReaderFixture.java.

◆ pdfContainsTextLineThatContainsText()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextLineThatContainsText ( String text )

Pdf contains text line that contains text boolean.

Parameters

text the text

Returns: the boolean

Definition at line 258 of file PdfTextReaderFixture.java.

◆ pdfContainsTextLineWithPrefix()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextLineWithPrefix ( String prefix )

Pdf contains text line with prefix boolean.

Parameters

prefix the prefix

Returns: the boolean

Definition at line 229 of file PdfTextReaderFixture.java.

◆ pdfContainsTextLineWithSuffix()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextLineWithSuffix ( String suffix )

Controleert of een regel met de aangeleverde eindigt.

Parameters

suffix the suffix

Returns: the boolean

Definition at line 243 of file PdfTextReaderFixture.java.

◆ pdfContainsTextOnPage()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfContainsTextOnPage	(	int	page,
		String	expectedText
	)

Pdf contains text on page boolean.

Parameters

page	the page
expectedText	the expected text

Returns: the boolean

Definition at line 329 of file PdfTextReaderFixture.java.

◆ pdfCountTextPresence()

int nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfCountTextPresence ( String expectedText )

Pdf count text presence int.

Parameters

expectedText the expected text

Returns: the int

Definition at line 344 of file PdfTextReaderFixture.java.

◆ pdfNotContainsTextBetweenOnPage()

boolean nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfNotContainsTextBetweenOnPage	(	int	page,
		String	fromText,
		String	toText,
		String	unexpectedText
	)

Pdf not contains text between on page boolean.

Parameters

page	the page
fromText	the from text
toText	the to text
unexpectedText	the unexpected text

Returns: the boolean

Definition at line 313 of file PdfTextReaderFixture.java.

◆ pdfToString()

String nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfToString ( boolean sortByPosition )

Pdf to string string.

Parameters

sortByPosition the sort by position

Returns: the string

Definition at line 166 of file PdfTextReaderFixture.java.

◆ pdfToTextLines()

String[] nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdfToTextLines ( )

Pdf to text lines string [ ].

Returns: the string [ ]

Definition at line 181 of file PdfTextReaderFixture.java.

◆ writePdfToFile()

void nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.writePdfToFile ( String filename )

Write pdf to file.

Parameters

filename the filename

Definition at line 358 of file PdfTextReaderFixture.java.

Member Data Documentation

◆ ERROR_LOADING_DOCUMENT

final String nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.ERROR_LOADING_DOCUMENT = "Error loading PDF document '%s', the following exception occurred '%s'"

staticprivate

Definition at line 26 of file PdfTextReaderFixture.java.

◆ pdf

PDDocument nl.psek.fitnesse.fixtures.general.pdf.PdfTextReaderFixture.pdf = null

private

Definition at line 25 of file PdfTextReaderFixture.java.

The documentation for this class was generated from the following file:

psek-fitnesse-fixtures-general/src/main/java/nl/psek/fitnesse/fixtures/general/pdf/PdfTextReaderFixture.java

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PdfTextReaderFixture()

Member Function Documentation

◆ closePdf()

◆ loadPdfFromBase64String()

◆ loadPdfFromDatabase()

◆ loadPdfFromFile()

◆ loadPdfFromStream()

◆ loadPdfFromUrl() [1/2]

◆ loadPdfFromUrl() [2/2]

◆ pdfContainsTextBetweenOnPage()

◆ pdfContainsTextBetweenOnPageInsideBlock()

◆ pdfContainsTextLine()

◆ pdfContainsTextLineCaseInsensitive()

◆ pdfContainsTextLineThatContainsText()

◆ pdfContainsTextLineWithPrefix()

◆ pdfContainsTextLineWithSuffix()

◆ pdfContainsTextOnPage()

◆ pdfCountTextPresence()

◆ pdfNotContainsTextBetweenOnPage()

◆ pdfToString()

◆ pdfToTextLines()

◆ writePdfToFile()

Member Data Documentation

◆ ERROR_LOADING_DOCUMENT

◆ pdf