Xapian::TermGenerator(3)                   User Contributed Perl Documentation


NAME
       Search::Xapian::TermGenerator - Parses a piece of text and generates
       terms.

DESCRIPTION
       This module takes a piece of text and parses it to produce words which
       are then used to generate suitable terms for indexing.  The terms
       generated are suitable for use with Search::Xapian::Query objects
       produced by the Search::Xapian::QueryParser class.

SYNOPSIS
         use Search::Xapian;

         my $doc = new Search::Xapian::Document();
         my $tg = new Search::Xapian::TermGenerator();
         $tg->set_stemmer(new Search::Xapian::Stem("english"));
         $tg->set_document($doc);
         $tg->index_text("The cat sat on the mat");

METHODS
       new TermGenerator constructor.

       set_stemmer <stemmer>
           Set the Search::Xapian::Stem object to be used for generating
           stemmed terms.

       set_stopper <stopper>
           Set the Search::Xapian::Stopper object to be used for identifying
           stopwords.

       set_document <document>
           Set the Search::Xapian::Document object to index terms into.

       get_document <document>
           Get the currently set Search::Xapian::Document object.

       index_text <text> [<wdf_inc> [<prefix>]]
           Indexes the text in string <text>.  The optional parameter
           <wdf_inc> sets the wdf increment (default 1).  The optional
           parameter <prefix> sets the term prefix to use (default is no
           prefix).

       index_text_without_positions <text> [<wdf_inc> [<prefix>]]
           Just like index_text, but no positional information is generated.
           This means that the database will be significantly smaller, but
           that phrase searching and NEAR won't be supported.

       increase_termpos [<delta>]
           Increase the termpos used by index_text by <delta> (default 100).

           This can be used to prevent phrase searches from spanning two
           unconnected blocks of text (e.g. the title and body text).

       get_termpos
           Get the current term position.

       set_termpos <termpos>
           Set the current term position.

       get_description
           Return a description of this object.

REFERENCE
         https://xapian.org/docs/sourcedoc/html/classXapian_1_1TermGenerator.html

perl v5.40.0                      2024-09-01          Xapian::TermGenerator(3)