Package de.elo.client.scripting.items

Klasse IntrayDocument

Object

IndexedElement

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-2015

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
IntrayDocument(Workspace workspace, IntrayData data)	Interner Konstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addNote(Note note)	Fügt eine neue Haftnotiz in das Postbox Dokument ein.
boolean	del()	Löscht das Element (und alle Referenzen darauf).
void	deleteIndexing()	Löscht die Verschlagwortung dieses Postbox Dokuments.
List<String>	getBarcodes(String barcodeRules)	Liest die Barcodes dieses Dokumentes anhand der angegebenen Regeln.
File	getDocumentFile()	Liefert die Dokumentdatei zurück.
EditInfo	getDoublet()	Liefert die zu diesem Dokument passende Doublette aus dem Archiv (falls vorhanden).
EditInfo	getEditInfo()	Liefert das zugehörige EditInfo-Objekt zurück.
String	getFilePath()	Liefert den Pfad zu der Dokumentdatei in der "Postbox" (InTray).
JsonObject	getFormData()	Liefert die Formulareingaben bei Metadaten 2.0.
String	getOcrRectangleText(int startX, int startY, int endX, int endY)	Liefert den im Rechteck enthaltenen Text.
String	getOcrRectangleText(int startX, int startY, int endX, int endY, int page)	Liefert den im Rechteck enthaltenen Text.
String	getOcrText()	Liefert den kompletten von der OCR erkannten Text.
SortedSet<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, String version, String comment)	Legt das Dokument im Archiv ab.
ArchiveDocument	insertIntoArchive(int parentId, String version, String comment, boolean isMilestone, boolean updateDocDate)	Legt das Dokument im Archiv ab.
boolean	isDocument()	Liefert true, wenn dieses Element ein Dokument ist.
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.
boolean	isStructure()	Liefert true, wenn dieses Element ein Ordner ist.
Sord	loadSord()	Liest die Verschlagwortung ein und liefert diese als Sord-Objekt.
void	setSord(Sord sord)	Setzt die Verschlagwortung.
void	setSord(Sord sord, boolean fireUIUpdate)	Setzt die Verschlagwortung.

Von Klasse geerbte Methoden IndexedElement

getDocMask, getDocMaskId, getDocMaskName, getHiddenText, getMainScale, getName, getObjKeyValue, getObjKeyValue, getProperties, getReadableFileSize, getSord, saveSord, setHiddenText, setMainScale, setMaskId, setMaskIdWithDefaults, setName, setObjKeyValue, setObjKeyValue, setProperties

Von Klasse geerbte Methoden Object

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

Konstruktordetails

IntrayDocument

public IntrayDocument(Workspace workspace,
 IntrayData data)

Interner Konstruktor.

Parameter:

workspace - Aktueller Arbeitsbereich

data - Speicherobjekt für einen Postbox-Eintrag

Methodendetails

getDocumentFile

public File getDocumentFile()

Liefert die Dokumentdatei zurück.

Gibt zurück:

Dokumentdatei

addNote

public void addNote(Note note)

Fügt eine neue Haftnotiz in das Postbox Dokument ein. Vor dem Aufruf muss der Preview Bereich gelöscht werden falls das Dokument gerade angezeigt wird. Das kann über ein preview.clear() oder aber auch durch ein intray.clearSelection() geschehen.

Parameter:

note - Neue Haftnotiz

Seit:

9.03.000

getDoublet

public EditInfo getDoublet()
                    throws Exception

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

Gibt zurück:

EditInfo-Objekt der Doublette oder null falls keine Dublette vorhanden

Löst aus:

Exception - Wenn der Serverzugriff fehlschlägt.

Seit:

7.00.004

isDoublet

public boolean isDoublet()
                  throws Exception

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

Gibt zurück:

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

Löst aus:

Exception - Wenn der Serverzugriff fehlschlägt.

Seit:

7.00.004

getFilePath

public String getFilePath()

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

Gibt zurück:

String

loadSord

public Sord loadSord()
              throws 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.

Angegeben von:

loadSord in Klasse IndexedElement

Gibt zurück:

Sord

Löst aus:

Exception - Wenn die Verschlagwortung nicht geladen werden kann.

getEditInfo

public EditInfo getEditInfo()

Beschreibung aus Klasse kopiert: IndexedElement

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

Angegeben von:

getEditInfo in Klasse IndexedElement

Gibt zurück:

EditInfo

setSord

public void setSord(Sord sord)
             throws Exception

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

Angegeben von:

setSord in Klasse IndexedElement

Parameter:

sord - Sord Archivobjekt

Löst aus:

Exception - Wenn die Verschlagwortung nicht gespeichert werden kann.

setSord

public void setSord(Sord sord,
 boolean fireUIUpdate)
             throws Exception

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

