de.elo.client.scripting.items
Class IntrayDocument

java.lang.Object
  de.elo.client.scripting.items.IndexedElement
      de.elo.client.scripting.items.IntrayDocument

public class IntrayDocument
extends IndexedElement

Überschrift: InTrayDocument

Beschreibung: Ein Dokument im InTray (Postbox). Dies ist noch nicht im ELO-Archiv abgelegt.

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2008, 2011

Constructor Summary

IntrayDocument(de.elo.client.maindialog.Workspace workspace, de.elo.client.intray.IntrayData data)
Normaler Konstruktor.

Method Summary

boolean	del() Löscht das Element (und alle Referenzen darauf).
java.util.List<java.lang.String>	getBarcodes(java.lang.String barcodeRules) Liest die Barcodes dieses Dokumentes anhand der angegebenen Regeln.
java.io.File	getDocumentFile() Liefert die Dokumentdatei zurück.
de.elo.ix.client.EditInfo	getDoublet() Liefert die zu diesem Dokument passende Doublette aus dem Archiv (falls vorhanden).
de.elo.ix.client.EditInfo	getEditInfo() Liefert das zugehörige EditInfo-Objekt zurück.
java.lang.String	getFilePath() Liefert den Pfad zu der Dokumentdatei in der "Postbox" (InTray).
java.lang.String	getOcrRectangleText(int startX, int startY, int endX, int endY) Liefert den im Rechteck enthaltenen Text.
java.lang.String	getOcrText() Liefert den kompletten von der OCR erkannten Text.
java.util.SortedSet<java.lang.String>	getOcrWords() Liefert alle von der OCR erkannten Wörter.
boolean	hasIndexing() Prüft, ob für dieses Dokument bereits eine Verschlagwortung vorgenommen wurde.
boolean	hasOcrText() Prüft, ob OCR-Daten für das Dokument vorhanden sind.
ArchiveDocument	insertIntoArchive(int parentId, java.lang.String version, java.lang.String comment) Legt das Dokument im Archiv ab.
boolean	isDoublet() Prüft, ob dieses Dokument eine Doublette zu einem Dokument im Archiv ist.
boolean	isOcrDone() Prüft, ob das Dokument bereits von der OCR bearbeitet wurde.
de.elo.ix.client.Sord	loadSord() Liest die Verschlagwortung ein und liefert diese als Sord-Objekt.
void	setSord(de.elo.ix.client.Sord sord) Setzt die Verschlagwortung.

Methods inherited from class de.elo.client.scripting.items.IndexedElement

getDocMaskId, getDocMaskName, getHiddenText, getName, getObjKeyValue, getObjKeyValue, getProperties, getSord, saveSord, setHiddenText, setMaskId, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntrayDocument

public IntrayDocument(de.elo.client.maindialog.Workspace workspace,
                      de.elo.client.intray.IntrayData data)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

data - Speicherobjekt für einen Postbox-Eintrag

Method Detail

getDocumentFile

public java.io.File getDocumentFile()

Liefert die Dokumentdatei zurück.

Returns:

File

getDoublet

public de.elo.ix.client.EditInfo getDoublet()
                                     throws java.lang.Exception

Liefert die zu diesem Dokument passende Doublette aus dem Archiv (falls vorhanden).

Returns:

EditInfo-Objekt der Doublette oder null falls keine Dublette vorhanden

Throws:

java.lang.Exception

Since:

7.00.004

isDoublet

public boolean isDoublet()
                  throws java.lang.Exception

Prüft, ob dieses Dokument eine Doublette zu einem Dokument im Archiv ist.

Returns:

boolean True, wenn ein (laut MD5-Hash) gleiches Archivdokument gefunden wurde.

Throws:

java.lang.Exception

Since:

7.00.004

getFilePath

public java.lang.String getFilePath()

Liefert den Pfad zu der Dokumentdatei in der "Postbox" (InTray).

Returns:

String

loadSord

public de.elo.ix.client.Sord loadSord()
                               throws java.lang.Exception

Liest die Verschlagwortung ein und liefert diese als Sord-Objekt. Diese wird in einer ESW-Datei in der Postbox gespeichert. Ist noch keine Verschlagwortung vorhanden, so wird eine angelegt und die Kurzbezeichnung mit dem Dateinamen (ohne Extension) vorbelegt. Die Maske wird dabei passend zum Dateityp unter Berücksichtigung der Default-Maske vorgewählt.

Specified by:

loadSord in class IndexedElement

Returns:

Sord

Throws:

java.lang.Exception

getEditInfo

public de.elo.ix.client.EditInfo getEditInfo()

Description copied from class: IndexedElement

Liefert das zugehörige EditInfo-Objekt zurück.

Specified by:

getEditInfo in class IndexedElement

Returns:

EditInfo

setSord

public void setSord(de.elo.ix.client.Sord sord)
             throws java.lang.Exception

Setzt die Verschlagwortung. Die Daten werden in einer ESW-Datei in der Postbox (InTray) gespeichert.

