aspose.barcode 21.8.5 → 21.9.5

package/lib/AsposeBarcode.js

@@ -7,7 +7,7 @@ const recognition_ = require("./Recognition");
 
 function pushJar()
 {
-    java.classpath.push(__dirname + "/aspose-barcode-nodejs-21.8.jar");
+    java.classpath.push(__dirname + "/aspose-barcode-nodejs-21.9.jar");
 }
 pushJar();
 

package/lib/Recognition.js

@@ -16,9 +16,8 @@ const joint = require("./Joint");
 class BarCodeReader extends joint.BaseJavaClass
 {
     qualitySettings;
-    barcodeRegion;
-    code128DataPortions;
     recognizedResults;
+    barcodeSettings;
 
     static get javaClassName()
     {
@@ -68,7 +67,11 @@ class BarCodeReader extends joint.BaseJavaClass
         try
         {
             let java_class_link = new java.import(BarCodeReader.javaClassName);
-            let java_class = new java_class_link(image, rectangles, decodeTypes);
+            let java_class = null;
+            if(image == null && rectangles == null && image == null)
+                java_class = new java_class_link();
+            else
+                java_class = new java_class_link(image, rectangles, decodeTypes);
             super(java_class);
             this.init()
         } catch (e)
@@ -78,6 +81,13 @@ class BarCodeReader extends joint.BaseJavaClass
         }
     }
 
+    static construct(javaClass)
+    {
+        let barcodeReader = new BarCodeReader(null, null, null);
+        barcodeReader.setJavaClass(javaClass);
+        return barcodeReader;
+    }
+
     static isPath(image)
     {
         if (image.length < 256 && image.includes("/") || image.includes("\\"))
@@ -152,6 +162,7 @@ class BarCodeReader extends joint.BaseJavaClass
     init()
     {
         this.qualitySettings = new QualitySettings(this.getJavaClass().getQualitySettingsSync());
+        this.barcodeSettings = BarcodeSettings.construct(this.getJavaClass().getBarcodeSettingsSync());
     }
 
     /**
@@ -387,13 +398,24 @@ class BarCodeReader extends joint.BaseJavaClass
      */
     readBarCodes()
     {
-        this.recognizedResults = [];
-        let javaReadBarcodes = this.getJavaClass().readBarCodesSync();
-        for (let i = 0; i < javaReadBarcodes.length; i++)
+        try
         {
-            this.recognizedResults[i] = new BarCodeResult(javaReadBarcodes[i]);
+            this.recognizedResults = [];
+            let javaReadBarcodes = this.getJavaClass().readBarCodesSync();
+            for (let i = 0; i < javaReadBarcodes.length; i++)
+            {
+                this.recognizedResults[i] = new BarCodeResult(javaReadBarcodes[i]);
+            }
+            return this.recognizedResults;
+        }
+        catch (e)
+        {
+            if((e.toString().includes("RecognitionAbortedException")))
+            {
+                throw new RecognitionAbortedException(e.toString(), null);
+            }
+            throw e;
         }
-        return this.recognizedResults;
     }
 
     /**
@@ -474,6 +496,15 @@ class BarCodeReader extends joint.BaseJavaClass
         this.getJavaClass().setQualitySettingsSync(value.getJavaClass());
     }
 
+    /**
+     * The main BarCode decoding parameters. Contains parameters which make influence on recognized data.
+     * @return The main BarCode decoding parameters
+     */
+    getBarcodeSettings()
+    {
+        return this.barcodeSettings;
+    }
+
     /**
      * A flag which force engine to detect codetext encoding for Unicode codesets.
      * @example
@@ -619,7 +650,39 @@ class BarCodeReader extends joint.BaseJavaClass
      */
     exportToXml(xmlFile)
     {
-        return this.getJavaClass().exportToXmlSync(xmlFile);
+        try
+        {
+            let xmlData = this.getJavaClass().exportToXmlSync();
+            let isSaved = xmlData != null;
+            if(isSaved)
+                fs.writeFileSync(xmlFile, xmlData);
+            return isSaved;
+        }
+        catch (ex)
+        {
+            let barcode_exception = new joint.BarcodeException(ex);
+            throw barcode_exception;
+        }
+    }
+
+    /**
+     * Exports BarCode properties to the xml-file specified
+     * @param xmlFile The name for the file
+     * @return Whether or not export completed successfully. Returns True in case of success; False Otherwise
+     */
+    static importFromXml(xmlFile)
+    {
+        try
+        {
+            let xmlData = fs.readFileSync(xmlFile).toString();
+            let java_class_link = new java.import(BarCodeReader.javaClassName);
+            return BarCodeReader.construct(java_class_link.importFromXmlSync(xmlData.substring(3, xmlData.length)));
+        }
+        catch (ex)
+        {
+            let barcode_exception = new joint.BarcodeException(ex);
+            throw barcode_exception;
+        }
     }
 }
 
