com.spire.barcode.implementation.scanner.reader
Class BarcodeReader

java.lang.Object
  com.spire.barcode.implementation.scanner.reader.BarcodeReader

public class BarcodeReader
extends java.lang.Object

Constructor Summary

BarcodeReader()
Initializes a new instance of the BarcodeReader class with default values.

BarcodeReader(com.spire.ms.System.Drawing.Bitmap image)
Initializes a new instance of the BarcodeReader class from an image.

BarcodeReader(com.spire.ms.System.Drawing.Bitmap image, BarCodeReadType type)
Initializes a new instance of the BarcodeReader class.

BarcodeReader(com.spire.ms.System.Drawing.Bitmap image, com.spire.ms.System.Drawing.Rectangle area, BarCodeReadType type)
Initializes a new instance of the BarcodeReader class.

BarcodeReader(com.spire.ms.System.IO.Stream stream)
Initializes a new instance of the BarcodeReader class.

BarcodeReader(com.spire.ms.System.IO.Stream stream, BarCodeReadType type)
Initializes a new instance of the BarcodeReader class.

BarcodeReader(java.lang.String filename)
Initializes a new instance of the BarcodeReader class from file.

BarcodeReader(java.lang.String filename, BarCodeReadType type)
Initializes a new instance of the BarcodeReader class.

Method Summary

void	close() Closes barcode reader.
BarcodeReader.PossibleBarCode[]	getAllPossibleBarCodes() Gets all possible barcodes found.
float	getAngle() Gets the angle of the barcode (0-360).
java.lang.String	getCheckSum() Gets the checksum for 1D barcodes.
ChecksumValidation	getChecksumValidation() Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies The checksum validation flag.
byte[]	getCodeBytes() Gets the encoded code bytes.
java.lang.String	getCodeText() Gets the code text.
java.lang.String	getCodeText(com.spire.ms.System.Text.Encoding encoding) Gets the code text with encoding.
int	getExpectedBarCodeCount() Expected barcodes to be found.The reader will stop reading the image once it found barcodes more than this value.
RecognitionHints.ImageBinarization	getImageBinarizationHints() Gets the image binarization hints.
int	getMacroPdf417FileID() Gets the file ID of the barcode, only available with MacroPdf417.
int	getMacroPdf417SegmentID() Gets the segment ID of the barcode,only available with MacroPdf417.
int	getMacroPdf417SegmentsCount() Gets macro pdf417 barcode segments count.
int	getMedianSmoothingWindowSize() Gets the median smoothing window size.
RecognitionHints.Orientation	getOrientationHints() Gets the orientation hints.
int	getQRStructuredAppendModeBarCodeIndex() Gets the index of the QR structured append mode barcode.
int	getQRStructuredAppendModeBarCodesQuantity() Gets the QR structured append mode barcodes quantity.
int	getQRStructuredAppendModeParityData() Gets the QR structured append mode parity data.
BarCodeReadType	getReadType() Gets the barcode type.
float	getRecognitionQuality() Gets the recognition quality.
CodeDataRegion	getRegion() Gets the barcode DataRegion.
boolean	getStripFNC() Strip FNC1, FNC2, FNC3 characters from codetext.
int	getTimeout() Gets the timeout of recognition process.
UserInfoType	getUserInfoType() Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is UserInfoType.Other.
static boolean	isLicensed() Gets a value indicating whether recognition module is licensed.
boolean	isWriteWarning()
boolean	read() Reads barcode from the image.
void	setBarCodeImage(com.spire.ms.System.Drawing.Bitmap value) Sets bitmap image for recognition.
void	setBarCodeImage(java.lang.String filename) Sets image file for recogniton.
void	setBarCodeReadType(BarCodeReadType type) Sets BarCodeReadType for recognition.
void	setChecksumValidation(ChecksumValidation value) Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies The checksum validation flag.
void	setExpectedBarCodeCount(int value) Expected barcodes to be found.The reader will stop reading the image once it found barcodes more than this value.
void	setImageBinarizationHints(RecognitionHints.ImageBinarization value) Sets the image binarization hints.
void	setMedianSmoothingWindowSize(int value) Sets the median smoothing window size.
void	setOrientationHints(RecognitionHints.Orientation value) Gets the orientation hints.
void	setStripFNC(boolean value) Strip FNC1, FNC2, FNC3 characters from codetext.
void	setUserInfoType(UserInfoType value) Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is UserInfoType.Other.

