Class BarcodeTool
java.lang.Object
com.logicaldoc.barcode.automation.BarcodeTool
Class to extract barcode contents from inside the Automation
- Since:
- 8.1
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionExtracts all the barcodes scanning the whole documentExtracts all the barcodes scanning a given fileextractBarcode
(com.logicaldoc.core.document.Document doc, BarcodeSpec zone) Extracts the barcode in a given zone of a documentextractBarcode
(com.logicaldoc.core.document.Document doc, String possibleFormats) Extracts the first barcodeextractBarcode
(String filePath, BarcodeSpec zone, String tenant) Extracts the barcode in a given zone of a fileextractBarcode
(String filePath, String tenant, String possibleFormats) Extracts the first barcode scanning a given filevoid
processDocument
(com.logicaldoc.core.document.Document doc, String username) Processes a document trying to fill the fields using the barcodes the barcodes
-
Constructor Details
-
BarcodeTool
public BarcodeTool()
-
-
Method Details
-
extract
Extracts all the barcodes scanning the whole document- Parameters:
doc
- the document to processpossibleFormats
- optional list of barcode formats- Returns:
- the found barcode values ordered by position
-
extract
Extracts all the barcodes scanning a given file- Parameters:
filePath
- path of the file to processtenant
- name of the current tenantpossibleFormats
- optional list of barcode formats- Returns:
- the found barcode values ordered by position
-
extractBarcode
Extracts the first barcode- Parameters:
doc
- the document to processpossibleFormats
- optional list of barcode formats- Returns:
- the found barcode
-
extractBarcode
Extracts the first barcode scanning a given file- Parameters:
filePath
- path of the file to processtenant
- name of the current tenantpossibleFormats
- optional list of barcode formats- Returns:
- the found barcode
-
extractBarcode
Extracts the barcode in a given zone of a document- Parameters:
doc
- the document to processzone
- the zone to consider- Returns:
- the found barcode
-
extractBarcode
Extracts the barcode in a given zone of a file- Parameters:
filePath
- the path of the file to processzone
- the zone to considertenant
- name of the current tenant- Returns:
- the found barcode
-
processDocument
Processes a document trying to fill the fields using the barcodes the barcodes- Parameters:
doc
- the document to processusername
- the user in whose name the method is run
-