repo_zf1/documentation/manual/de/module_specs/Zend_Search_Lucene-QueryLanguage.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 21829 -->
<!-- Reviewed: no -->
<sect1 id="zend.search.lucene.query-language">
    <title>Abfragesprache</title>

    <para>
        Java Lucene und <classname>Zend_Search_Lucene</classname> bieten sehr mächtige
        Abfragesprachen.
    </para>

    <para>
        Diese Sprachen sind großteils die selben mit ein paar kleineren Unterschieden welche
        anbei erklärt werden.
    </para>

    <para>
        Die komplette Java Lucene Syntax Dokumentation der Abfragesprache kann
        <ulink url="http://lucene.apache.org/java/2_3_0/queryparsersyntax.html">hier</ulink>
        gefunden werden.
    </para>

    <sect2 id="zend.search.lucene.query-language.terms">
        <title>Ausdrücke</title>

        <para>
            Eine Abfrage wird in Ausdrücke und Operatoren zerteilt. Es gibt drei Arten von
            Ausdrücken: Einzelne Ausdrücke, Phrasen und Unterabfragen.
        </para>

        <para>
            Ein einzelner Ausdruck ist ein einzelnes Wort wie "Test" oder "Hallo".
        </para>

        <para>
            Eine Phrase ist eine Gruppe von Wörtern die von doppelten Hochkommata umgeben sind wie
            "Hallo Dolly".
        </para>

        <para>
            Eine Unterabfrage ist eine Abfrage die von Klammern umgeben ist wie "(Hallo Dolly)".
        </para>

        <para>
            Mehrere Ausdrücke können mithilfe eines boolschen Operators miteinander kombiniert
            werden um komplexere Abfragen zu formen (siehe anbei).
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.fields">
        <title>Felder</title>

        <para>
            Lucene unterstützt Felder von Daten. Wenn eine Suche durchgeführt wird kann man entweder
            ein Feld spezifizieren, oder ein Standardfeld verwenden. Der Name des Feldes hängt von
            den indizierten Daten ab und das Standardfeld wird durch aktuelle Einstellungen
            definiert.
        </para>

        <para>
            Der erste und größte Unterschied zu Java Lucene ist der das Ausdrücke standardmäßig
            über <emphasis>alle Felder</emphasis> gesucht werden.
        </para>

        <para>
            Es gibt zwei statische Methoden in der <classname>Zend_Search_Lucene</classname> Klasse
            welche dem Entwickler das Konfigurieren dieser Einstellungen erlauben:
        </para>

        <programlisting language="php"><![CDATA[
$defaultSearchField = Zend_Search_Lucene::getDefaultSearchField();
...
Zend_Search_Lucene::setDefaultSearchField('contents');
]]></programlisting>

        <para>
            Der <constant>NULL</constant> Wert bedeutet, das die Suche über alle Felder durchgeführt
            wird. Das ist die Standardeinstellung.
        </para>

        <para>
            Es können spezielle Felder gesucht werden indem der Feldname gefolgt von einem
            Doppelpunkt ":" angegeben wird, gefolgt von dem Begriff nach dem gesucht wird.
        </para>

        <para>
            Als Beispiel nehmen wir an das ein Lucene Index zwei Felder enthält - title und text -
            text ist das Standardfeld. Wenn man das "Der richtige Weg" benannte Dokument finden will
            welches den Text "gehe nicht diesen Weg" enthält, geht das mit:
        </para>

        <programlisting language="querystring"><![CDATA[
title:"Der richtige Weg" AND text:go
]]></programlisting>

        <para>
            oder
        </para>

        <programlisting language="querystring"><![CDATA[
title:"Mach es richtig" AND go
]]></programlisting>

        <para>
            Weil "text" das Standardfeld ist, wird der Feld Indikator nicht benötigt.
        </para>

        <para>
            Beachte: Das Feld nur nur für den Ausdruck, die Phrase oder die Unterabfrage gültig die
            direkt danach folgt, sodas die Abfrage
        </para>

        <programlisting language="querystring"><![CDATA[
title:Mach es richtig
]]></programlisting>

        <para>
            nur "Mach" im title Feld finden wird. Es findet "es" und "richtig" im Standardfeld (wenn
            das Standardfeld gesetzt ist) oder in allen indizierten Felder (wenn das Standardfeld
            auf <constant>NULL</constant> gesetzt ist).
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.wildcard">
        <title>Wildcards</title>

        <para>
            Lucene unterstützt Einzelzeichen und Mehrfachzeichen Suchen mit Wildcards in einzelnen
            Ausdrücken (aber nicht innerhalb von Phrasenabfragen).
        </para>

        <para>
            Um eine Einzelzeichen Wildcardsuche durchzuführen kann das "?" Zeichen verwendet werden.
        </para>

        <para>
            Um eine Mehrzeichen Wildcardsuche durchzuführen kann das "*" Zeichen verwendet werden.
        </para>

        <para>
            Die Einzelzeichen Wildcardsuche schucht nach Strings die dem Begriff entsprechen wobei
            das "?" durch ein beliebiges einzelnes Zeichen ersetzt wird. Um, zum Beispiel, nach
            "Text" oder "Test" zu suchen kann die folgende Suche verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
