DocTextFinderMatch Class Documentation
class DocTextFinderMatchNamespace:datalogics_interface
Detailed Description
A phrase in the document that matched the supplied regular expression along with its associated quad bounding box(es).
A phrase matching a regular expression, with location information.
Referenced by
Uses types
Constructor & Destructor Documentation
DocTextFinderMatch
DocTextFinderMatch()Default constructor. Produces an empty match with no quad-info.
DocTextFinderMatch
DocTextFinderMatch(std::string match_string, std::vector< DocTextFinderQuadInfo > quad_info)Parameters
match_string: std::stringThe text that matched the regular expression.
quad_info: std::vector< DocTextFinderQuadInfo >Bounding-box quads (with page numbers) that cover the matched text; one entry per page the match spans.
Construct a match from the matched text and its bounding boxes.
Member Function Documentation
get_match_string
const std::string & get_match_string()Returns:
const std::string &The matched text string from the document.
Gets the text string that matched the regular expression.
get_quad_info
const std::vector< DocTextFinderQuadInfo > & get_quad_info()Returns:
const std::vector< DocTextFinderQuadInfo > &A list of DocTextFinderQuadInfo objects describing where the match is located.
Gets the quad info and page numbers for the matched text.
Each DocTextFinderQuadInfo in the returned list contains the page number and bounding box quads for a portion of the matched text.