prajna.data.adobe

Class PdfDocReader

java.lang.Object

prajna.data.adobe.PdfDocReader

All Implemented Interfaces:

FormatReader<DocData>

public class PdfDocReader
extends java.lang.Object
implements FormatReader<DocData>

Implementation of a DocData reader that reads PDF documents. The PdfDocReader can read either a single file, or a directory containing PDF files. Each file is converted to a separate DocData object. This class depends on the pdfbox.jar and fontbox.jar files from Apache.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
PdfDocReader() Create a new, uninitialized PdfDocReader.
PdfDocReader(java.io.File file) Create a new PdfDocReader that will read the specified PDF file or directory containing PDF files.
PdfDocReader(java.lang.String filePath) Create a new PdfDocReader that will read the specified PDF file or directory containing PDF files.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead() Return whether this reader is initialized and can read data
void	close() Close the reader.
java.lang.String	getFilters() Get the filters for this reader.
java.lang.String	getSource() Get the source for this reader
boolean	hasMoreData() Determine whether the reader has more data
java.util.List<DocData>	readData() Read the PDF file, or directory of PDF files, to extract the content.
void	setFilters(java.lang.String filters) Set filters for this reader.
void	setSource(java.lang.String source) Set the source for this reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfDocReader

public PdfDocReader()

Create a new, uninitialized PdfDocReader. The reader will need to be initialized using the setSource() method.

PdfDocReader

public PdfDocReader(java.io.File file)

Create a new PdfDocReader that will read the specified PDF file or directory containing PDF files.

Parameters:

file - the PDF file to read, or the directory containing PDF files.

PdfDocReader

public PdfDocReader(java.lang.String filePath)

Create a new PdfDocReader that will read the specified PDF file or directory containing PDF files.

Parameters:

filePath - the path to the PDF file to read, or the directory containing PDF files.

Method Detail

canRead

public boolean canRead()

Return whether this reader is initialized and can read data

Specified by:

canRead in interface FormatReader<DocData>

Returns:

true if the reader has been initialized, false otherwise

close

public void close()

Close the reader. This clears the current PDF file or directory, and resets the reader to an uninitialized state

Specified by:

close in interface FormatReader<DocData>

getFilters

public java.lang.String getFilters()

Get the filters for this reader. Currently only returns null, as the setFilters method does nothing

Specified by:

getFilters in interface FormatReader<DocData>

Returns:

null

getSource

public java.lang.String getSource()

Get the source for this reader

Specified by:

getSource in interface FormatReader<DocData>

Returns:

the path to the PDF file or directory.

hasMoreData

public boolean hasMoreData()

Determine whether the reader has more data

Specified by:

hasMoreData in interface FormatReader<DocData>

Returns:

if new files have been added to the directory, or if the directory has not been read yet.

readData

public java.util.List<DocData> readData()

Read the PDF file, or directory of PDF files, to extract the content. This method either reads the single file or the set of files from the directory, only reading those that it has not already read

Specified by:

readData in interface FormatReader<DocData>

Returns:

the list of DocData objects

setFilters

public void setFilters(java.lang.String filters)

Set filters for this reader. Currently not implemented

Specified by:

setFilters in interface FormatReader<DocData>

Parameters:

filters - the filters for this reader

setSource

public void setSource(java.lang.String source)

Set the source for this reader. The argument must be the path to a PDF file or a directory containing PDF files

Specified by:

setSource in interface FormatReader<DocData>

Parameters:

source - the PDF source file or directory