Te?t
]]></programlisting>

        <para>
            Mehrzeichen Wildcardsuche sucht nach 0 oder mehr Zeichen wenn Strings nach passenden
            Begriffen sucht. Um, zum Beispiel, nach Test, Tests oder Tester zu suchen, kann die
            folgende Suche verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
Test*
]]></programlisting>

        <para>
            Es können "?", "*" oder beide an jeder Stelle des Ausdrucks verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
*schrei?t*
]]></programlisting>

        <para>
            Sucht nach "schreibt", "schreibtisch", "beschreibt", "schreist" und so weiter.
        </para>

        <para>
            Beginnend mit ZF 1.7.7 benötigen Wildcard Präfixe einen nicht-Wildcard Präfix. Die
            standardmäßige Länge des Präfixes ist 3 (wie in Java Lucene). Die Ausdrücke
            "*", "te?t", "*wr?t*" werden also eine Exception werfen

            <footnote>
                <para>
                    Es ist zu beachten das es nicht zu einer
                    <code>Zend_Search_Lucene_Search_QueryParserException</code> kommt, sondern zu
                    einer <code>Zend_Search_Lucene_Exception</code>. Sie wird wärend dem
                    Umschreiben der Abfrage geworfen.
                </para>
            </footnote>.
        </para>

        <para>
            Das kann durch Verwendung der Methoden
            <code>Zend_Search_Lucene_Search_Query_Wildcard::getMinPrefixLength()</code> und
            <code>Zend_Search_Lucene_Search_Query_Wildcard::setMinPrefixLength()</code> geändert
            werden.
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.modifiers">
        <title>Ausdrücke verändern</title>

        <para>
            Lucene unterstützt die Veränderung von Abfrageausdrücken und bietet damit ein beites
            Spektrum von Suchoptionen.
        </para>

        <para>
            Der "~" Modifikator kann für verwendet werden um eine annähernde Suche auf Phrasen oder
            Fuzzy Suchen für individuelle Ausdrücke durchzuführen.
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.range">
        <title>Bereichs Suchen</title>

        <para>
            Bereichsabfragen erlauben es Entwicklern passende Dokumente zu finden deren Werte der
            Felder zwischen der unteren und oberen Grenze sind die durch die Bereichsabfrage
            spezifiziert wurden. Bereichsabfragen können inklusive oder exklusive der oberen und
            unteren Grenze sein. Sortierungen werden lexikalisch durchgeführt.
        </para>

        <programlisting language="querystring"><![CDATA[
mod_date:[20020101 TO 20030101]
]]></programlisting>

        <para>
            Das wird Dokumente finden dessen lod_date Felder Werte zwischen 20020101 und 20030101
            inklusive haben. Es ist zu beachten das Bereichsabfragen nicht für Datumsfelder
            reserviert sind. Bereichsabfragen können auch mit nicht-datums Felder verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
