com.adobe.livecycle.barcodedforms
Class BarcodedFormsService

java.lang.Object
  com.adobe.livecycle.barcodedforms.BarcodedFormsService

public class BarcodedFormsService
extends Object

Main Barcoded Forms Service

Constructor Summary

BarcodedFormsService()
Constructor

Method Summary

Document	decode(Document document, Boolean pdf417, Boolean dataMatrix, Boolean qrCode, Boolean codabar, Boolean code128, Boolean code39, Boolean ean13, Boolean ean8, CharSet charSet) Decodes barcodes in an LiveCycle document object.
List	extractToXML(Document decoderXML, Delimiter lineDelimiterType, Delimiter fieldDelimiterType, XMLFormat xmlFormat) Transforms delimited barcode data into XML data.
void	setEnforceChecksum(Boolean enforceChecksum) Enforce the checksum in those symbologies in which a checksum character is optional.
void	setPlus2Digits(Boolean plus2Digits) Read 2-digit supplementals associated with EAN and UPC symbology barcodes.
void	setPlus5Digits(Boolean plus5Digits) Read 5-digit supplementals associated with EAN and UPC symbology barcodes.
void	setReadDown(Boolean readDown) Scan barcode images vertically from top to bottom.
void	setReadLeft(Boolean readLeft) Scan barcode images horizontally from right to left.
void	setReadRight(Boolean readRight) Scan barcode images horizontally from left to right.
void	setReadUp(Boolean readUp) Scan barcode images vertically from bottom to top.
void	setScanInterval(Integer scanInterval) The scan interval

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodedFormsService

public BarcodedFormsService()

Constructor

Method Detail

setReadLeft

public void setReadLeft(Boolean readLeft)

Scan barcode images horizontally from right to left.

Parameters:

readLeft - true to scan right to left, false otherwise. Default true.

setReadRight

public void setReadRight(Boolean readRight)

Scan barcode images horizontally from left to right.

Parameters:

readRight - true to scan left to right, false otherwise. Default true.

setReadUp

public void setReadUp(Boolean readUp)

Scan barcode images vertically from bottom to top.

Parameters:

readUp - true to scan bottom to top, false otherwise. Default true.

setReadDown

public void setReadDown(Boolean readDown)

Scan barcode images vertically from top to bottom.

Parameters:

readDown - True to scan top to bottom, false otherwise. Default true.

setEnforceChecksum

public void setEnforceChecksum(Boolean enforceChecksum)

Enforce the checksum in those symbologies in which a checksum character is optional.

Parameters:

enforceChecksum - true to enforce the checksum character, false otherwise. Default false.

setPlus2Digits

public void setPlus2Digits(Boolean plus2Digits)

Read 2-digit supplementals associated with EAN and UPC symbology barcodes.

Parameters:

plus2Digits - True to read 2-digit supplementals, false otherwise. Default false.

setPlus5Digits

public void setPlus5Digits(Boolean plus5Digits)

Read 5-digit supplementals associated with EAN and UPC symbology barcodes.

Parameters:

plus5Digits - True to read 5-digit supplementals, false otherwise. Default false.

setScanInterval

public void setScanInterval(Integer scanInterval)

The scan interval

Parameters:

scanInterval - The scan interval. Default 6.

decode

public Document decode(Document document,
                       Boolean pdf417,
                       Boolean dataMatrix,
                       Boolean qrCode,
                       Boolean codabar,
                       Boolean code128,
                       Boolean code39,
                       Boolean ean13,
                       Boolean ean8,
                       CharSet charSet)
                throws DecodingException

Decodes barcodes in an LiveCycle document object.

Parameters:

document - Document to decode

pdf417 - Decode PDF417 barcodes.

dataMatrix - Decode Data Matrix barcodes.

qrCode - Decode QR Code barcodes.

codabar - Decode Codabar barcodes.

code128 - Decode Code 128 barcodes.

code39 - Decode PDF417 barcodes.

ean13 - Decode EAN-13 barcodes.

ean8 - Decode EAN-8 barcodes.

charSet - The code encoding used in the barcode.

Returns:

An XML document that contains all the barcode data.

Throws:

DecodingException - Error during decoding

extractToXML

public List extractToXML(Document decoderXML,
                         Delimiter lineDelimiterType,
                         Delimiter fieldDelimiterType,
                         XMLFormat xmlFormat)

Transforms delimited barcode data into XML data. This allows the barcodes to be used for routing and other workflow functions within LiveCycle.

Parameters:

decoderXML - Decoder output document (XML)

lineDelimiterType - The type of the line delimiter. Comma, Carriage Return, Line Feed, Tab, Pipe, Semi-Colon, Colon, or Space.

fieldDelimiterType - The type of the field delimiter. Comma, Carriage Return, Line Feed, Tab, Pipe, Semi-Colon, Colon, or Space.

xmlFormat - The output XML scheme type. XDP or XFDF.

Returns:

A list of XML documents that contains the XML representation of the barcode data.