Class BarcodeTool


  • public class BarcodeTool
    extends Object
    Class to extract barcode contents from inside the Automation
    Since:
    8.1
    Author:
    Marco Meschieri - LogicalDOC
    • Constructor Detail

      • BarcodeTool

        public BarcodeTool()
    • Method Detail

      • extract

        public List<String> extract​(com.logicaldoc.core.document.Document doc,
                                    String possibleFormats)
        Extracts all the barcodes scanning the whole document
        Parameters:
        doc - the document to process
        possibleFormats - optional list of barcode formats
        Returns:
        the found barcode values ordered by position
      • extract

        public List<String> extract​(String filePath,
                                    String tenant,
                                    String possibleFormats)
        Extracts all the barcodes scanning a given file
        Parameters:
        filePath - path of the file to process
        tenant - name of the current tenant
        possibleFormats - optional list of barcode formats
        Returns:
        the found barcode values ordered by position
      • extractBarcode

        public String extractBarcode​(com.logicaldoc.core.document.Document doc,
                                     String possibleFormats)
        Extracts the first barcode
        Parameters:
        doc - the document to process
        possibleFormats - optional list of barcode formats
        Returns:
        the found barcode
      • extractBarcode

        public String extractBarcode​(String filePath,
                                     String tenant,
                                     String possibleFormats)
        Extracts the first barcode scanning a given file
        Parameters:
        filePath - path of the file to process
        tenant - name of the current tenant
        possibleFormats - optional list of barcode formats
        Returns:
        the found barcode
      • extractBarcode

        public String extractBarcode​(com.logicaldoc.core.document.Document doc,
                                     BarcodeSpec zone)
        Extracts the barcode in a given zone of a document
        Parameters:
        doc - the document to process
        zone - the zone to consider
        Returns:
        the found barcode
      • extractBarcode

        public String extractBarcode​(String filePath,
                                     BarcodeSpec zone,
                                     String tenant)
        Extracts the barcode in a given zone of a file
        Parameters:
        filePath - the path of the file to process
        zone - the zone to consider
        tenant - name of the current tenant
        Returns:
        the found barcode
      • processDocument

        public void processDocument​(com.logicaldoc.core.document.Document doc,
                                    String username)
        Processes a document trying to fill the fields using the barcodes the barcodes
        Parameters:
        doc - the document to process
        username - the user in whose name the method is run