title:{Aida TO Carmen}
]]></programlisting>

        <para>
            Das wird alle Dokumente finden dessen Titel zwischen Aida und Carmen sortiert sind,
            aber ohne Aida und Carmen.
        </para>

        <para>
            Bereichsabfragen inklusive, werden durch eine eckige Klammer abgegrenzt.
            Bereichsabfragen exklusive werden durch geschlungene Klammern abgegrenzt.
        </para>

        <para>
            Wenn kein Feld spezifiziert wurde sucht <classname>Zend_Search_Lucene</classname>
            standardmäßig nach spezifizierten Intervallen in allen Feldern.
        </para>

        <programlisting language="querystring"><![CDATA[
{Aida TO Carmen}
]]></programlisting>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.fuzzy">
        <title>Fuzzy Suchen</title>

        <para>
            <classname>Zend_Search_Lucene</classname> unterstützt, genauso wie Java Lucene, die
            Fuzzy Suche basierend auf der Levenshtein Distanz oder dem Edit Algorithmus. Um eine
            Fuzzy Suche durchzuführen muß das Tilde Symbol "~", am Ende eines einzelnen Wortbegriffs
            verwendet werden. Um zum Beispiel nach einem Begriff zu suchen der in der Aussprache
            ähnlich zu "Raum" ist kann die folgende Fuzzy Suche verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
roam~
]]></programlisting>

        <para>
            Diese Suche wird Begriffe wie "Baum" und "Saum" finden. Zusätzliche (optionale)
            Parameter können die benötigte Ähnlichkeit spezifizieren. Der Wert muß zwischen 0 und 1
            sein. Mit einem Wert näher bei 1 werden nur Begriffe mit einer höheren Warscheinlichkeit
            gefunden. Zum Beispiel:
        </para>

        <programlisting language="querystring"><![CDATA[
roam~0.8
]]></programlisting>

        <para>
            Der verwendete Standardwert wenn der Parameter nicht angegeben wurde ist 0.5.
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.matched-terms-limitations">
        <title>Einschränkung passender Ausdrücke</title>

        <para>
            Wildcard, Bereichs- und Fuzzy Suchabfragen können bei zu vielen Ausdrücken passen.
            Das kann die Geschwindigkeit der Suche sehr stark verlangsamen.
        </para>

        <para>
            Deshalb setzt <classname>Zend_Search_Lucene</classname> ein Limit der passenden
            Ausdrücke pro Abfrage (Unterabfrage). Dieses Limit kann durch Verwendung der Methoden
            <code>Zend_Search_Lucene::getTermsPerQueryLimit()</code>/
            <code>Zend_Search_Lucene::setTermsPerQueryLimit($limit)</code> empfangen und gesetzt
            werden.
        </para>

        <para>
            Das standardmäßige Limit für passende Ausdrücke ist 1024.
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.proximity-search">
        <title>Angenäherte Suchen</title>

        <para>
            Lucene unterstützt das Finden von Wörtern aus einer Phrase die einen spezifizierten
            Abstand an Wörtern in einem String weg sind. Um eine angenäherte Suche durchzuführen muß
            das Tilde, "~", Symbol am Ende der Phrase verwendet werden. Um zum Beispiel nach "Zend"
            und "Framework" innerhalb von 10 Wörtern zueinander in einem Dokument zu suchen kann die
            folgende Suche verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