@@ -2105,7 +2168,7 @@ class QualitySettings extends joint.BaseJavaClass
 
     /**
      * Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
-     * @param $value If True, allows engine to recognize 1D barcodes with checksum.
+     * @param value If True, allows engine to recognize 1D barcodes with checksum.
      */
     setCheckMore1DVariants(value)
     {
@@ -2582,6 +2645,374 @@ class DataBarExtendedParameters extends joint.BaseJavaClass
     }
 }
 
+/**
+ * AustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology.
+ */
+class AustraliaPostSettings extends joint.BaseJavaClass
+{
+    static get javaClassName()
+    {
+        return "com.aspose.mw.barcode.recognition.MwAustraliaPostSettings";
+    }
+
+    init()
+    {
+    }
+
+    /**
+     * AustraliaPostSettings constructor
+     */
+    constructor(settings)
+    {
+        if (settings != null)
+        {
+            super(settings.getJavaClass());
+        } else
+        {
+            let java_link = java.import(AustraliaPostSettings.javaClassName);
+            let australiaPostSettings = new java_link();
+            super(australiaPostSettings);
+        }
+    }
+
+    static construct(javaClass)
+    {
+        let australiaPostSettings = new AustraliaPostSettings(null);
+        australiaPostSettings.setJavaClass(javaClass);
+        return australiaPostSettings;
+    }
+
+    /**
+     * Gets or sets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.
+     * @return The interpreting type (CTable, NTable or Other) of customer information for AustralianPost BarCode
+     */
+    getCustomerInformationInterpretingType()
+    {
+        return this.getJavaClass().getCustomerInformationInterpretingTypeSync();
+    }
+
+    /**
+     * Gets or sets the Interpreting Type for the Customer Information of AustralianPost BarCode.DEFAULT is CustomerInformationInterpretingType.OTHER.
+     * @param value The interpreting type (CTable, NTable or Other) of customer information for AustralianPost BarCode
+     */
+    setCustomerInformationInterpretingType(value)
+    {
+        this.getJavaClass().setCustomerInformationInterpretingTypeSync(value);
+    }
+
+    /**
+     * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.
+     * CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "5912345678AB");
+     * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.C_TABLE);
+     * let image = generator.generateBarCodeImage(BarcodeImageFormat.PNG);
+     * let reader = new BarCodeReader(image, null, DecodeType.AUSTRALIA_POST);
+     * reader.getBarcodeSettings().getAustraliaPost().setCustomerInformationInterpretingType(CustomerInformationInterpretingType.C_TABLE);
+     * reader.getBarcodeSettings().getAustraliaPost().setIgnoreEndingFillingPatternsForCTable(true);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log("BarCode Type: ".result.getCodeType());
+     *     console.log("BarCode CodeText: ".result.getCodeText());
+     * });
+     *
+     * @return The flag which force AustraliaPost decoder to ignore last filling patterns during CTable method decoding
+     */
+    getIgnoreEndingFillingPatternsForCTable()
+    {
+        return this.getJavaClass().getIgnoreEndingFillingPatternsForCTableSync();
+    }
+
+    setIgnoreEndingFillingPatternsForCTable(value)
+    {
+        this.getJavaClass().setIgnoreEndingFillingPatternsForCTableSync(value);
+    }
+}
+
+class BarcodeSettings extends joint.BaseJavaClass
+{
+
+    _australiaPost;
+
+    static get javaClassName()
+    {
+        return "com.aspose.mw.barcode.recognition.MwBarcodeSettings";
+    }
+
+    /**
+     * BarcodeSettings copy constructor
+     * @param settings The source of the data
+     */
+    constructor(settings)
+    {
+        if (settings != null)
+        {
+            super(settings.getJavaClass());
+        } else
+        {
+            let java_link = java.import(BarcodeSettings.javaClassName);
+            let barcodeSettings = new java_link();
+            super(barcodeSettings);
+        }
+    }
+
+    /**
+     * BarcodeSettings copy constructor
+     * @param settings The source of the data
+     */
+    static construct(javaClass)
+    {
+        let barcodeSettings = new BarcodeSettings(null);
+        barcodeSettings.setJavaClass(javaClass);
+        return barcodeSettings;
+    }
+
+    init()
+    {
+        this._australiaPost = AustraliaPostSettings.construct(this.getJavaClass().getAustraliaPostSync());
+    }
+
+    /**
+     * Enable checksum validation during recognition for 1D and Postal barcodes.
+     * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
+     * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5
+     * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
+     * Checksum always used: Rest symbologies
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.EAN_13, "1234567890128");
+     * generator.save("c:/test.png", BarcodeImageFormat.PNG);
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
+     * //checksum disabled
+     * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *      console.log ("BarCode CodeText: ".result.getCodeText());
+     *      console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
+     *      console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
+     * });
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
+     * //checksum enabled
+     * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.ON);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *      console.log ("BarCode CodeText: " + result.CodeText);
+     *      console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
+     *      console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
+     * });
+     * @return Enable checksum validation during recognition for 1D and Postal barcodes.
+     */
+    getChecksumValidation()
+    {
+        return this.getJavaClass().getChecksumValidationSync();
+    }
+
+    /**
+     * Enable checksum validation during recognition for 1D and Postal barcodes.
+     * Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
+     * Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5
+     * Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
+     * Checksum always used: Rest symbologies
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.EAN_13, "1234567890128");
+     * generator.save("c:/test.png", BarcodeImageFormat.PNG);
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
+     * //checksum disabled
+     * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.OFF);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *      console.log ("BarCode CodeText: ".result.getCodeText());
+     *      console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
+     *      console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
+     * });
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.EAN_13);
+     * //checksum enabled
+     * reader.getBarcodeSettings().setChecksumValidation(ChecksumValidation.ON);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *      console.log ("BarCode CodeText: " + result.CodeText);
+     *      console.log ("BarCode Value: " + result.getExtended().getOneD().getValue());
+     *      console.log ("BarCode Checksum: " + result.getExtended().getOneD().getCheckSum());
+     * });
+     * @param value  Enable checksum validation during recognition for 1D and Postal barcodes.
+     */
+    setChecksumValidation(value)
+    {
+        this.getJavaClass().setChecksumValidationSync(value);
+    }
+
+    /**
+     * Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754");
+     * generator.save("c:/test.png", BarcodeImageFormat.PNG);
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
+     *
+     * //StripFNC disabled
+     * reader.getBarcodeSettings().setStripFNC(false);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log ("BarCode CodeText: ".result.getCodeText());
+     * });
+     *
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
+     *
+     * //StripFNC enabled
+     * reader.getBarcodeSettings().setStripFNC(true);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log ("BarCode CodeText: ".result.getCodeText());
+     * });
+     *
+     * @return Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
+     */
+    getStripFNC()
+    {
+        return this.getJavaClass().getStripFNCSync();
+    }
+
+    /**
+     * Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.GS_1_CODE_128, "(02)04006664241007(37)1(400)7019590754");
+     * generator.save("c:/test.png", BarcodeImageFormat.PNG);
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
+     *
+     * //StripFNC disabled
+     * reader.getBarcodeSettings().setStripFNC(false);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log ("BarCode CodeText: ".result.getCodeText());
+     * });
+     *
+     * let reader = new BarCodeReader("c:/test.png", DecodeType.CODE_128);
+     *
+     * //StripFNC enabled
+     * reader.getBarcodeSettings().setStripFNC(true);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log ("BarCode CodeText: ".result.getCodeText());
+     * });
+     *
+     * @param value  Strip FNC1, FNC2, FNC3 characters from codetext. Default value is false.
+     */
+    setStripFNC(value)
+    {
+        this.getJavaClass().setStripFNCSync(value);
+    }
+
+    /**
+     * The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
+     *
+     * Example
+     *
+     * let generator = new BarcodeGenerator(EncodeTypes.QR, "Слово"))
+     * $im = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
+     *
+     * //detects encoding for Unicode codesets is enabled
+     * let reader = new BarCodeReader(im, DecodeType.QR);
+     * reader.getBarcodeSettings().setDetectEncoding(true);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     * {
+     *     console.log ("BarCode CodeText: ".result.getCodeText());
+     * });
+     * //detect encoding is disabled
+     * let reader = new BarCodeReader(im, DecodeType.QR);
+     * reader.getBarcodeSettings().setDetectEncoding(false);
+     * reader.readBarCodes().forEach(function(result, i, results)
+     *     console.log ("BarCode CodeText: " + result.getCodeText());
+     *
+     * @return The flag which force engine to detect codetext encoding for Unicode codesets
+     */
+    getDetectEncoding()
+    {
+        return this.getJavaClass().getDetectEncodingSync();
+    }
+
+    setDetectEncoding(value)
+    {
+        this.getJavaClass().setDetectEncodingSync(value);
+    }
+
+    /**
+     * Gets AustraliaPost decoding parameters
+     * @return The AustraliaPost decoding parameters which make influence on recognized data of AustraliaPost symbology
+     */
+    getAustraliaPost()
+    {
+        return this._australiaPost;
+    }
+}
+
+class RecognitionAbortedException extends Error
+{
+    javaClass;
+
+    static get javaClassName()
+    {
+        return "com.aspose.mw.barcode.recognition.MwRecognitionAbortedException";
+    }
+    /**
+     * Gets the execution time of current recognition session
+     * @return The execution time of current recognition session
+     */
+    getExecutionTime()
+    {
+        return this.javaClass.getExecutionTimeSync();
+    }
+
+    /**
+     * Sets the execution time of current recognition session
+     * @param value The execution time of current recognition session
+     */
+    setExecutionTime(value)
+    {
+        this.javaClass.setExecutionTimeSync(value);
+    }
+
+    /**
+     * Initializes a new instance of the <see cref="RecognitionAbortedException" /> class with specified recognition abort message.
+     * @param message The error message of the exception.
+     * @param executionTime The execution time of current recognition session.
+     */
+    constructor(message, executionTime)
+    {
+        super(message);
+        let java_class_link = new java.import(RecognitionAbortedException.javaClassName);
+        if(message != null && executionTime != null)
+        {
+            this.javaClass = new java_class_link(message, executionTime);
+        }
+        else if (executionTime != null)
+        {
+            this.javaClass = new java_class_link(executionTime);
+        }
+        else
+            this.javaClass = new java_class_link();
+    }
+
+    static construct(javaClass)
+    {
+        let exception = new RecognitionAbortedException(null, null);
+        exception.javaClass = javaClass;
+        return exception;
+    }
+
+    init()
+    {
+
+    }
+}
+
 /**
  * Specify the type of barcode to read.
  * @example
@@ -3061,17 +3492,58 @@ Code128SubType =
  * @enum
  */
 CustomerInformationInterpretingType =
