DocTextFinder Class Documentation

classDocTextFinder

Namespace:datalogics_interface

Detailed Description

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

Uses types

DocTextFinderMatch

Constructor & Destructor Documentation

DocTextFinder

DocTextFinder(Document &doc)

Parameters

doc: Document &

The document to search.

Create a DocTextFinder for the given document.

~DocTextFinder

~DocTextFinder()

Member Function Documentation

get_match_list

std::vector< DocTextFinderMatch >get_match_list(intbegin_page, intend_page, const std::string &regex)

Parameters

begin_page: int

the beginning page number included in the search.

end_page: int

the ending page number included in the search.

regex: const std::string &

the regular expression to use for the search.

Returns:

a structure containing matching phrases along with its quads.

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.