.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 "KinoSearch1::Index::Term 3pm" .TH KinoSearch1::Index::Term 3pm 2024-03-10 "perl v5.38.2" "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 KinoSearch1::Index::Term \- string of text associated with a field .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& my $foo_term = KinoSearch1::Index::Term\->new( \*(Aqcontent\*(Aq, \*(Aqfoo\*(Aq ); \& my $term_query = KinoSearch1::Search::TermQuery\->new( term => $foo_term ); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The Term is the unit of search. It has two characteristics: a field name, and term text. .SH METHODS .IX Header "METHODS" .SS new .IX Subsection "new" .Vb 1 \& my $term = KinoSearch1::Index::Term\->new( FIELD_NAME, TERM_TEXT ); .Ve .PP Constructor. .SS "set_text get_text set_field get_field" .IX Subsection "set_text get_text set_field get_field" Getters and setters. .SS to_string .IX Subsection "to_string" Returns a string representation of the Term object. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2005\-2010 Marvin Humphrey .SH "LICENSE, DISCLAIMER, BUGS, etc." .IX Header "LICENSE, DISCLAIMER, BUGS, etc." See KinoSearch1 version 1.01.