com.groupdocs.parser.options

Class ParseByTemplateOptions

java.lang.Object

com.groupdocs.parser.options.ParseByTemplateOptions

public class ParseByTemplateOptions
extends Object

Provides the options which are used in the parseByTemplate methods of Parser.

Constructor Summary

Constructors

Constructor and Description
ParseByTemplateOptions() Initializes a new instance of the ParseByTemplateOptions class.
ParseByTemplateOptions(boolean useOcr) Initializes a new instance of the ParseByTemplateOptions class.
ParseByTemplateOptions(boolean useOcr, OcrOptions ocrOptions) Initializes a new instance of the ParseByTemplateOptions class.
ParseByTemplateOptions(Integer pageIndex, boolean useOcr) Initializes a new instance of the ParseByTemplateOptions class.
ParseByTemplateOptions(Integer pageIndex, boolean useOcr, OcrOptions ocrOptions) Initializes a new instance of the ParseByTemplateOptions class.

Method Summary

Modifier and Type	Method and Description
OcrOptions	getOcrOptions() Gets the OCR options.
Integer	getPageIndex() Gets the index of the page to parse; null to parse all pages.
boolean	getUseOcr() Gets the value that indicates whether OCR is used to extract data.
void	setOcrOptions(OcrOptions ocrOptions) Sets the OCR options.
void	setPageIndex(Integer pageIndex) Sets the index of the page to parse; null to parse all pages.
void	setUseOcr(boolean useOcr) Sets the value that indicates whether OCR is used to extract data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParseByTemplateOptions

public ParseByTemplateOptions()

Initializes a new instance of the ParseByTemplateOptions class.

ParseByTemplateOptions

public ParseByTemplateOptions(boolean useOcr)

Initializes a new instance of the ParseByTemplateOptions class.

Parameters:

useOcr - The value that indicates whether OCR is used to extract data.

ParseByTemplateOptions

public ParseByTemplateOptions(boolean useOcr,
                              OcrOptions ocrOptions)

Initializes a new instance of the ParseByTemplateOptions class.

Parameters:

useOcr - The value that indicates whether OCR is used to extract data.

ocrOptions - The OCR options.

ParseByTemplateOptions

public ParseByTemplateOptions(Integer pageIndex,
                              boolean useOcr)

Initializes a new instance of the ParseByTemplateOptions class.

Parameters:

pageIndex - The index of the page to parse; null to parse all pages.

useOcr - The value that indicates whether OCR is used to extract data.

ParseByTemplateOptions

public ParseByTemplateOptions(Integer pageIndex,
                              boolean useOcr,
                              OcrOptions ocrOptions)

Initializes a new instance of the ParseByTemplateOptions class.

Parameters:

pageIndex - The index of the page to parse; null to parse all pages.

useOcr - The value that indicates whether OCR is used to extract data.

ocrOptions - The OCR options.

Method Detail

getPageIndex

public Integer getPageIndex()

Gets the index of the page to parse; null to parse all pages.

Returns:

The page index, or null.

setPageIndex

public void setPageIndex(Integer pageIndex)

Sets the index of the page to parse; null to parse all pages.

Parameters:

pageIndex - The page index, or null.

getUseOcr

public boolean getUseOcr()

Gets the value that indicates whether OCR is used to extract data.

Returns:

true if OCR is used; otherwise, false.

setUseOcr

public void setUseOcr(boolean useOcr)

Sets the value that indicates whether OCR is used to extract data.

Parameters:

useOcr - true if OCR is used; otherwise, false.

getOcrOptions

public OcrOptions getOcrOptions()

Gets the OCR options.

Returns:

The OCR options; null if not set.

setOcrOptions

public void setOcrOptions(OcrOptions ocrOptions)

Sets the OCR options.

Parameters:

ocrOptions - The OCR options.