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

Constructor Summary

Constructors
Constructor Description

IntrayDocument(Workspace workspace, IntrayData data)
Interner Konstruktor.

Method Summary

Modifier and Type	Method	Description
`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).
`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.

Methods inherited from class IndexedElement
getDocMask, getDocMaskId, getDocMaskName, getHiddenText, getMainScale, getName, getObjKeyValue, getObjKeyValue, getProperties, getReadableFileSize, getSord, saveSord, setHiddenText, setMainScale, setMaskId, setMaskIdWithDefaults, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IntrayDocument
```
public IntrayDocument(Workspace workspace,
                      IntrayData data)
```
    Interner Konstruktor.
    
    Parameters:
    
    workspace - Aktueller Arbeitsbereich
    
    data - Speicherobjekt für einen Postbox-Eintrag
- Method Detail
  - getDocumentFile
```
public File getDocumentFile()
```
    Liefert die Dokumentdatei zurück.
    
    Returns:
    
    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.
    
    Parameters:
    
    note - Neue Haftnotiz
    
    Since:
    
    9.03.000
  - getDoublet
```
public EditInfo getDoublet()
                    throws 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:
    
    Exception - Wenn der Serverzugriff fehlschlägt.
    
    Since:
    
    7.00.004
  - isDoublet
```
public boolean isDoublet()
                  throws 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:
    
    Exception - Wenn der Serverzugriff fehlschlägt.
    
    Since:
    
    7.00.004
  - getFilePath
```
public String getFilePath()
```
    Liefert den Pfad zu der Dokumentdatei in der "Postbox" (InTray).
    
    Returns:
    
    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.
    
    Specified by:
    
    loadSord in class IndexedElement
    
    Returns:
    
    Sord
    
    Throws:
    
    Exception - Wenn die Verschlagwortung nicht geladen werden kann.
  - getEditInfo
```
public 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(Sord sord)
             throws 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:
    
    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.
    
    Parameters:
    
    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.
    
    Throws:
    
    Exception - Wenn die Verschlagwortung nicht gespeichert werden kann.
    
    Since:
    
    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.
    
    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:
    
    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,
                                         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
    
    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
    
    Returns:
    
    ArchiveDocument das im Archiv abgelegte Dokument
    
    Throws:
    
    DecryptCanceledException - Wenn das Dokument nicht verschlüsselt werden konnte.
    
    Exception - Wenn das Dokument nicht eingecket werden konnte.
    
    Since:
    
    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.
    
    Parameters:
    
    barcodeRules - Regeln für die Barcode-Erkennung
    
    Returns:
    
    Die erkannten Barcodes des Dokuments.
    
    Throws:
    
    Exception - Wenn das lesen der Barcodes fehlschlägt.
    
    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 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).
    
    Returns:
    
    Erkannter Text.
    
    Throws:
    
    Exception - Wenn keine Texte erkannt wurden.
    
    Since:
    
    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).
    
    Returns:
    
    Alle erkannten Wörtern, sortiert, jedes nur einmal
    
    Since:
    
    7.00.000
  - 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.
    
    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:
    
    Im Rechteck enthaltener Text
    
    Throws:
    
    Exception - Wenn keine Texte erkannt wurden.
    
    Since:
    
    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.
    
    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)
    
    page - Seitennummer, 1-basiert
    
    Returns:
    
    Im Rechteck enthaltener Text
    
    Throws:
    
    Exception - Wenn keine Texte erkannt wurden.
    
    Since:
    
    8.04.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 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:
    
    Exception - Wenn das Objekt nichtr gelöscht werden kann.
  - deleteIndexing
```
public void deleteIndexing()
                    throws Exception
```
    Löscht die Verschlagwortung dieses Postbox Dokuments.
    
    Throws:
    
    Exception - Wenn die Verschlagwortung nicht gelöscht werden konnte.
    
    Since:
    
    9.00.000
  - isDocument
```
public boolean isDocument()
```
    Liefert true, wenn dieses Element ein Dokument ist.
    
    Specified by:
    
    isDocument in class IndexedElement
    
    Returns:
    
    boolean
    
    Since:
    
    8.04.000
  - isStructure
```
public boolean isStructure()
```
    Liefert true, wenn dieses Element ein Ordner ist.
    
    Specified by:
    
    isStructure in class IndexedElement
    
    Returns:
    
    boolean
    
    Since:
    
    8.04.000

Class IntrayDocument

Constructor Summary

Method Summary

Methods inherited from class IndexedElement

Methods inherited from class Object

Constructor Detail

IntrayDocument

Method Detail

getDocumentFile

addNote

getDoublet

isDoublet

getFilePath

loadSord

getEditInfo

setSord

setSord

insertIntoArchive

insertIntoArchive

getBarcodes

isOcrDone

hasOcrText

getOcrText

getOcrWords

getOcrRectangleText

getOcrRectangleText

hasIndexing

del

deleteIndexing

isDocument

isStructure