searchDesign
Class DocumentData

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

public class DocumentData
extends Data
implements DocumentDataInterface

Beschreibung:DocumentData implementiert das DocumentDataInterface und ist eine Erweiterung der abstrakten Klasse Data Ein DocumentData ist in einer Direktzugriffsstruktur in einem KeyData enthalten. Es speichert eine Document-ID und die Fundstellen des Keys als zwei parallel verwaltete Arrays, positionen und abstaende.

Author:
Fabian Steeg
See Also:
Serialized Form

Constructor Summary
DocumentData()
           
 
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, also einen String bei KeyData- und einen Integer bei DocumentData-Objekten, und durch den Rückgabewert anzeigt, ob dieser kleiner (<0), größer (>0) oder gleich(==0) dem gespeicherten Schlüssel ist.
 java.lang.Object getKey()
          getKey() gibt den Schlüssel des jeweiligen Objektes zurück, bei KeyData ist dies das Schlüsselwort als String, bei DocumentData die ID als Integer-Objekt.
 int[] getPositions()
          getPositions() gibt ein Array zurück, welches die Fundstellen des verwalteten Keys enthält.
 float getRank()
           
 short[] getSpaces()
          gibt ein Array zurück, dessen Länge genau der Anzahl der gespeicherten Spaces entspricht
 void initialize(int documentID, int position, short space)
          Funktion, durch die eine Klasse, die dieses Interface implementiert, initialisiert wird.
 void setRank(double rank)
           
 int size()
          gibt die Anzahl der gespeicherten Fundstellen zurück
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentData

public DocumentData()
Method Detail

setRank

public void setRank(double rank)

getRank

public float getRank()

initialize

public void initialize(int documentID,
                       int position,
                       short space)
Description copied from interface: DocumentDataInterface
Funktion, durch die eine Klasse, die dieses Interface implementiert, initialisiert wird.
Specified by:
initialize in interface DocumentDataInterface
Tags copied from interface: DocumentDataInterface
Parameters:
docID - vom Parser verwaltete ID des aktuellen Dokuments, die auch in der docmap-Datei gespeichert wird
position - Byte-Position des ersten Buchstaben des Schlüsselwortes im Text
space - Anzahl der Nichtwortzeichen (inkl. HTML-Tags) zwischen Schlüsselwort und dem vorigen Wort (unabhängig davon, ob letzteres ein Stopwort ist oder nicht) im Text

getKey

public java.lang.Object getKey()
Description copied from class: Data
getKey() gibt den Schlüssel des jeweiligen Objektes zurück, bei KeyData ist dies das Schlüsselwort als String, bei DocumentData die ID als Integer-Objekt.
Overrides:
getKey in class Data
Tags copied from class: Data
Returns:
key - der Schlüssel des Objektes

compareTo

public int compareTo(java.lang.Object other)
Description copied from class: Data
Vergleichsfunktion, die einen Schlüssel "other" erwartet, also einen String bei KeyData- und einen Integer bei DocumentData-Objekten, 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
Tags copied from class: Data
Parameters:
other - Der Schlüssel, mit dem verglichen wird
Returns:
das Ergebnis des Vergleichs

add

public void add(java.lang.Object other)
Description copied from class: Data
add wird beim Einfügen eines Data-Objektes in eine Direktzugriffsstruktur benutzt, wenn in dieser bereits ein Objekt mit gleichem Schlüssel gespeichert ist. Falls es sich bei other um ein KeyData handelt, werden die DocumentData akkumuliert. Falls es sich um ein DocumentData handelt, werden die Positionen und Spaces akkumuliert.
Overrides:
add in class Data
Tags copied from class: Data
Parameters:
other - das Objekt, das hinzugefuegt werden soll

getPositions

public int[] getPositions()
Description copied from interface: DocumentDataInterface
getPositions() gibt ein Array zurück, welches die Fundstellen des verwalteten Keys enthält. Die Länge des Arrays entspricht genau der Anzahl der gespeicherten Positionen.
Specified by:
getPositions in interface DocumentDataInterface
Tags copied from interface: DocumentDataInterface
Returns:
ein Array mit gespeicherten Positionsangaben

getSpaces

public short[] getSpaces()
gibt ein Array zurück, dessen Länge genau der Anzahl der gespeicherten Spaces entspricht
Specified by:
getSpaces in interface DocumentDataInterface
Returns:
ein Array mit gespeicherten Space-Angaben

size

public int size()
gibt die Anzahl der gespeicherten Fundstellen zurück
Specified by:
size in interface DocumentDataInterface
Returns:
die Anzahl der gespeicherten Fundstellen