xApi.xArchive
Class xArchiver

java.lang.Object
  extended byxApi.xArchive.xArchiver

public class xArchiver
extends java.lang.Object

Mainclass of the archivesystem.
This class contains methods to put documents into the archive and to get them from there. The class uses threads to put the documents into the archivesystem.
---------------------------------------------------------------------------------------------------
Hauptklasse des Archivsystems.
Die Klasse verfügt über Funktionen um das Archivsystem zu befüllen und Einträge daraus zu ermitteln. Das Einfügen eines Dokumentes geschieht jeweils als separater Thread.


Field Summary
static int SEARCH_AND
          Set the searchmode AND.
static int SEARCH_OR
          Set the searchmode OR.
 
Constructor Summary
xArchiver()
           
 
Method Summary
static void expire(long index)
          Set a document to expired.
static void flushWordList()
          Den internen Cache des Archivsystems auf Platte schreiben.
static org.w3c.dom.Document getDocument(long index)
          Ein Dokument aus dem Archivsystem lösen.
 java.util.Date getDocumentDate(long index)
          Ein Dokumentendatum aus dem Archivsystem lösen.
static java.lang.String getDocumentDescription(long index)
          Ein Dokumentenbeschreibung aus dem Archivsystem lösen.
 long insert(org.w3c.dom.Document xmlDoc, java.lang.String description)
          Ein Dokument ins Archivsystem einfügen.
static xArchiverSearchResult searchDocuments(java.lang.String search, int mode, long maxRecs)
          Executing a query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEARCH_OR

public static final int SEARCH_OR
Set the searchmode OR.
---------------------------------------------------------------------------------------------------
Suchmodus für 'Odersuche'.

See Also:
Constant Field Values

SEARCH_AND

public static final int SEARCH_AND
Set the searchmode AND.
---------------------------------------------------------------------------------------------------
Suchmodus für 'Undsuche'.

See Also:
Constant Field Values
Constructor Detail

xArchiver

public xArchiver()
Method Detail

expire

public static final void expire(long index)
Set a document to expired.
The document will be no longer available in the archivesystem.

Parameter:
   Index of the document.

---------------------------------------------------------------------------------------------------
Ein Dokument auf 'verfallen' setzen.
Das Dokument wird dann durch den Garbagecollector des Archivsystems entfernt und steht nicht mehr für die Suche zur Verfügung.
Das Dokument wird jedoch komprimiert und in das Expired- Verzeichnis des Archivsystems kopiert.

Parameter:
   Index des zu löschenden Dokuments.


searchDocuments

public static final xArchiverSearchResult searchDocuments(java.lang.String search,
                                                          int mode,
                                                          long maxRecs)
                                                   throws java.lang.Exception
Executing a query.
Als Suchstring kann eine Liste von Wörtern als String angegeben werden, die durch Leerzeichen oder Komma separiert ist.
Bei der Odersuche werden alle Dokumente geliefert, die mindestens einen der Suchbegriffe beinhalten, bei der Undsuche alle Dokumente, die alle Suchbegriffe beinhalten.
Parameter:
  Searchstring
  Searchmode (SEARCH_OR or SEARCH_AND)
---------------------------------------------------------------------------------------------------
Dokumente im Archivsystem suchen.
Als Suchstring kann eine Liste von Wörtern als String angegeben werden, die durch Leerzeichen oder Komma separiert ist.
Bei der Odersuche werden alle Dokumente geliefert, die mindestens einen der Suchbegriffe beinhalten, bei der Undsuche alle Dokumente, die alle Suchbegriffe beinhalten.
Parameter:
  Suchstring
  Suchmodus (SEARCH_OR or SEARCH_AND)

Throws:
java.lang.Exception

flushWordList

public static final void flushWordList()
Den internen Cache des Archivsystems auf Platte schreiben. Dies muss vor dem Beenden des Archivsystems erfolgen. Es sollte auch nach jedem Einfügen eines neues Dokuments erfolgen.


insert

public long insert(org.w3c.dom.Document xmlDoc,
                   java.lang.String description)
Ein Dokument ins Archivsystem einfügen. Parameter sind das einzufügende Dokument (ein beliebiges XML- Document) und optional eine Beschreibung (null ist erlaubt). Rückgabewert ist der Index, unter dem das Dokument eingefügt wurde.


getDocument

public static final org.w3c.dom.Document getDocument(long index)
Ein Dokument aus dem Archivsystem lösen. Parameter ist der Index, unter dem das Dokument eingefügt wurde. Wird kein Dokument unter diesem Index gefunden, dann wird 'null' zurückgegeben, ansonsten das XML- Dokument.


getDocumentDescription

public static final java.lang.String getDocumentDescription(long index)
Ein Dokumentenbeschreibung aus dem Archivsystem lösen. Parameter ist der Index, unter dem das Dokument eingefügt wurde. Wird keine Dokumentenbeschreibung unter diesem Index gefunden, dann wird 'null' zurückgegeben, ansonsten die Beschreibung als String.


getDocumentDate

public java.util.Date getDocumentDate(long index)
Ein Dokumentendatum aus dem Archivsystem lösen. Parameter ist der Index, unter dem das Dokument eingefügt wurde. Wird keine Dokumentendatum unter diesem Index gefunden, dann wird 'null' zurückgegeben, ansonsten das Einfügedatum des Dokuments.