Loading...
Searching...
No Matches
DataExtractionModule.h
Go to the documentation of this file.
1//---------------------------------------------------------------------------------------
2// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
3// Consult legal.txt regarding legal and license information.
4//---------------------------------------------------------------------------------------
5// !Warning! This file is autogenerated, modify the .codegen file, not this one
6// (any changes here will be wiped out during the autogen process)
7
8#ifndef PDFTRON_H_CPPPDFDataExtractionModule
9#define PDFTRON_H_CPPPDFDataExtractionModule
10#include <C/PDF/TRN_DataExtractionModule.h>
11
12#include <PDF/DataExtractionOptions.h>
13#include <Common/BasicTypes.h>
14#include <Common/UString.h>
15#include <PDF/PDFDoc.h>
16
17 namespace pdftron { namespace PDF {
18
23 class DataExtractionModule
24{
25 public:
29 enum DataExtractionEngine
30 {
31 e_Tabular = 0,
32 e_Form = 1,
33 e_DocStructure = 2,
34 e_FormKeyValue = 3,
35 e_GenericKeyValue = 4,
36 e_DocClassification = 5
37 };
38
45 static bool IsModuleAvailable(DataExtractionEngine engine);
46
56 static UString ExtractData(const UString& input_pdf_file, DataExtractionEngine engine, DataExtractionOptions* options = 0);
57
67 static void ExtractData(const UString& input_pdf_file, const UString& output_json_file, DataExtractionEngine engine, DataExtractionOptions* options = 0);
68
76 static void DetectAndAddFormFieldsToPDF(PDFDoc& doc, DataExtractionOptions* options = 0);
77
85 static void ExtractToXLSX(const UString& input_pdf_file, const UString& output_xlsx_file, DataExtractionOptions* options = 0);
86
94 static void ExtractToXLSX(const UString& input_pdf_file, Filters::Filter& output_xlsx_stream, DataExtractionOptions* options = 0);
95
96};
97
98#include <Impl/DataExtractionModule.inl>
99} //end PDF
100} //end pdftron
101
102
103#endif //PDFTRON_H_CPPPDFDataExtractionModule
BasicTypes.h
DataExtractionOptions.h
PDFDoc.h
UString.h
pdftron::Filters::Filter
Definition Filter.h:46
pdftron::PDF::DataExtractionModule
Definition DataExtractionModule.h:24
pdftron::PDF::DataExtractionModule::IsModuleAvailable
static bool IsModuleAvailable(DataExtractionEngine engine)
pdftron::PDF::DataExtractionModule::ExtractData
static void ExtractData(const UString &input_pdf_file, const UString &output_json_file, DataExtractionEngine engine, DataExtractionOptions *options=0)
pdftron::PDF::DataExtractionModule::ExtractToXLSX
static void ExtractToXLSX(const UString &input_pdf_file, const UString &output_xlsx_file, DataExtractionOptions *options=0)
pdftron::PDF::DataExtractionModule::ExtractData
static UString ExtractData(const UString &input_pdf_file, DataExtractionEngine engine, DataExtractionOptions *options=0)
pdftron::PDF::DataExtractionModule::DetectAndAddFormFieldsToPDF
static void DetectAndAddFormFieldsToPDF(PDFDoc &doc, DataExtractionOptions *options=0)
pdftron::PDF::DataExtractionModule::DataExtractionEngine
DataExtractionEngine
Definition DataExtractionModule.h:30
pdftron::PDF::DataExtractionModule::e_Form
@ e_Form
Form field extraction engine. This engine uses artificial intelligence and computer vision to detect ...
Definition DataExtractionModule.h:32
pdftron::PDF::DataExtractionModule::e_DocClassification
@ e_DocClassification
Document classification engine. This engine uses artificial intelligence to assign predefined categor...
Definition DataExtractionModule.h:36
pdftron::PDF::DataExtractionModule::e_DocStructure
@ e_DocStructure
Document structure engine. This engine discovers the full logical structure, including headers,...
Definition DataExtractionModule.h:33
pdftron::PDF::DataExtractionModule::e_GenericKeyValue
@ e_GenericKeyValue
Generic key value extraction engine. This engine uses artificial intelligence to detect arbitrary pai...
Definition DataExtractionModule.h:35
pdftron::PDF::DataExtractionModule::e_Tabular
@ e_Tabular
Tabular Data engine. This engine identifies column and row structure and analyzes numeric columns....
Definition DataExtractionModule.h:31
pdftron::PDF::DataExtractionModule::e_FormKeyValue
@ e_FormKeyValue
Form field with key value extraction engine. This engine uses artificial intelligence and computer vi...
Definition DataExtractionModule.h:34
pdftron::PDF::DataExtractionModule::ExtractToXLSX
static void ExtractToXLSX(const UString &input_pdf_file, Filters::Filter &output_xlsx_stream, DataExtractionOptions *options=0)
pdftron::PDF::DataExtractionOptions
Definition DataExtractionOptions.h:10
pdftron::PDF::PDFDoc
Definition PDFDoc.h:72
pdftron::UString
Definition UString.h:28
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10