Constructor Detail

BarcodeReader

public BarcodeReader()

Initializes a new instance of the BarcodeReader class with default values. Requires to set image (SetBitmapImage()) before to call Read() method.

BarcodeReader

public BarcodeReader(com.spire.ms.System.Drawing.Bitmap image)

Initializes a new instance of the BarcodeReader class from an image.

Parameters:

image - A Bitmap instance containing the image

BarcodeReader

public BarcodeReader(com.spire.ms.System.Drawing.Bitmap image,
                     BarCodeReadType type)

Initializes a new instance of the BarcodeReader class.

Parameters:

image - The image.

type - The BarCodeReadType.

BarcodeReader

public BarcodeReader(com.spire.ms.System.Drawing.Bitmap image,
                     com.spire.ms.System.Drawing.Rectangle area,
                     BarCodeReadType type)

Initializes a new instance of the BarcodeReader class. Not support compact framework.

Parameters:

image - The image.

area - The area for recognition.

type - The BarCodeReadType.

BarcodeReader

public BarcodeReader(java.lang.String filename)

Initializes a new instance of the BarcodeReader class from file.

Parameters:

filename - The filename.

Throws:

java.lang.Exception

BarcodeReader

public BarcodeReader(java.lang.String filename,
                     BarCodeReadType type)

Initializes a new instance of the BarcodeReader class.

Parameters:

filename - The filename.

type - The BarCodeReadType.

Throws:

java.lang.Exception

BarcodeReader

public BarcodeReader(com.spire.ms.System.IO.Stream stream)

Initializes a new instance of the BarcodeReader class.

Parameters:

stream - The stream.

BarcodeReader

public BarcodeReader(com.spire.ms.System.IO.Stream stream,
                     BarCodeReadType type)

Initializes a new instance of the BarcodeReader class.

Parameters:

stream - The stream.

type - The The BarCodeReadType.

Method Detail

isWriteWarning

public boolean isWriteWarning()

isLicensed

public static boolean isLicensed()

Gets a value indicating whether recognition module is licensed. true if recognition module is licensed; otherwise, false.

Returns:

boolean

getTimeout

public int getTimeout()

Gets the timeout of recognition process. The timeout.

Returns:

int

getChecksumValidation

public ChecksumValidation getChecksumValidation()

Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies The checksum validation flag.

setChecksumValidation

public void setChecksumValidation(ChecksumValidation value)

Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies The checksum validation flag.

getMedianSmoothingWindowSize

public int getMedianSmoothingWindowSize()

Gets the median smoothing window size. Typical values are 3 or 4. Default value is 3. Recognition hint MedianSmoothing must be set. The median smoothing window size. Typical values are 3 or 4. Default value is 3.

Returns:

int

setMedianSmoothingWindowSize

public void setMedianSmoothingWindowSize(int value)

Sets the median smoothing window size. Typical values are 3 or 4. Default value is 3. Recognition hint MedianSmoothing must be set. The median smoothing window size. Typical values are 3 or 4. Default value is 3.

Parameters:

value -

getExpectedBarCodeCount

public int getExpectedBarCodeCount()

Expected barcodes to be found.The reader will stop reading the image once it found barcodes more than this value. Default value is int.MaxValue.

Returns:

int

setExpectedBarCodeCount

public void setExpectedBarCodeCount(int value)

Expected barcodes to be found.The reader will stop reading the image once it found barcodes more than this value. Default value is int.MaxValue.

Parameters:

value -

getStripFNC

public boolean getStripFNC()

Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Returns:

boolean

setStripFNC

public void setStripFNC(boolean value)

Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.

Parameters:

value -

getUserInfoType

public UserInfoType getUserInfoType()

Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is UserInfoType.Other.

Returns:

UserInfoType

setUserInfoType

public void setUserInfoType(UserInfoType value)

Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is UserInfoType.Other.

Parameters:

value -

close

public void close()

Closes barcode reader.

read

public boolean read()

Reads barcode from the image.