Specified by:

setSord in class IndexedElement

Parameters:

sord - Sord Archivobjekt

Throws:

java.lang.Exception

insertIntoArchive

public ArchiveDocument insertIntoArchive(int parentId,
                                         java.lang.String version,
                                         java.lang.String comment)
                                  throws de.elo.client.guiutil.exception.DecryptCanceledException,
                                         java.lang.Exception

Legt das Dokument im Archiv ab. Das Ablageziel (ein Strukturelement im Archiv) wird über dessen ObjektID festgelegt. Versionsnummer und Kommentar zu der Version werden übertragen. Es wird nicht auf Dubletten geprüft, sondern immer erneut abgelegt. Eine Verschlagwortung "on demand" findet ebenfalls nicht statt.

Parameters:

parentId - ObjektID des Strukturelement in welches das Dokument abgelegt werden soll

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

Returns:

ArchiveDocument das im Archiv abgelegte Dokument (seit 6.00.100)

Throws:

de.elo.client.guiutil.exception.DecryptCanceledException

java.lang.Exception

getBarcodes

public java.util.List<java.lang.String> getBarcodes(java.lang.String barcodeRules)
                                             throws java.lang.Exception

Liest die Barcodes dieses Dokumentes anhand der angegebenen Regeln. Falls keine den Regeln entsprechenden Barcodes erkannt wurden, ist die zurückgegebene Liste leer.

Parameters:

barcodeRules - Regeln für die Barcode-Erkennung

Returns:

List die erkannten Barcodes des Dokuments.

Throws:

java.lang.Exception

Since:

6.00.092

isOcrDone

public boolean isOcrDone()

Prüft, ob das Dokument bereits von der OCR bearbeitet wurde. Dies passiert für alle Dateien, welche in die Postbox gelegt werden automatisch im Hintergrund. Dokumenttypen, welche die OCR nicht unterstützt, werden nach ihrer Betrachtung auch als Bearbeitet markiert.

Ob die OCR erfolgreich war und Text erkannt wurde, ermittelt die Methode hasOcrText().

Returns:

True, wenn die Datei bereits von der OCR bearbeitet wurde

Since:

7.00.000

hasOcrText

public boolean hasOcrText()

Prüft, ob OCR-Daten für das Dokument vorhanden sind. Dies kann nur dann der Fall sein, wenn die Datei vom OCR-Dienst bereits bearbeitet wurde (isOcrDone == true) und es ein von der OCR unterstützer Dokumententyp ist.

Die OCR benötigt eine lokal installierte ELO OCR Komponente. Fehlt diese, so ist hasOcrData immer false.

Returns:

True, wenn per OCR ermittelte Texte für das Dokument vorliegen.

Since:

7.00.000

getOcrText

public java.lang.String getOcrText()
                            throws java.lang.Exception

Liefert den kompletten von der OCR erkannten Text.

Es kann vorher geprüft werden, ob das Dokument bereits von der OCR bearbeitet wurde (isOcrDone) und ob dabei Text erkannt wurde (hasOcrText).

Returns:

String

Throws:

java.lang.Exception

Since:

7.00.000

getOcrWords

public java.util.SortedSet<java.lang.String> getOcrWords()
                                                  throws java.lang.Exception

Liefert alle von der OCR erkannten Wörter.

Es kann vorher geprüft werden, ob das Dokument bereits von der OCR bearbeitet wurde (isOcrDone) und ob dabei Text erkannt wurde (hasOcrText).

Returns:

SortedSet allen erkannten Wörtern, sortiert, jedes nur einmal

Throws:

java.lang.Exception

Since:

7.00.000

getOcrRectangleText

public java.lang.String getOcrRectangleText(int startX,
                                            int startY,
                                            int endX,
                                            int endY)
                                     throws java.lang.Exception

Liefert den im Rechteck enthaltenen Text. Die Koordinaten sind in Promille angegeben, 0,0,999,999 bezeichnet also die ganze Seite.

Parameters:

startX - X-Koordinate des Startpunkts (in Promille der Seite)

startY - Y-Koordinate des Startpunkts (in Promille der Seite)

endX - X-Koordinate des Endpunkts (in Promille der Seite)

endY - Y-Koordinate des Endpunkts (in Promille der Seite)

Returns:

String im Rechteck enthaltener Text

Throws:

java.lang.Exception

Since:

7.00.000

hasIndexing

public boolean hasIndexing()

Prüft, ob für dieses Dokument bereits eine Verschlagwortung vorgenommen wurde.

Returns:

True, wenn eine Verschlagwortung vorhanden ist, False sonst.

Since:

7.00.004

del

public boolean del()
            throws java.lang.Exception

Description copied from class: IndexedElement

Löscht das Element (und alle Referenzen darauf).

Specified by:

del in class IndexedElement

Returns:

True wenn erfolgreiche gelöscht wurde, False bei Fehlern

Throws:

java.lang.Exception