Package net.webpdf.wsclient.openapi

Class OperationBarcodeSelection

  • public class OperationBarcodeSelection
extends Object
    This section is used to control the recognition process and configure settings that apply only to specific barcode types.

    • Constructor Detail

      • OperationBarcodeSelection

        public OperationBarcodeSelection()

    • Method Detail

      • getAllowedLengths

        @Nullable
public @Nullable String getAllowedLengths()
        If this value is set, it will limit the allowed lengths for encoded values. In other words, barcodes with a length that is not listed will be ignored. (Example: \"13,8,25\")
        Returns:
        allowedLengths

      • setAllowedLengths

        public void setAllowedLengths​(String allowedLengths)

      • getBarcode39CheckDigit

        @Nullable
public @Nullable Boolean getBarcode39CheckDigit()
        If this value is set to \"true\", the system will assume that all recognized Code 39 barcodes contain a correct check digit.
        Returns:
        barcode39CheckDigit

      • setBarcode39CheckDigit

        public void setBarcode39CheckDigit​(Boolean barcode39CheckDigit)

      • getCharset

        @Nullable
public @Nullable String getCharset()
        Used to specify the character set in which the barcode contents are stored.
        Returns:
        charset

      • setCharset

        public void setCharset​(String charset)

      • getCodabarStartEndDigits

        @Nullable
public @Nullable Boolean getCodabarStartEndDigits()
        If this value is set to \"true\", the start and stop symbols of recognized Codabar barcodes will be read instead of removed during recognition.
        Returns:
        codabarStartEndDigits

      • setCodabarStartEndDigits

        public void setCodabarStartEndDigits​(Boolean codabarStartEndDigits)

      • getFormats

        @NotNull
public @NotNull String getFormats()
        Used to define the list of barcodes (comma-separated) that should be searched for. There must be at least one barcode format here; otherwise, no search will be run. The names are the same as those used in `<add>`, i.e., the following are the barcode names available: * qrcode * aztec * codabar * code128 * code39 * datamatrix * ean13 * ean8 * itf * pdf417 * upca
        Returns:
        formats

      • setFormats

        public void setFormats​(String formats)

      • getGs1

        @Nullable
public @Nullable Boolean getGs1()
        If this value is set to \"true\", the system will assume that all recognized barcodes are GS1-compliant barcodes, and the way all processes behave and work will be adjusted accordingly (for instance, the way in which the FNC1 character is handled for Code 128)
        Returns:
        gs1

      • setGs1

        public void setGs1​(Boolean gs1)

      • getPages

        @Nullable
public @Nullable String getPages()
        The page range within which barcodes should be scanned. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: \"1-10\" or \"1,2,5-10\")
        Returns:
        pages

      • setPages

        public void setPages​(String pages)

      • getPureBarcode

        @Nullable
public @Nullable Boolean getPureBarcode()
        If this value is set to \"true\", the system will assume that the source document being scanned (limited by `<scanArea>`) does not contain any elements other than the barcode. This option can speed up the recognition process significantly. If, however, this option is enabled and there are elements other than a barcode, recognition may fail completely.
        Returns:
        pureBarcode

      • setPureBarcode

        public void setPureBarcode​(Boolean pureBarcode)

      • getResolution

        @Nullable
public @Nullable Integer getResolution()
        Used to select the resolution for the recognition operation. Depending on the barcode's format and quality, higher or lower values may yield better results (in any case, higher values will slow down processing). minimum: 1
        Returns:
        resolution

      • setResolution

        public void setResolution​(Integer resolution)

      • getScanArea

        @NotNull
public @NotNull OperationRectangle getScanArea()
        Get scanArea
        Returns:
        scanArea

      • getTryHarder

        @Nullable
public @Nullable Boolean getTryHarder()
        If this value is set to \"true\", more computing time will be invested in order to guarantee successful recognition. For example, the system will also scan for barcodes along the vertical axis.
        Returns:
        tryHarder

      • setTryHarder

        public void setTryHarder​(Boolean tryHarder)

      • getUpcEanExtensions

        @Nullable
public @Nullable String getUpcEanExtensions()
        If this value is set, it will limit the allowed lengths for encoded EAN and UPC Extensions. In other words, barcodes with an Extension length that is not listed will be ignored. (Example: \"2,5\")
        Returns:
        upcEanExtensions

      • setUpcEanExtensions

        public void setUpcEanExtensions​(String upcEanExtensions)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object