com.datalogics.PDFL

Class DocTextFinder

java.lang.Object

com.datalogics.PDFL.DocTextFinder

public class DocTextFinder
extends java.lang.Object

A class used to extract words from a document using a regular expression.

Constructor Summary

Constructors

Constructor and Description
DocTextFinder(Document doc, WordFinderConfig wbConfig) Create a DocTextFinder

Method Summary

Modifier and Type	Method and Description
void	delete()
java.util.List<DocTextFinderMatch>	getMatchList(int beginPageNumber, int endPageNumber, java.lang.String regexstr) Finds all matching strings for a given regular expression for the specified page range.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocTextFinder

public DocTextFinder(Document doc,
                     WordFinderConfig wbConfig)

Create a DocTextFinder

Parameters:

doc - document to search

wbConfig - WordFinder configuration to use

Method Detail

delete

public void delete()

getMatchList

public java.util.List<DocTextFinderMatch> getMatchList(int beginPageNumber,
                                                       int endPageNumber,
                                                       java.lang.String regexstr)

Finds all matching strings for a given regular expression for the specified page range. It returns a vector containing words along with the page and matching phrase that was found.

Parameters:

beginPageNumber - the beginning page number included in the search.

endPageNumber - the ending page number included in the search.

regexstr - the regular expression to use for the search.

Returns:

a structure containing matching phrases along with its quads.