| java.lang.Object | ||
| ↳ | com.pdftron.pdf.OptionsBase | |
| ↳ | com.pdftron.pdf.DataExtractionOptions | |
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
DataExtractionOptions()
Constructor.
| |||||||||||
|
DataExtractionOptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
getDeepLearningAssist()
Gets the value DeepLearningAssist from the options object
Specifies if Deep Learning is used with table recognition in the DocStructure engine.
| ||||||||||
| String |
getFormExtractionEngine()
Gets the value FormExtractionEngine from the options object
Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'.
| ||||||||||
| String |
getLanguage()
Gets the value Language from the options object
Specifies the OCR language(s).
| ||||||||||
| String |
getOverlappingFormFieldBehavior()
Gets the value OverlappingFormFieldBehavior from the options object
When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).
| ||||||||||
| String |
getPDFPassword()
Gets the value PDFPassword from the options object
Specifies the password if the PDF requires one.
| ||||||||||
| String |
getPages()
Gets the value Pages from the options object
Specifies a range of pages to be converted, such as "1-5".
| ||||||||||
| DataExtractionOptions |
setDeepLearningAssist(boolean value)
Sets the value for DeepLearningAssist in the options object
Specifies if Deep Learning is used with table recognition in the DocStructure engine.
| ||||||||||
| DataExtractionOptions |
setFormExtractionEngine(String value)
Sets the value for FormExtractionEngine in the options object
Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'.
| ||||||||||
| DataExtractionOptions |
setLanguage(String value)
Sets the value for Language in the options object
Specifies the OCR language(s).
| ||||||||||
| DataExtractionOptions |
setOverlappingFormFieldBehavior(String value)
Sets the value for OverlappingFormFieldBehavior in the options object
When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).
| ||||||||||
| DataExtractionOptions |
setPDFPassword(String value)
Sets the value for PDFPassword in the options object
Specifies the password if the PDF requires one.
| ||||||||||
| DataExtractionOptions |
setPages(String value)
Sets the value for Pages in the options object
Specifies a range of pages to be converted, such as "1-5".
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public boolean getDeepLearningAssist ()
Gets the value DeepLearningAssist from the options object Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.
Returns
- a boolean, Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.
Throws
| PDFNetException |
|---|
public String getFormExtractionEngine ()
Gets the value FormExtractionEngine from the options object Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.
Returns
- a String, Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.
Throws
| PDFNetException |
|---|
public String getLanguage ()
Gets the value Language from the options object Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.
Returns
- a String, Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English..
Throws
| PDFNetException |
|---|
public String getOverlappingFormFieldBehavior ()
Gets the value OverlappingFormFieldBehavior from the options object When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).
Returns
- a String, When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default)..
Throws
| PDFNetException |
|---|
public String getPDFPassword ()
Gets the value PDFPassword from the options object Specifies the password if the PDF requires one. The default is no password.
Returns
- a String, Specifies the password if the PDF requires one. The default is no password..
Throws
| PDFNetException |
|---|
public String getPages ()
Gets the value Pages from the options object Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1.
Returns
- a String, Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1..
Throws
| PDFNetException |
|---|
public DataExtractionOptions setDeepLearningAssist (boolean value)
Sets the value for DeepLearningAssist in the options object Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DataExtractionOptions setFormExtractionEngine (String value)
Sets the value for FormExtractionEngine in the options object Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DataExtractionOptions setLanguage (String value)
Sets the value for Language in the options object Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DataExtractionOptions setOverlappingFormFieldBehavior (String value)
Sets the value for OverlappingFormFieldBehavior in the options object When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DataExtractionOptions setPDFPassword (String value)
Sets the value for PDFPassword in the options object Specifies the password if the PDF requires one. The default is no password.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DataExtractionOptions setPages (String value)
Sets the value for Pages in the options object Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|