searchDesign
Class KeyData

java.lang.Object
  |
  +--searchDesign.Data
        |
        +--searchDesign.KeyData

public class KeyData
extends Data
implements KeyDataInterface, java.io.Serializable

Beschreibung: Ein KeyData speichert ein Schlüsselwort und eine Direktzugriffsstruktur mit DocumentData-Objekten, die jeweils die Fundstellen des Schlüsselwortes in einem Text enthalten.

Author:
Fabian Steeg
See Also:
Serialized Form

Constructor Summary
KeyData()
           
 
Method Summary
 void add(java.lang.Object other)
          add wird beim Einfügen eines Data-Objektes in eine Direktzugriffsstruktur benutzt, wenn in dieser bereits ein Objekt mit gleichem Schlüssel gespeichert ist.
 int compareTo(java.lang.Object other)
          Vergleichsfunktion, die einen Schlüssel "other" erwartet, hier einen String, und durch den Rückgabewert anzeigt, ob dieser kleiner (<0), größer (>0) oder gleich(==0) dem gespeicherten Schlüssel ist.
 StorageInterface getDocuments()
          gibt die Direktzugriffsstruktur als StorageInterface zurück, welche alle DocumentData von KeyData enthält
 java.lang.Object getKey()
          getKey() gibt den Schlüssel des jeweiligen Objektes zurück, hier das Schlüsselwort als String,
 void initialize(java.lang.String key, int position, short space, int documentID)
          Funktion, die aufgerufen werden muss, wenn ein KeyData initialisiert werden soll.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeyData

public KeyData()
Method Detail

initialize

public void initialize(java.lang.String key,
                       int position,
                       short space,
                       int documentID)
Funktion, die aufgerufen werden muss, wenn ein KeyData initialisiert werden soll. In dieser Funktion muss anhand der Informationen aus Settings.user entschieden werden, ob die DocumentData in einer Hashtable oder in einem Binärbaum gespeichert werden
Specified by:
initialize in interface KeyDataInterface
Parameters:
key - Schlüsselwort
position - Byte-Position des ersten Buchstaben von key im Text
space - Anzahl der Nichtwortzeichen (inkl. HTML-Tags) zwischen key und dem vorigen Wort (unabhängig davon, ob letzteres ein Stopwort ist oder nicht) im Text
docID - vom Parser verwaltete ID des aktuellen Dokuments, die auch in der docmap-Datei gespeichert wird

getDocuments

public StorageInterface getDocuments()
gibt die Direktzugriffsstruktur als StorageInterface zurück, welche alle DocumentData von KeyData enthält
Specified by:
getDocuments in interface KeyDataInterface
Returns:
das StorageInterface mit den entsprechenden DocumentData-Objekten

getKey

public java.lang.Object getKey()
getKey() gibt den Schlüssel des jeweiligen Objektes zurück, hier das Schlüsselwort als String,
Overrides:
getKey in class Data
Returns:
key - der Schlüssel des Objektes, hier das Wort

compareTo

public int compareTo(java.lang.Object other)
Vergleichsfunktion, die einen Schlüssel "other" erwartet, hier einen String, und durch den Rückgabewert anzeigt, ob dieser kleiner (<0), größer (>0) oder gleich(==0) dem gespeicherten Schlüssel ist.
Overrides:
compareTo in class Data
Parameters:
other - Der Schlüssel, mit dem verglichen wird, hier String
Returns:
das Ergebnis des Vergleichs

add

public void add(java.lang.Object other)
add wird beim Einfügen eines Data-Objektes in eine Direktzugriffsstruktur benutzt, wenn in dieser bereits ein Objekt mit gleichem Schlüssel gespeichert ist. Hier werden die DocumentData akkumuliert.
Overrides:
add in class Data
Parameters:
other - das Objekt, das hinzugefuegt werden soll, ein KeyData