.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Xapian::Document 3"
.TH Xapian::Document 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Xapian::Document \- Document object
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents a document in a Xapian database.
.SH METHODS
.IX Header "METHODS"
.IP new 4
.IX Item "new"
Class constructor.
.IP clone 4
.IX Item "clone"
Return a clone of this class.
.IP "get_value (value_no)" 4
.IX Item "get_value (value_no)"
Returns the value by the assigned number.
.IP "add_value <value_no> <value>" 4
.IX Item "add_value <value_no> <value>"
Set a value by value number.
.IP "remove_value <value_no>" 4
.IX Item "remove_value <value_no>"
Removes the value with the assigned number.
.IP clear_values 4
.IX Item "clear_values"
Clear all set values.
.IP get_data 4
.IX Item "get_data"
Return all document data.
.IP "set_data <data>" 4
.IX Item "set_data <data>"
Set all document data. This can be anything you like.
.IP "add_posting <term> <position> [<wdfinc>]" 4
.IX Item "add_posting <term> <position> [<wdfinc>]"
Adds a term at the given position. wdfinc defaults to 1.
.IP "remove_posting <term> <position> [<wdfdec>]" 4
.IX Item "remove_posting <term> <position> [<wdfdec>]"
Removes a term from the given position. wdfdec defaults to 1.
.IP "add_term <term> [<wdfinc>]" 4
.IX Item "add_term <term> [<wdfinc>]"
Adds a term without positional information. wdfinc defaults to 1.
.IP "add_boolean_term <term>" 4
.IX Item "add_boolean_term <term>"
Adds a term intended for boolean filtering (its wdf contribution will be 0).
.IP "remove_term <term>" 4
.IX Item "remove_term <term>"
Removes a term and all postings associated with it.
.IP clear_terms 4
.IX Item "clear_terms"
Remove all terms from the document.
.IP termlist_count 4
.IX Item "termlist_count"
Returns number of different terms in the document.
.IP termlist_begin 4
.IX Item "termlist_begin"
Iterator for the terms in this document. Returns a
Search::Xapian::TermIterator.
.IP termlist_end 4
.IX Item "termlist_end"
Equivalent end iterator for \fBtermlist_begin()\fR.  Returns a
Search::Xapian::TermIterator.
.IP values_count 4
.IX Item "values_count"
Return number of defined values for this document.
.IP values_begin 4
.IX Item "values_begin"
Return a Search::Xapian::ValueIterator pointing at the start of the
values in this document.
.IP values_end 4
.IX Item "values_end"
Return a Search::Xapian::ValueIterator pointing at the end of the
values in this document.
.IP get_description 4
.IX Item "get_description"
Return a description of this object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Search::Xapian::Database