-    {
+{
+
         /**
          * Use C_TABLE to interpret the customer information. Allows A..Z, a..z, 1..9, space and # sing.
+         *
+         * @code
+         * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "5912345678ABCde");
+         * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.C_TABLE);
+         * let image = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
+         * let reader = new BarCodeReader(image, DecodeType.AUSTRALIA_POST);
+         * reader.setCustomerInformationInterpretingType(CustomerInformationInterpretingType.C_TABLE);
+         * reader.readBarCodes().forEach(function(result, i, results)
+         * {
+         *     print("BarCode Type: " + result.getCodeType());
+         *     print("BarCode CodeText: " + result.getCodeText());
+         * });
+         * @endcode
          */
         C_TABLE: 0,
+
         /**
          * Use N_TABLE to interpret the customer information. Allows digits.
+         *
+         * @code
+         *  let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "59123456781234567");
+         *  generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.N_TABLE);
+         *  let image = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
+         *  let reader = new BarCodeReader(image, DecodeType.AUSTRALIA_POST);
+         *  reader.setCustomerInformationInterpretingType(CustomerInformationInterpretingType.N_TABLE);
+         *  reader.readBarCodes().forEach(function(result, i, results)
+         *  {
+         *     print("BarCode Type: " + result.getCodeType());
+         *     print("BarCode CodeText: " + result.getCodeText());
+         *  });
+         * @endcode
          */
         N_TABLE: 1,
         /**
          * Do not interpret the customer information. Allows 0, 1, 2 or 3 symbol only.
+         *
+         * @code
+         * let generator = new BarcodeGenerator(EncodeTypes.AUSTRALIA_POST, "59123456780123012301230123");
+         * generator.getParameters().getBarcode().getAustralianPost().setAustralianPostEncodingTable(CustomerInformationInterpretingType.OTHER);
+         * let image = generator.generateBarcodeImage(BarcodeImageFormat.PNG);
+         * let reader = new BarCodeReader(image, DecodeType.AUSTRALIA_POST);
+         * reader.setCustomerInformationInterpretingType(CustomerInformationInterpretingType.OTHER));
+         * reader.readBarCodes().forEach(function(result, i, results)
+         * {
+         *    print("BarCode Type: " + result.getCodeType());
+         *    print("BarCode CodeText: " + result.getCodeText());
+         * });
+         * @endcode
          */
         OTHER: 2,
     };
@@ -3143,6 +3615,8 @@ module.exports = {
     Code128SubType,
     Code128DataPortion,
     DataBarExtendedParameters,
-
-    CustomerInformationInterpretingType
+    AustraliaPostSettings,
+    BarcodeSettings,
+    CustomerInformationInterpretingType,
+    RecognitionAbortedException
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aspose.barcode",
-  "version": "21.8.5",
+  "version": "21.9.5",
   "description": "barcode generation and recognition component",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"