Parameter:

sord - Sord Archivobjekt

fireUIUpdate - Bestimmt, ob die Postboxtabelle neu gezeichnet werden soll. Bei FALSE muss am Ende des Vorgangs ein Postbox Refresh durchgeführt werden.

Löst aus:

Exception - Wenn die Verschlagwortung nicht gespeichert werden kann.

Seit:

9.02.004

insertIntoArchive

public ArchiveDocument insertIntoArchive(int parentId,
 String version,
 String comment)
                                  throws DecryptCanceledException,
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.

Parameter:

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

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

Gibt zurück:

ArchiveDocument das im Archiv abgelegte Dokument (seit 6.00.100)

Löst aus:

DecryptCanceledException - Wenn das Dokument nicht verschlüsselt werden konnte.

Exception - Wenn das Dokument nicht eingecket werden konnte.

insertIntoArchive

public ArchiveDocument insertIntoArchive(int parentId,
 String version,
 String comment,
 boolean isMilestone,
 boolean updateDocDate)
                                  throws DecryptCanceledException,
IOException,
CanceledByScriptException,
UploadAbortedException,
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.

Parameter:

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

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

isMilestone - True wenn die neue Version ein Meilenstein sein soll, False wenn nicht

updateDocDate - True um das Datum des Dokument auf das aktuelle Datum zu setzen, False für das Datum der Datei

Gibt zurück:

ArchiveDocument das im Archiv abgelegte Dokument

Löst aus:

DecryptCanceledException - Wenn das Dokument nicht verschlüsselt werden konnte.

UploadAbortedException

CanceledByScriptException

IOException

Exception - Wenn das Dokument nicht eingecket werden konnte.

Seit:

8.05.000

getBarcodes

public List<String> getBarcodes(String barcodeRules)
                         throws Exception

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

Parameter:

barcodeRules - Regeln für die Barcode-Erkennung

Gibt zurück:

Die erkannten Barcodes des Dokuments.

Löst aus:

Exception - Wenn das lesen der Barcodes fehlschlägt.

Seit:

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().

Gibt zurück:

True, wenn die Datei bereits von der OCR bearbeitet wurde

Seit:

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.

Gibt zurück:

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

Seit:

7.00.000

getOcrText

public String getOcrText()
                  throws 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).

Gibt zurück:

Erkannter Text.

Löst aus:

Exception - Wenn keine Texte erkannt wurden.

Seit:

7.00.000

getOcrWords

public SortedSet<String> getOcrWords()

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).

Gibt zurück:

Alle erkannten Wörtern, sortiert, jedes nur einmal

Seit:

7.00.000

getFormData

public JsonObject getFormData()

Liefert die Formulareingaben bei Metadaten 2.0.

Bei IndexedElement.saveSord() oder setSord(Sord) werden Modifikationen an diesem Objekt gespeichert.

Gibt zurück:

Metadaten 2.0 Formulareingaben

Seit:

23.00.012, 23.04.001

getOcrRectangleText

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

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

Parameter:

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)

Gibt zurück:

Im Rechteck enthaltener Text

Löst aus:

Exception - Wenn keine Texte erkannt wurden.

Seit:

7.00.000

getOcrRectangleText

public String getOcrRectangleText(int startX,
 int startY,
 int endX,
 int endY,
 int page)
                           throws Exception

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

Parameter:

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)

page - Seitennummer, 1-basiert

Gibt zurück:

Im Rechteck enthaltener Text

Löst aus:

Exception - Wenn keine Texte erkannt wurden.

Seit:

8.04.000

hasIndexing

public boolean hasIndexing()

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

Gibt zurück:

True, wenn eine Verschlagwortung vorhanden ist, False sonst.

Seit:

7.00.004

del

public boolean del()
            throws Exception

Beschreibung aus Klasse kopiert: IndexedElement

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

Angegeben von:

del in Klasse IndexedElement

Gibt zurück:

True wenn erfolgreiche gelöscht wurde, False bei Fehlern

Löst aus:

Exception - Wenn das Objekt nichtr gelöscht werden kann.

deleteIndexing

public void deleteIndexing()
                    throws Exception

Löscht die Verschlagwortung dieses Postbox Dokuments.

Löst aus:

Exception - Wenn die Verschlagwortung nicht gelöscht werden konnte.

Seit:

9.00.000

isDocument

public boolean isDocument()

Liefert true, wenn dieses Element ein Dokument ist.

Angegeben von:

isDocument in Klasse IndexedElement

Gibt zurück:

boolean

Seit:

8.04.000

isStructure

public boolean isStructure()

Liefert true, wenn dieses Element ein Ordner ist.

Angegeben von:

isStructure in Klasse IndexedElement

Gibt zurück:

boolean

Seit:

8.04.000