xapian-bindings/perl/Xapian/TermGenerator.pm

   1 package Xapian::TermGenerator;
   2
   3 =head1 NAME
   4
   5 Xapian::TermGenerator - Parses a piece of text and generates terms.
   6
   7 =head1 DESCRIPTION
   8
   9 This module takes a piece of text and parses it to produce words which are
  10 then used to generate suitable terms for indexing.  The terms generated
  11 are suitable for use with L<Xapian::Query> objects produced by the
  12 L<Xapian::QueryParser> class.
  13
  14 =head1 SYNOPSIS
  15
  16   use Xapian;
  17
  18   my $doc = new Xapian::Document();
  19   my $tg = new Xapian::TermGenerator();
  20   $tg->set_stemmer(new Xapian::Stem("english"));
  21   $tg->set_document($doc);
  22   $tg->index_text("The cat sat on the mat");
  23
  24 =head1 METHODS
  25
  26 =over 4
  27
  28 =item new
  29
  30 TermGenerator constructor.
  31
  32 =item set_stemmer <stemmer>
  33
  34 Set the L<Xapian::Stem> object to be used for generating stemmed terms.
  35
  36 =item set_stopper <stopper>
  37
  38 Set the L<Xapian::Stopper> object to be used for identifying stopwords.
  39
  40 =item set_document <document>
  41
  42 Set the L<Xapian::Document> object to index terms into.
  43
  44 =item get_document <document>
  45
  46 Get the currently set L<Xapian::Document> object.
  47
  48 =item index_text <text> [<wdf_inc> [<prefix>]]
  49
  50 Indexes the text in string <text>.  The optional parameter <wdf_inc> sets the
  51 wdf increment (default 1).  The optional parameter <prefix> sets the term
  52 prefix to use (default is no prefix).
  53
  54 =item index_text_without_positions <text> [<wdf_inc> [<prefix>]]
  55
  56 Just like index_text, but no positional information is generated.  This means
  57 that the database will be significantly smaller, but that phrase searching
  58 and NEAR won't be supported.
  59
  60 =item increase_termpos [<delta>]
  61
  62 Increase the termpos used by index_text by <delta> (default 100).
  63
  64 This can be used to prevent phrase searches from spanning two
  65 unconnected blocks of text (e.g. the title and body text).
  66
  67 =item get_termpos
  68
  69 Get the current term position.
  70
  71 =item set_termpos <termpos>
  72
  73 Set the current term position.
  74
  75 =item get_description
  76
  77 Return a description of this object.
  78
  79 =back
  80
  81 =head1 REFERENCE
  82
  83   https://xapian.org/docs/sourcedoc/html/classXapian_1_1TermGenerator.html
  84
  85 =cut
  86 1;