1Xapian::Document(3)   User Contributed Perl Documentation  Xapian::Document(3)
2
3
4

NAME

6       Search::Xapian::Document - Document object
7

DESCRIPTION

9       This class represents a document in a Xapian database.
10

METHODS

12       new Class constructor.
13
14       clone
15           Return a clone of this class.
16
17       get_value (value_no)
18           Returns the value by the assigned number.
19
20       add_value <value_no> <value>
21           Set a value by value number.
22
23       remove_value <value_no>
24           Removes the value with the assigned number.
25
26       clear_values
27           Clear all set values.
28
29       get_data
30           Return all document data.
31
32       set_data <data>
33           Set all document data. This can be anything you like.
34
35       add_posting <term> <position> [<wdfinc>]
36           Adds a term at the given position. wdfinc defaults to 1.
37
38       remove_posting <term> <position> [<wdfdec>]
39           Removes a term from the given position. wdfdec defaults to 1.
40
41       add_term <term> [<wdfinc>]
42           Adds a term without positional information. wdfinc defaults to 1.
43
44       add_boolean_term <term>
45           Adds a term intended for boolean filtering (its wdf contribution
46           will be 0).
47
48       remove_term <term>
49           Removes a term and all postings associated with it.
50
51       clear_terms
52           Remove all terms from the document.
53
54       termlist_count
55           Returns number of different terms in the document.
56
57       termlist_begin
58           Iterator for the terms in this document. Returns a
59           Search::Xapian::TermIterator.
60
61       termlist_end
62           Equivalent end iterator for termlist_begin().  Returns a
63           Search::Xapian::TermIterator.
64
65       values_count
66           Return number of defined values for this document.
67
68       values_begin
69           Return a Search::Xapian::ValueIterator pointing at the start of the
70           values in this document.
71
72       values_end
73           Return a Search::Xapian::ValueIterator pointing at the end of the
74           values in this document.
75
76       get_description
77           Return a description of this object.
78

SEE ALSO

80       Search::Xapian::Database
81
82
83
84perl v5.36.0                      2023-01-20               Xapian::Document(3)
Impressum