1Xapian::ValueIterator(3U)ser Contributed Perl DocumentatiXoanpian::ValueIterator(3)
2
3
4

NAME

6       Search::Xapian::ValueIterator - Iterate over value slots in a document.
7

DESCRIPTION

9       This object represents a stream of document values. It overloads "++"
10       for advancing the iterator, or you can explicitly call the "inc"
11       method.  This class also overloads "eq", "ne", "==", "!=", and ""
12       (stringification).
13

METHODS

15       new Constructor. Defaults to a uninitialized iterator.
16
17       clone
18       inc Advance the iterator by one. (Called implictly by "++" overloading
19           )
20
21       get_valueno
22           Return the number of the value slot at the current position.
23
24       get_value
25           Return the string in the value slot at current position.  Also
26           overloaded as the "" operator.
27
28       get_description
29           Returns a string describing this object.
30
31       equal <valueiterator>
32           Checks if a valueiterator is the same as this valueiterator. Also
33           overloaded as the "eq" and "!=" operators.
34
35       nequal <valueiterator>
36           Checks if a valueiterator is different from this valueiterator.
37           Also overloaded as the "ne" and "!=" operators.
38

SEE ALSO

40       Search::Xapian,Search::Xapian::Document
41
42
43
44perl v5.12.0                      2010-04-27          Xapian::ValueIterator(3)