prajna.data.microsoft

Class PstDocReader

java.lang.Object

prajna.data.microsoft.PstDocReader

All Implemented Interfaces:

FormatReader<DocData>

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

Document Reader for Microsoft PST files. PST files contain the data for Microsoft Outlook. This class depends on the libpst.jar file, available here.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
PstDocReader() Create a new, uninitialized PSTDocReader.
PstDocReader(java.io.File file) Create a new PSTDocReader that will read the specified email file.

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 through the PST file, reading all files that match the filters.
void	setFilters(java.lang.String filters) Set the 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

PstDocReader

public PstDocReader()

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

PstDocReader

public PstDocReader(java.io.File file)

Create a new PSTDocReader that will read the specified email file.

Parameters:

file - the PST or OST file to read.

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 PST file, 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.

Specified by:

getFilters in interface FormatReader<DocData>

Returns:

the string representing the filters for this reader

getSource

public java.lang.String getSource()

Get the source for this reader

Specified by:

getSource in interface FormatReader<DocData>

Returns:

the path to the PST file.

hasMoreData

public boolean hasMoreData()

Determine whether the reader has more data

Specified by:

hasMoreData in interface FormatReader<DocData>

Returns:

if new messages have come in since the last read, or if the reader has not read data yet.

readData

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

Read through the PST file, reading all files that match the filters. If no filters are set, all email messages are read. On subsequent calls, this method will return any new messages that have arrived since the last read.

Specified by:

readData in interface FormatReader<DocData>

Returns:

the list of the DocData objects representing the emails

setFilters

public void setFilters(java.lang.String filters)

Set the filters for this reader. The filters for this reader are separated by semicolons. The reader can filter out to read only certain folders by specifying folders= followed by a comma-separated list of folder names. Other filters will be added as needed.

Specified by:

setFilters in interface FormatReader<DocData>

Parameters:

filters - the folder list

setSource

public void setSource(java.lang.String source)

Set the source for this reader. The argument must be the path to a Microsoft PST file.

Specified by:

setSource in interface FormatReader<DocData>

Parameters:

source - the PST source file