Returns:

True if the next barcode was read successfully; false if there are no more nodes to read.

getOrientationHints

public RecognitionHints.Orientation getOrientationHints()

Gets the orientation hints. The orientation hints. Default value is NoRotate.

Returns:

Orientation

setOrientationHints

public void setOrientationHints(RecognitionHints.Orientation value)

Gets the orientation hints. The orientation hints. Default value is NoRotate.

Parameters:

value -

getImageBinarizationHints

public RecognitionHints.ImageBinarization getImageBinarizationHints()

Gets the image binarization hints. The image binarization hints. Default value is None.

Returns:

ImageBinarization

setImageBinarizationHints

public void setImageBinarizationHints(RecognitionHints.ImageBinarization value)

Sets the image binarization hints. The image binarization hints. Default value is None.

Parameters:

value -

getCodeText

public java.lang.String getCodeText()

Gets the code text.

Returns:

The code text of the barcode.

getCodeText

public java.lang.String getCodeText(com.spire.ms.System.Text.Encoding encoding)

Gets the code text with encoding.

Parameters:

encoding - The encoding for codetext.

Returns:

A string containing recognized code text.

getCheckSum

public java.lang.String getCheckSum()

Gets the checksum for 1D barcodes.

Returns:

The checksum for 1D barcode.

getAngle

public float getAngle()

Gets the angle of the barcode (0-360). RecognitionHints.Orientation enum does not included into the calculation.

Returns:

The angle for barcode (0-360).

getCodeBytes

public byte[] getCodeBytes()

Gets the encoded code bytes.

Returns:

The code bytes of the barcode.

getMacroPdf417FileID

public int getMacroPdf417FileID()

Gets the file ID of the barcode, only available with MacroPdf417.

Returns:

The file ID for MacroPdf417

getMacroPdf417SegmentID

public int getMacroPdf417SegmentID()

Gets the segment ID of the barcode,only available with MacroPdf417.

Returns:

The segment ID of the barcode.

getMacroPdf417SegmentsCount

public int getMacroPdf417SegmentsCount()

Gets macro pdf417 barcode segments count. Default value is -1.

Returns:

Segments count.

getQRStructuredAppendModeBarCodesQuantity

public int getQRStructuredAppendModeBarCodesQuantity()

Gets the QR structured append mode barcodes quantity. Default value is -1.

Returns:

The quantity of the QR structured append mode barcode.

getQRStructuredAppendModeBarCodeIndex

public int getQRStructuredAppendModeBarCodeIndex()

Gets the index of the QR structured append mode barcode. Index starts from 0. Default value is -1.

Returns:

The index of the QR structured append mode barcode.

getQRStructuredAppendModeParityData

public int getQRStructuredAppendModeParityData()

Gets the QR structured append mode parity data. Default value is -1.

Returns:

The QR structured append mode parity data.

getRegion

public CodeDataRegion getRegion()

Gets the barcode DataRegion.

Returns:

The DataRegion of the recognized barcode.

getReadType

public BarCodeReadType getReadType()

Gets the barcode type.

Returns:

The type information of the recognized barcode.

getRecognitionQuality

public float getRecognitionQuality()

Gets the recognition quality. Works for 1D and postal barcodes.

Returns:

The recognition quality percent.

getAllPossibleBarCodes

public BarcodeReader.PossibleBarCode[] getAllPossibleBarCodes()

Gets all possible barcodes found. Only for 1D barcodes. Includes correct answer if the barcode recognized fine.

Returns:

The array of possible 1D barcodes. Includes correct answer if the barcode recognized fine.

setBarCodeImage

public void setBarCodeImage(com.spire.ms.System.Drawing.Bitmap value)

Sets bitmap image for recognition. Must be called before Read() method.

Parameters:

value - The bitmap image for recognition.

setBarCodeImage

public void setBarCodeImage(java.lang.String filename)

Sets image file for recogniton. Must be called before Read() method.

Parameters:

filename - The image file for recogniton.

Throws:

java.lang.Exception

setBarCodeReadType

public void setBarCodeReadType(BarCodeReadType type)

Sets BarCodeReadType for recognition. Must be called before Read() method.

Parameters:

type - The type of barcode to read.