com.groupdocs.parser.options

Class BarcodeOptions

java.lang.Object

com.groupdocs.parser.options.BarcodeOptions

public class BarcodeOptions
extends Object

Provides the options which are used for barcode extraction.

Constructor Summary

Constructors

Constructor and Description
BarcodeOptions() Initializes a new instance of the BarcodeOptions class with default values.
BarcodeOptions(QualityMode imageQuality, QualityMode barcodeQuality, String... codeTypes) Initializes a new instance of the BarcodeOptions class with quality settings and code types.
BarcodeOptions(Rectangle rectangle) Initializes a new instance of the BarcodeOptions class with the rectangular area.
BarcodeOptions(Rectangle rectangle, QualityMode imageQuality, QualityMode barcodeQuality, Float dimension, boolean allowIncorrectBarcodes, String... codeTypes) Initializes a new instance of the BarcodeOptions class.

Method Summary

Modifier and Type	Method and Description
QualityMode	getBarcodeQuality() Gets the quality of a source barcode.
List<String>	getCodeTypes() Gets the types of barcodes to read.
Float	getDimension() Gets the minimal size of the barcode minimal element.
QualityMode	getImageQuality() Gets the quality of a source image.
Rectangle	getRectangle() Gets the rectangular area that contains page areas.
boolean	isAllowIncorrectBarcodes() Gets the value that indicates whether the incorrect barcodes are allowed.
void	setAllowIncorrectBarcodes(boolean allowIncorrectBarcodes) Sets the value that indicates whether the incorrect barcodes are allowed.
void	setBarcodeQuality(QualityMode barcodeQuality) Sets the quality of a source barcode.
void	setCodeTypes(List<String> codeTypes) Sets the types of barcodes to read.
void	setDimension(Float dimension) Sets the minimal size of the barcode minimal element.
void	setImageQuality(QualityMode imageQuality) Sets the quality of a source image.
void	setRectangle(Rectangle rectangle) Sets the rectangular area that contains barcodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodeOptions

public BarcodeOptions()

Initializes a new instance of the BarcodeOptions class with default values.

BarcodeOptions

public BarcodeOptions(Rectangle rectangle)

Initializes a new instance of the BarcodeOptions class with the rectangular area.

Parameters:

rectangle - The rectangular area that contains barcodes.

BarcodeOptions

public BarcodeOptions(QualityMode imageQuality,
                      QualityMode barcodeQuality,
                      String... codeTypes)

Initializes a new instance of the BarcodeOptions class with quality settings and code types.

Parameters:

imageQuality - The quality of a source image.

barcodeQuality - The quality of a source barcode.

codeTypes - The types of barcodes to read.

BarcodeOptions

public BarcodeOptions(Rectangle rectangle,
                      QualityMode imageQuality,
                      QualityMode barcodeQuality,
                      Float dimension,
                      boolean allowIncorrectBarcodes,
                      String... codeTypes)

Initializes a new instance of the BarcodeOptions class.

Parameters:

rectangle - The rectangular area that contains barcodes.

imageQuality - The quality of a source image.

barcodeQuality - The quality of a source barcode.

dimension - The minimal size of the barcode minimal element.

allowIncorrectBarcodes - The value that indicates whether the incorrect barcodes are allowed.

codeTypes - The types of barcodes to read.

Method Detail

isAllowIncorrectBarcodes

public boolean isAllowIncorrectBarcodes()

Gets the value that indicates whether the incorrect barcodes are allowed.

Returns:

true if the incorrect barcodes are allowed; otherwise, false.

getDimension

public Float getDimension()

Gets the minimal size of the barcode minimal element.

Returns:

The float value that represents the barcode minimal element; null if auto mode is used.

getImageQuality

public QualityMode getImageQuality()

Gets the quality of a source image.

Returns:

The mode which defines the level of the source image quality.

getBarcodeQuality

public QualityMode getBarcodeQuality()

Gets the quality of a source barcode.

Returns:

The mode which defines the level of the source barcode quality.

getRectangle

public Rectangle getRectangle()

Gets the rectangular area that contains page areas.

Returns:

An instance of Rectangle class that represents the rectangular area that contains page areas; null if it isn't set.

getCodeTypes

public List<String> getCodeTypes()

Gets the types of barcodes to read.

Returns:

The readonly collection that contains a types of barcodes to read; empty collection if isn't set.

setAllowIncorrectBarcodes

public void setAllowIncorrectBarcodes(boolean allowIncorrectBarcodes)

Sets the value that indicates whether the incorrect barcodes are allowed.

Parameters:

allowIncorrectBarcodes - true if the incorrect barcodes are allowed.

setDimension

public void setDimension(Float dimension)

Sets the minimal size of the barcode minimal element.

Parameters:

dimension - The barcode minimal element; null for auto mode.

setImageQuality

public void setImageQuality(QualityMode imageQuality)

Sets the quality of a source image.

Parameters:

imageQuality - The image quality mode.

setBarcodeQuality

public void setBarcodeQuality(QualityMode barcodeQuality)

Sets the quality of a source barcode.

Parameters:

barcodeQuality - The barcode quality mode.

setRectangle

public void setRectangle(Rectangle rectangle)

Sets the rectangular area that contains barcodes.

Parameters:

rectangle - The rectangular area; null to scan the whole page.

setCodeTypes

public void setCodeTypes(List<String> codeTypes)

Sets the types of barcodes to read.

Parameters:

codeTypes - The types of barcodes; null or empty for all types.