Package net.webpdf.wsclient.openapi

Class OperationDetectBarcode

java.lang.Object

net.webpdf.wsclient.openapi.OperationDetectBarcode

public class OperationDetectBarcode
extends Object

This operation is used to define the barcode recognition parameters. The system will attempt to find barcodes inside the area defined with `<scanArea>`. The recognition process itself is controlled with `<selection>`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationDetectBarcode.InputFormatEnum	Used to select the format of the file with the contents that will be scanned for barcodes
static class	OperationDetectBarcode.OutputFormatEnum	Used to select the format in which the recognition results should be returned

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_INPUT_FORMAT
static String	JSON_PROPERTY_OUTPUT_FORMAT
static String	JSON_PROPERTY_SELECTION

Constructor Summary

Constructors

Constructor	Description
OperationDetectBarcode()

Method Summary

Modifier and Type	Method	Description
OperationDetectBarcode	addSelectionItem(OperationBarcodeSelection selectionItem)
boolean	equals(Object o)
@Nullable OperationDetectBarcode.InputFormatEnum	getInputFormat()	Used to select the format of the file with the contents that will be scanned for barcodes
@Nullable OperationDetectBarcode.OutputFormatEnum	getOutputFormat()	Used to select the format in which the recognition results should be returned
@Nullable List<OperationBarcodeSelection>	getSelection()	Get selection
int	hashCode()
OperationDetectBarcode	inputFormat(OperationDetectBarcode.InputFormatEnum inputFormat)
OperationDetectBarcode	outputFormat(OperationDetectBarcode.OutputFormatEnum outputFormat)
OperationDetectBarcode	selection(List<OperationBarcodeSelection> selection)
void	setInputFormat(OperationDetectBarcode.InputFormatEnum inputFormat)
void	setOutputFormat(OperationDetectBarcode.OutputFormatEnum outputFormat)
void	setSelection(List<OperationBarcodeSelection> selection)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_INPUT_FORMAT

public static final String JSON_PROPERTY_INPUT_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_OUTPUT_FORMAT

public static final String JSON_PROPERTY_OUTPUT_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_SELECTION

public static final String JSON_PROPERTY_SELECTION

See Also:

Constant Field Values

Constructor Detail

OperationDetectBarcode

public OperationDetectBarcode()

Method Detail

inputFormat

public OperationDetectBarcode inputFormat(OperationDetectBarcode.InputFormatEnum inputFormat)

getInputFormat

@Nullable
public @Nullable OperationDetectBarcode.InputFormatEnum getInputFormat()

Used to select the format of the file with the contents that will be scanned for barcodes. * pdf = PDF document * img = Image document (JPG, PNG, TIF)

Returns:

inputFormat

setInputFormat

public void setInputFormat(OperationDetectBarcode.InputFormatEnum inputFormat)

outputFormat

public OperationDetectBarcode outputFormat(OperationDetectBarcode.OutputFormatEnum outputFormat)

getOutputFormat

@Nullable
public @Nullable OperationDetectBarcode.OutputFormatEnum getOutputFormat()

Used to select the format in which the recognition results should be returned. * json = JSON * xml = XML

Returns:

outputFormat

setOutputFormat

public void setOutputFormat(OperationDetectBarcode.OutputFormatEnum outputFormat)

selection

public OperationDetectBarcode selection(List<OperationBarcodeSelection> selection)

addSelectionItem

public OperationDetectBarcode addSelectionItem(OperationBarcodeSelection selectionItem)

getSelection

@Nullable
public @Nullable List<OperationBarcodeSelection> getSelection()

Get selection

Returns:

selection

setSelection

public void setSelection(List<OperationBarcodeSelection> selection)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object