"Zend Framework"~10
]]></programlisting>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.boosting">
        <title>Einen Ausdruck schneller machen</title>

        <para>
            Java Lucene und <classname>Zend_Search_Lucene</classname> bieten einen Level der
            Relevanz von passenden Dokumenten basierend auf den gefundenen Ausdrücken. Um die
            Relevanz eines Ausdrucks zu erhöhen kann das Karet, "^", Symbol mit einem Boost Faktor
            (einer Zahl) am Ende des Ausdrucks nach dem gesucht wird, verwendet werden. Je höher
            Boost Faktor ist, desdo relevanter wird der Ausdruck werden.
        </para>

        <para>
            Das boosten erlaubt die Kontrolle der Relevanz eines Dokuments durch das boosten
            individueller Ausdrücke. Wenn man zum Beispiel nach
        </para>

        <programlisting language="querystring"><![CDATA[
PHP framework
]]></programlisting>

        <para>
            sucht und will das der Ausdruck "PHP" mehr Relevanz hat, kann er durch Verwendung des ^
            Symbols zusammen mit einem Boost Faktor beim Ausdruck geboostet werden. Man würde zum
            Beispiel folgendes angeben:
        </para>

        <programlisting language="querystring"><![CDATA[
PHP^4 framework
]]></programlisting>

        <para>
            Das macht Dokumente in denen der Ausdruck <acronym>PHP</acronym> vorkommt relevanter.
            Man kann genauso Phrasenausdrücke boosten und Unterabfragen wie im Beispiel gezeigt:
        </para>

        <programlisting language="querystring"><![CDATA[
"PHP framework"^4 "Zend Framework"
]]></programlisting>

        <para>
            Standardwert ist der Boost Faktor 1. Auch wenn der Boost Faktor positiv sein muß, kann
            er kleiner als 1 sein (z.B. 0.2).
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.boolean">
        <title>Boolsche Operatoren</title>

        <para>
            Boolsche Operatoren erlauben es Ausdrücke durch logische Operatoren zu kombinieren.
            Lucene unterstützt AND, "+", OR, NOT und "-" als boolsche Operatoren. In Java Lucene
            müssen alle boolschen Operatoren GROßGESCHRIEBEN werden. In
            <classname>Zend_Search_Lucene</classname> nicht.
        </para>

        <para>
            AND, OR, und NOT Operatoren und "+", "-" definieren zwei unterschiedliche Stile um
            boolsche Abfragen zu erstellen. Im Gegensatz zu Java Lucene erlaubt es
            <classname>Zend_Search_Lucene</classname> nicht diese zwei Stile zu mischen.
        </para>

        <para>
            Wenn der AND/OR/NOT Stil verwendet wird dann muß der AND oder OR Operator zwischen allen
            Abfrageausdrücken vorhanden sein. Jedem Ausdruck kann auch ein NOT Operator
            vorangestellt werden. Der AND Operator hat eine höhere Präzedenz als der OR Operator.
            Das unterscheidet sich vom Verhalten von Java Lucene.
        </para>

        <sect3 id="zend.search.lucene.query-language.boolean.and">
            <title>AND</title>

            <para>
                Der AND Operator bedeutet das alle Ausdrücke der "AND Gruppe" in einigen Teilen der
                gesuchten Feld(er) passen müssen.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "PHP Framework" und "Zend Framework" enthalten kann
                die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
"PHP Framework" AND "Zend Framework"
]]></programlisting>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.or">
            <title>OR</title>

            <para>
                Der OR Operator teilt die Abfrage in verschiedene optionale Begriffe.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "PHP Framework" oder "Zend Framework" enthalten
                kann die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
"PHP Framework" OR "Zend Framework"
]]></programlisting>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.not">
            <title>NOT</title>

            <para>
                Der NOT Operator scheidet Dokumente aus die den Ausdruck nach NOT enthalten. Aber
                eine "AND Gruppe" die nur Ausdrücke mit NOT Operatoren enthält, gibt ein leeres
                Ergebnis zurück statt einem kompletten Set von indizierten Dokumenten.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "PHP Framework" enthalten aber "Zend Framework"
                nicht kann die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
"PHP Framework" AND NOT "Zend Framework"
]]></programlisting>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.other-form">
            <title>&amp;&amp;, ||, und ! Operatoren</title>

            <para>
                &amp;&amp;, ||, und ! können statt den AND, OR und NOT Notation verwendet werden.
            </para>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.plus">
            <title>+</title>

            <para>
                Der "+" oder benötigende Operator erfordert das der Ausdruck nach dem "+" Symbol im
                passenden Dokument vorhanden ist.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "Zend" enthalten müssen und "Framework" enthalten
                können, kann die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
