xapian-bindings/perl/Xapian/ValueIterator.pm

   1 package Xapian::ValueIterator;
   2
   3 =head1 NAME
   4
   5 Xapian::ValueIterator - Iterate over values in a slot.
   6
   7 =head1 DESCRIPTION
   8
   9 This object represents a stream of document values. It overloads C<++> for
  10 advancing the iterator, or you can explicitly call the C<inc> method.
  11 This class also overloads C<eq>, C<ne>, C<==>, and C<!=>.
  12
  13 =head2 Compatibility with Search::Xapian
  14
  15 Search::Xapian overloads <""> (stringification) on this class to call
  16 the C<get_value> method.  Call C<get_value> directly instead.
  17
  18 =head1 METHODS
  19
  20 =over 4
  21
  22 =item new
  23
  24 Constructor. Defaults to a uninitialized iterator.
  25
  26 =item clone
  27
  28 =item inc
  29
  30 Advance the iterator by one. (Called implicitly by C<++> overloading)
  31
  32 =item get_valueno
  33
  34 Return the number of the value slot at the current position.
  35
  36 =item get_value
  37
  38 Return the string in the value slot at current position.
  39
  40 =item get_description
  41
  42 Returns a string describing this object.
  43
  44 =item equal <valueiterator>
  45
  46 Checks if a valueiterator is the same as this valueiterator. Also overloaded as
  47 the C<eq> and C<==> operators.
  48
  49 =item nequal <valueiterator>
  50
  51 Checks if a valueiterator is different from this valueiterator. Also overloaded
  52 as the C<ne> and C<!=> operators.
  53
  54 =back
  55
  56 =head1 SEE ALSO
  57
  58 L<Xapian>,
  59 L<Xapian::Document>
  60
  61 =cut
  62 1;