searchDesign
Interface KeyDataInterface

All Known Implementing Classes:
KeyData

public interface KeyDataInterface

Beschreibung: KeyDataInterface wird von der Klasse KeyData implementiert, welche eine Spezialisierung der abstrakten Klasse Data ist. Ein KeyData speichert ein Schlüsselwort und eine Direktzugriffsstruktur mit DocumentData-Objekten, die jeweils die Fundstellen des Schlüsselwortes in einem Text enthalten.

Version:
1.0

Method Summary
 StorageInterface getDocuments()
          gibt die Direktzugriffsstruktur als StorageInterface zurück, welche alle DocumentData von KeyData enthält
 void initialize(java.lang.String key, int position, short space, int docID)
          Funktion, die aufgerufen werden muss, wenn eine Klasse, die dieses Interface implementiert, initialisiert werden soll.
 

Method Detail

initialize

public void initialize(java.lang.String key,
                       int position,
                       short space,
                       int docID)
Funktion, die aufgerufen werden muss, wenn eine Klasse, die dieses Interface implementiert, 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
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
Returns:
das StorageInterface mit den entsprechenden DocumentData-Objekten