getBarcodes

Code

IBarcodeResult DocumentUtils.getBarcodes(String fileName, String barcodeType, boolean searchForSingleBarcode)

Beschreibung

Ermittelt alle Barcodes des gewünschten Typs aus der angegebenen Datei.
Neben Pdf werden folgende Grafikformate unterstützt: bmp, jpeg, png, gif, tiff (weitere sind möglich)

Parameter

• fileName
  Vollständiger Pfad der Datei.
• barcodeType
  Typ des Barcodes nach dem gesucht werden soll, z.B. "DataMatrix". Die unterstützen Barcodes sind in der Klasse BarcodeConstants hinterlegt, z.B. BarcodeConstants.BARCODE_FORMAT_DATAMATRIX
• searchForSingleBarcode
  Wenn Sie nur nach einem Barcode suchen, empfiehlt es sich, diesen Parameter zu aktivieren. Dies beschleunigt die Barcodeerkennung für TIFF- oder auch PDF-Dokumente deutlich. Möchten Sie alle Barcodes aus der Datei ermitteln, so ist der Parameter zu deaktivieren.

Rückgabe
Ergebnis der Barcodeerkennung
Folgende Methoden stehen in dem Rückgabeobjekt IBarcodeResult zur Verfügung

• String[] getBarcodes()
  Liefert die Liste der erkannten Barcodes
• boolean isSuccessful()
  Konnte die Barcodeerkennung ohne Fehler durchgeführt werden? Nicht zu verwechseln mit, ob Barcode gefunden wurde!
• String getErrorCode()
  Liefert den Fehlercode, falls die Barcodeerkennung nicht erfolgreich war. Die Fehlercodes stehen als Konstanten in der Klasse BarcodeConstants zur Verfügung, z.B.BarcodeConstants.BARCODE_ERRORCODE_GENERAL Mit Hilfe der Fehlercodes können individuelle Ausgaben im Skripting hinterlegt werden. Folgende Fehlercodes stehen zur Verfügung:
  • BarcodeConstants.BARCODE_ERRORCODE_NOTSUPPORTED_BARCODETYPE
    Diese Art von Barcode wird nicht unterstützt.
  • BarcodeConstants.BARCODE_ERRORCODE_NOTSUPPORTED_FILETYPE
    Dieser Dateityp wird bei der Barcodeerkennung nicht unterstützt.
  • BarcodeConstants.BARCODE_ERRORCODE_GENERAL
    Ein allgemeiner Fehler ist bei der Barcodeerkennung aufgetreten.

Beispiele

IBarcodeResult result =  DocumentUtils.getBarcodes("C:/temp/Angebot.pdf", BarcodeConstants.BARCODE_FORMAT_DATAMATRIX, true);
if (!result.isSuccessful())
{
  if (ScriptUtils.equal(BarcodeConstants.BARCODE_ERRORCODE_NOTSUPPORTED_BARCODETYPE, result.getErrorCode()))
  {
    //...Error handling...
  }
}
else
{
  String[] barcodes = result.getBarcodes();  
  for (String barcode : barcodes)
  {
    // Hinweis: Diese Methode steht nur im Benutzertask zur Verfügung.
    DialogUtils.showMessageDialog("Gefundener Barcode", barcode);
  }
}