Package net.webpdf.wsclient.schema.operation

Class BarcodeSelectionType

  • public class BarcodeSelectionType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This section is used to control the recognition process and configure settings that apply only to specific barcode types.</p>

    Java class for BarcodeSelectionType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="BarcodeSelectionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="scanArea" type="{http://schema.webpdf.de/1.0/operation}RectangleType" minOccurs="0"/>
       </all>
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="resolution" default="200">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="pureBarcode" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="gs1" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="tryHarder" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="allowedLengths" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="barcode39CheckDigit" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="codabarStartEndDigits" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="upcEanExtensions" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="charset" type="{http://www.w3.org/2001/XMLSchema}string" default="utf-8" />
       <attribute name="formats" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • pages

        protected String pages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>

      • resolution

        protected Integer resolution
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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).</p>

      • pureBarcode

        protected Boolean pureBarcode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the system will assume that the source document being scanned (limited by <code>&lt;scanArea&gt;</code>) 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.
                     </p>

      • gs1

        protected Boolean gs1
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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)</p>

      • tryHarder

        protected Boolean tryHarder
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • allowedLengths

        protected String allowedLengths
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>

      • barcode39CheckDigit

        protected Boolean barcode39CheckDigit
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the system will assume that all recognized Code 39 barcodes contain a correct check digit.</p>

      • codabarStartEndDigits

        protected Boolean codabarStartEndDigits
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the start and stop symbols of recognized Codabar barcodes will be read instead of removed during recognition.</p>

      • upcEanExtensions

        protected String upcEanExtensions
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>

      • charset

        protected String charset
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the character set in which the barcode contents are stored.</p>

      • formats

        protected String formats
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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 <code>&lt;add&gt;</code>, i.e., the following are the barcode names available:
                         <ul><li>qrcode</li><li>aztec</li><li>codabar</li><li>code128</li><li>code39</li><li>datamatrix</li><li>ean13</li><li>ean8</li><li>itf</li><li>pdf417</li><li>upca</li></ul></p>

    • Constructor Detail

      • BarcodeSelectionType

        public BarcodeSelectionType()

    • Method Detail

      • getScanArea

        public RectangleType getScanArea()
        Gets the value of the scanArea property.
        Returns:
        possible object is RectangleType

      • setScanArea

        public void setScanArea​(RectangleType value)
        Sets the value of the scanArea property.
        Parameters:
        value - allowed object is RectangleType

      • isSetScanArea

        public boolean isSetScanArea()

      • getPages

        public String getPages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>
        Returns:
        possible object is String

      • setPages

        public void setPages​(String value)
        Sets the value of the pages property.
        Parameters:
        value - allowed object is String
        See Also:
        getPages()

      • isSetPages

        public boolean isSetPages()

      • getResolution

        public int getResolution()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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).</p>
        Returns:
        possible object is Integer

      • setResolution

        public void setResolution​(int value)
        Sets the value of the resolution property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getResolution()

      • isSetResolution

        public boolean isSetResolution()

      • unsetResolution

        public void unsetResolution()

      • isPureBarcode

        public boolean isPureBarcode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the system will assume that the source document being scanned (limited by <code>&lt;scanArea&gt;</code>) 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.
                     </p>
        Returns:
        possible object is Boolean

      • setPureBarcode

        public void setPureBarcode​(boolean value)
        Sets the value of the pureBarcode property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isPureBarcode()

      • isSetPureBarcode

        public boolean isSetPureBarcode()

      • unsetPureBarcode

        public void unsetPureBarcode()

      • isGs1

        public boolean isGs1()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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)</p>
        Returns:
        possible object is Boolean

      • setGs1

        public void setGs1​(boolean value)
        Sets the value of the gs1 property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isGs1()

      • isSetGs1

        public boolean isSetGs1()

      • unsetGs1

        public void unsetGs1()

      • isTryHarder

        public boolean isTryHarder()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setTryHarder

        public void setTryHarder​(boolean value)
        Sets the value of the tryHarder property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isTryHarder()

      • isSetTryHarder

        public boolean isSetTryHarder()

      • unsetTryHarder

        public void unsetTryHarder()

      • getAllowedLengths

        public String getAllowedLengths()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>
        Returns:
        possible object is String

      • setAllowedLengths

        public void setAllowedLengths​(String value)
        Sets the value of the allowedLengths property.
        Parameters:
        value - allowed object is String
        See Also:
        getAllowedLengths()

      • isSetAllowedLengths

        public boolean isSetAllowedLengths()

      • isBarcode39CheckDigit

        public boolean isBarcode39CheckDigit()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the system will assume that all recognized Code 39 barcodes contain a correct check digit.</p>
        Returns:
        possible object is Boolean

      • setBarcode39CheckDigit

        public void setBarcode39CheckDigit​(boolean value)
        Sets the value of the barcode39CheckDigit property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isBarcode39CheckDigit()

      • isSetBarcode39CheckDigit

        public boolean isSetBarcode39CheckDigit()

      • unsetBarcode39CheckDigit

        public void unsetBarcode39CheckDigit()

      • isCodabarStartEndDigits

        public boolean isCodabarStartEndDigits()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the start and stop symbols of recognized Codabar barcodes will be read instead of removed during recognition.</p>
        Returns:
        possible object is Boolean

      • setCodabarStartEndDigits

        public void setCodabarStartEndDigits​(boolean value)
        Sets the value of the codabarStartEndDigits property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isCodabarStartEndDigits()

      • isSetCodabarStartEndDigits

        public boolean isSetCodabarStartEndDigits()

      • unsetCodabarStartEndDigits

        public void unsetCodabarStartEndDigits()

      • getUpcEanExtensions

        public String getUpcEanExtensions()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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")</p>
        Returns:
        possible object is String

      • setUpcEanExtensions

        public void setUpcEanExtensions​(String value)
        Sets the value of the upcEanExtensions property.
        Parameters:
        value - allowed object is String
        See Also:
        getUpcEanExtensions()

      • isSetUpcEanExtensions

        public boolean isSetUpcEanExtensions()

      • getCharset

        public String getCharset()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the character set in which the barcode contents are stored.</p>
        Returns:
        possible object is String

      • setCharset

        public void setCharset​(String value)
        Sets the value of the charset property.
        Parameters:
        value - allowed object is String
        See Also:
        getCharset()

      • isSetCharset

        public boolean isSetCharset()

      • getFormats

        public String getFormats()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p122528_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p474718_="https://jakarta.ee/xml/ns/jaxb" xmlns:p929760_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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 <code>&lt;add&gt;</code>, i.e., the following are the barcode names available:
                         <ul><li>qrcode</li><li>aztec</li><li>codabar</li><li>code128</li><li>code39</li><li>datamatrix</li><li>ean13</li><li>ean8</li><li>itf</li><li>pdf417</li><li>upca</li></ul></p>
        Returns:
        possible object is String

      • setFormats

        public void setFormats​(String value)
        Sets the value of the formats property.
        Parameters:
        value - allowed object is String
        See Also:
        getFormats()

      • isSetFormats

        public boolean isSetFormats()