+Zend Framework
]]></programlisting>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.minus">
            <title>-</title>

            <para>
                Der "-" oder ausschließende Operator schließt Dokumente aus die dem Ausdruck nach
                dem "-" Symbol entsprechen.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "PHP Framework" enthalten aber "Zend Framework"
                nicht, kann die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
"PHP Framework" -"Zend Framework"
]]></programlisting>
        </sect3>

        <sect3 id="zend.search.lucene.query-language.boolean.no-operator">
            <title>kein Operator</title>

            <para>
                Wenn kein Operator verwendet wird, dann wird das Suchverhalten durch den
                "standardmäßigen boolschen Operator" bestimmt.
            </para>

            <para>
                Dieser ist standardmäßig auf <code>OR</code> gesetzt.
            </para>

            <para>
                Das impliziert das jeder Ausdruck standardmäßig optional ist. Er kann oder kann
                nicht innerhalb des Dokuments enthalten sein, aber Dokumenten mit diesem Ausdruck
                haben einen Höheren Stellenwert.
            </para>

            <para>
                Um nach Dokumenten zu Suchen die "PHP Framework" benötigen und "Zend Framework"
                enthalten können kann die folgende Abfrage verwendet werden:
            </para>

            <programlisting language="querystring"><![CDATA[
+"PHP Framework" "Zend Framework"
]]></programlisting>

            <para>
                Der standardmäßige boolsche Operator kann mit den
                <classname>Zend_Search_Lucene_Search_QueryParser::setDefaultOperator($operator)</classname>
                und
                <classname>Zend_Search_Lucene_Search_QueryParser::getDefaultOperator()</classname>
                Methoden gesetzt oder geholt werden.
            </para>

            <para>
                Diese Methoden arbeiten mit den
                <classname>Zend_Search_Lucene_Search_QueryParser::B_AND</classname> und
                <classname>Zend_Search_Lucene_Search_QueryParser::B_OR</classname> Konstanten.
            </para>
        </sect3>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.grouping">
        <title>Gruppieren</title>

        <para>
            Java Lucene und <classname>Zend_Search_Lucene</classname> unterstützen die Verwendung
            von Klammern um Fälle zu gruppieren und Unterabfragen zu erstellen. Das kann nützlich
            sein wenn man die boolsche Operatoren für eine Abfrage kontrollieren will, oder
            unterschiedliche Abfragestile mischen will:
        </para>

        <programlisting language="querystring"><![CDATA[
+(Framework OR Bibliothek) +php
]]></programlisting>

        <para>
            <classname>Zend_Search_Lucene</classname> unterstützt Unterabfragen von beliebigen
            Ebenen.
        </para>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.field-grouping">
        <title>Felder gruppieren</title>

        <para>
            Lucene unterstützt auch die Verwendung von Klammern um mehrere Fälle in ein einzelnes
            Feld zu gruppieren.
        </para>

        <para>
            Um nach einem Titel zu suchen die sowohl das Wort "Rückkehr" und die Phrase "rosaroter
            Panther" kann die folgende Abfrage verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
title:(+Rückkehr +"rosaroter Panther")
]]></programlisting>
    </sect2>

    <sect2 id="zend.search.lucene.query-language.escaping">
        <title>Escapen von speziellen Zeichen</title>

        <para>
            Lucene unterstützt das Escapen von speziellen Zeichen die in der Abfragesyntax verwendet
            werden. Die aktuelle Liste der speziellen Zeichen ist:
        </para>

        <para>
            + - &amp;&amp; || ! ( ) { } [ ] ^ " ~ * ? : \
        </para>

        <para>
            + und - in einem einzelnen Ausdruck werden automatisch als normale Zeichen behandelt.
        </para>

        <para>
            Für andere Instanzen von solchen Zeichen kann das \ vor jedem speziellen Zeichen
            verwendet werden der escaped werden soll. Um zum Beispiel nach (1+1):2 zu suchen kann
            die folgende Abfrage verwendet werden:
        </para>

        <programlisting language="querystring"><![CDATA[
\(1\+1\)\:2
]]></programlisting>
    </sect2>
</sect1>