 | Opait.ReportMiner.Api Namespace |
You can use the interfaces defined in the API namespace to communicate with the Report Miner processing engine. You do this by implementing a callback interface which is passed to the server at the same time that the main form is created. This interface may contain custom code to alter or enhance the processing of data. For example, you may wish to route retrieved data to specific applications or data tables, or use data elements and text from PDF pages for more complex processing.
Notes:
1. The processing engine executes on the background worker threadpool. You should not call any user interface elements, such as dialog boxes, from within callback handlers.
2. Use the LogMessage method of IEngine interface to log messages to the output window or the log file.
Notes:
1. The processing engine executes on the background worker threadpool. You should not call any user interface elements, such as dialog boxes, from within callback handlers.
2. Use the LogMessage method of IEngine interface to log messages to the output window or the log file.
Classes| Class | Description | |
|---|---|---|
 | ExportJob |
Class represents an export job. Export jobs run in a priority queue.
A job can be triggered by arrival of source files in a watched folder.
|
| ExportProject |
Class represents a project with a list of jobs.
|
| Factory |
Class provides static factory methods.
|
| Plugin |
Base implementation of the plugin interface to the Report Miner processing engine.
Remarks
All plugin functions are implemented as virtual methods that return a code to continue
with the normal processing. The API clients can override any number of these virtual
functions to implement customized handling of the processing workflow.
|
| Processor |
Report miner processing engine.
|
| ReportModel |
Class represents a parsed and validated Report Miner Model file.
|
Interfaces| Interface | Description | |
|---|---|---|
 | ICell |
Public interface of a table cell.
|
| IColumn |
Public interface of a table column.
|
| IDocument |
Interface represents a PDF report document.
|
| IEngine |
Interface to the Report Miner processing engine.
|
| IField |
Interface defines an exported field.
|
| ILabel |
Interface defines a label.
|
| IPage |
Interface represents a report page.
|
| IPlugin |
Interface defines a plugin for the report miner processing engine.
|
| IRecord |
Interface defines a logical record.
|
| IRow |
Interface of a row in a table.
|
| ISection |
Public interface of an exported text section.
|
| ISentence |
Public Interface to a detected sentence.
|
| ITable |
Interface of a table.
|
| IToken |
Public interface of a text token.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | ConstraintType |
Constraint types applied to bounding rectangles.
|
| ExportFormat |
Supported file formats for exported report.
|
| LabelAction |
Action associated with label detection.
|
| MultiRowMerge |
Enumerates options for merging rows.
|
| SectionFilter |
The list of data types used to filter sentences.
|
| SectionType |
The types of data to extract for text sections.
|