14.3. Einen Index durchsuchen

14.3.1. Abfrage erstellen

Es gibt zwei Arten, den Index zu durchsuchen. Die erste Methode verwendet den Query Parser, um eine Abfrage aus einem String zu erstellen. Die zweite ist die Möglichkeit, eigene Abfragen mithilfe der Zend_Search_Lucene Programmierschnittstelle (API) zu erstellen.

Vor der Verwendung des bereitgestellten Query Parsers, beachte bitte folgendes:

  1. Wenn du deine Abfragestrings programmseitig erstellst und dann durch den Query Parser verarbeiten lässt, solltest du ernsthaft darüber nachdenken, deine Abfragen direct mit der Programmierschnittstelle (API) für Abfragen zu erstellen. In anderen Worten, der Query Parser wurde für von Menschen eingegebene Texte und nicht für von Programmen erstellte Texte entwickelt.
  2. Nicht in einzelne Tokens aufgeteilte Felder werden am besten direkt zu der Abfrage und nicht über den Query Parser hinzugefügt. Wenn die Feldwerte durch die Anwendung programmseitig erstellt werden, dann sollte dies für Abfrageklauseln dieses Felds ebenfalls geschehen. Ein Analysator, welche der Query Parser verwendet, wurde entwickelt, um von Menschen eingegebenen Text in Begriffe zu konvertieren. Durch Programme erstellte Werte wie Datumsangaben, Schlüsselwörter, usw. sollten durchweg durch Programme erstellt werden.
  3. In einem Abfrageformular sollten generelle Textfelder den Query Parser verwenden. Alle anderen, wie z.B. Datumsbereiche, Schlüsselwörter, usw. werden besser direkt durch die Programmierschnittstelle (API) der Abfrage hinzugefügt. Ein Feld mit einem begrenzten Wertebereich, das durch ein Pulldown-Menü spezifiziert wird, sollte nicht einem Abfragestring hinzugefügt werden, der anschließend wieder geparst wird, sondern eher als eine TermQuery Klausel hinzugefügt werden.

Beide Arten verwenden die selbe Methode der Programmierschnittstelle (API), um den Index zu durchsuchen:

<?php

require_once('Zend/Search/Lucene.php');

$index = new Zend_Search_Lucene('/data/my_index');

$index->find($query);

?>

Die Zend_Search_Lucene::find() Methode ermittelt den Eingabetyp automatisch und verwendet den Query Parser, um ein entsprechendes Zend_Search_Lucene_Search_Query Objekt aus dem String zu erstellen.

Es ist wichtig zu beachten, dass find() die Groß- und Kleinschreibung beachtet. Standardmäßig normalisiert LuceneIndexCreation.jar alle Dokumente in Kleinschrift. Dies kann mithilfe einer Kommandozeilen Weiche abgestellt werden (gebe LuceneIndexCreation.jar ohne Argumente für eine Hilfe ein). Die Schreibweise des Textes, der an find() übergeben wird, muss mit dem des Index übereinstimmen. Wenn der Index in Kleinschrift normalisiert wurde, müssen alle Texte, die an find() übergeben werden, mittels strtolower() verkleinert werden. Andernfalls würde es keine Überstimmungen geben.

14.3.2. Suchergebnisse

Das Suchergebnis ist ein Array mit Zend_Search_Lucene_Search_QueryHit Objekten. Jedes davon hat zwei Eigenschaften: $hit->document ist eine Dokumentnummer innerhalb des Index und $hit->score ist ein Punktwert für den Treffer im Suchergebnis. Das Ergebnis wird anhand der Punktwerte sortiert (beste Treffer kommen zuerst)

Das Zend_Search_Lucene_Search_QueryHit Objekt beinhaltet zudem jedes Feld des Zend_Search_Lucene_Document, das gefunden wurde, als Eigenschaft des Treffers. In diesem Beispiel, wird ein Treffer zurückgegeben und das entsprechende Dokument hat zwei Felder: Titel und Autor.

<?php

require_once('Zend/Search/Lucene.php');

$index = new Zend_Search_Lucene('/data/my_index');

$hits = $index->find($query);

foreach ($hits as $hit) {
    echo $hit->score;
    echo $hit->title;
    echo $hit->author;
}

?>

Optional kann das originale Zend_Search_Lucene_Document Objekt vom Zend_Search_Lucene_Search_QueryHit Objekt zurückgegeben werden. Du kannst indizierte Teile des Dokuments durch Verwendung der getDocument() Methode des Indexobjektes zurückerhalten und diese dann durch die getFieldValue() Methode abfragen:

<?php

require_once('Zend/Search/Lucene.php');

$index = new Zend_Search_Lucene('/data/my_index');

$hits = $index->find($query);
foreach ($hits as $hit) {
    // gebe das Zend_Search_Lucene_Document Objekt für diesen Treffer zurück
    echo $document = $hit->getDocument();

    // gebe ein Zend_Search_Lucene_Field Objekt vom Zend_Search_Lucene_Document zurück
    echo $document->getField('title');

    // gebe den Stringwert des Zend_Search_Lucene_Field Objekts zurück
    echo $document->getFieldValue('title');

    // das gleiche wie getFieldValue()
    echo $document->title;
}

?>

Die Felder, die in einem Zend_Search_Lucene_Document Objekt verfügbar sind, werden beim Indizieren festgelegt. Die Dokumentenfelder werden durch die Indizieranwendung (z.B. LuceneIndexCreation.jar) im Dokument entweder nur indiziert oder indiziert und gespeichert.

Beachte, dass die Dokumentidentität ('path' in unserem Beispiel) auch im Index gespeichert wird und von ihm zurückgewonnen werden muß.

14.3.3. Ergebnisgewichtung

Zend_Search_Lucene verwendet die selben Gewichtungsalgorithmen wie Java Lucene. Die Suchergebnisse werden nach einem Punktwert sortiert. Treffer mit höherem Punktwert kommen zuerst, und Dokumente mit höherem Punktwert passen auf die Abfrage besser als solche mit niedrigerem Punktwert.

Grob gesagt, haben die Suchergebnisse einen höheren Punktwert, welche den gesuchten Begriff oder die gesuchte Phrase häufiger enthalten.

Der Punktwert kann über die score Eigenschaft des Treffers ermittelt werden:

<?php
$hits = $index->find($query);

foreach ($hits as $hit) {
    echo $hit->id;
    echo $hit->score;
}

?>

Die Zend_Search_Lucene_Search_Similarity Klasse wird verwendet, um den Punktwert zu berechnen. Beachte den Erweiterbarkeit. Algorithmen für Punktwertermittlung Abschnitt für weitere Details.