.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Plucene::TestCase 3pm"
.TH Plucene::TestCase 3pm "2018-04-02" "perl v5.26.1" "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"
Plucene::TestCase \- Handy functions when testing Plucene
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Test::More tests => 10;
\&        use Plucene::TestCase;
\&
\&        new_index {
\&                add_document( foo => "bar" );
\&        };
\&
\&        re_index {
\&                add_document( foo => "baz" );
\&        }
\&
\&        with_reader {
\&                $READER\->whatever;
\&        }
\&
\&        my $hits = search("foo:ba*");
.Ve
.SH "EXPORTS"
.IX Header "EXPORTS"
.ie n .IP "$DIR" 3
.el .IP "\f(CW$DIR\fR" 3
.IX Item "$DIR"
A directory which is created for the purposes of this test, in which the
index will be placed. It will normally be cleaned up at the end of the
test, unless \f(CW$Plucene::TestCase::DEBUG\fR is set to allow you to peruse
the entrails.
.ie n .IP "$WRITER" 3
.el .IP "\f(CW$WRITER\fR" 3
.IX Item "$WRITER"
A variable holding the current \f(CW\*(C`Index::Writer\*(C'\fR object, if there is one.
.ie n .IP "$READER" 3
.el .IP "\f(CW$READER\fR" 3
.IX Item "$READER"
A variable holding the current \f(CW\*(C`Index::Reader\*(C'\fR object, if there is one.
.ie n .IP "$ANALYZER" 3
.el .IP "\f(CW$ANALYZER\fR" 3
.IX Item "$ANALYZER"
A variable holding the class name of the desired \f(CW\*(C`Analysis::Analyzer\*(C'\fR
class.
.IP "new_index \s-1BLOCK\s0 (Analyzer)" 3
.IX Item "new_index BLOCK (Analyzer)"
Create a new index, and do the following stuff in the block before
closing the index writer. \f(CW$WRITER\fR is set for the duration of the
block.
.Sp
The optional parameter should be the class name of the analyzer to use;
if not specified, the value from \f(CW$ANALYZER\fR, which in turn defaults to
\&\f(CW\*(C`Plucene::Analysis::SimpleAnalyzer\*(C'\fR, will be used.
.IP "re_index \s-1BLOCK\s0 (Analyzer)" 3
.IX Item "re_index BLOCK (Analyzer)"
Same as \f(CW\*(C`new_index\*(C'\fR, but doesn't create a new index, rather re-uses an
old one.
.IP "add_document( field1 => value1, ...)" 3
.IX Item "add_document( field1 => value1, ...)"
Add a new document to the index, with the given fields and values
.IP "with_reader \s-1BLOCK\s0" 3
.IX Item "with_reader BLOCK"
Opens an index reader in \f(CW$READER\fR and runs the block.
.IP "search" 3
.IX Item "search"
Searches for the query given. If any fields are not specified, they will
be assumed to be the default \f(CW\*(C`text\*(C'\fR. Returns a \f(CW\*(C`Plucene::Search::Hits\*(C'\fR
object. The value of \f(CW$ANALYZER\fR will be used to construct an analyzer
for the query string.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 49:" 4
.IX Item "Around line 49:"
=over without closing =back