.\" 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
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "DBIx::FullTextSearch::StopList 3pm"
.TH DBIx::FullTextSearch::StopList 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"
DBIx::FullTextSearch::StopList \- Stopwords for DBIx::FullTextSearch
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use DBIx::FullTextSearch::StopList;
\&  # connect to database (regular DBI)
\&  my $dbh = DBI\->connect(\*(Aqdbi:mysql:database\*(Aq, \*(Aquser\*(Aq, \*(Aqpasswd\*(Aq);
\&
\&  # create a new empty stop word list
\&  my $sl1 = DBIx::FullTextSearch::StopList\->create_empty($dbh, \*(Aqsl_web_1\*(Aq);
\&
\&  # or create a new one with default stop words
\&  my $sl2 = DBIx::FullTextSearch::StopList\->create_default($dbh, \*(Aqsl_web_2\*(Aq, \*(Aqenglish\*(Aq);
\&
\&  # or open an existing one
\&  my $sl3 = DBIx::FullTextSearch::StopList\->open($dbh, \*(Aqsl_web_3\*(Aq);
\&
\&  # add stop words
\&  $sl1\->add_stop_word([\*(Aqa\*(Aq,\*(Aqin\*(Aq,\*(Aqon\*(Aq,\*(Aqthe\*(Aq]);
\&
\&  # remove stop words
\&  $sl2\->remove_stop_word([\*(Aqbe\*(Aq,\*(Aqbecause\*(Aq,\*(Aqbeen\*(Aq,\*(Aqbut\*(Aq,\*(Aqby\*(Aq]);
\&
\&  # check if word is in stoplist
\&  $bool = $sl1\->is_stop_word(\*(Aqin\*(Aq);
\&
\&  # empty stop words
\&  $sl3\->empty;
\&
\&  # drop stop word table
\&  $sl2\->drop;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
DBIx::FullTextSearch::StopList provides stop lists that can be used \-DBIx::FullTextSearch.
StopList objects can be reused accross several FullTextSearch objects.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1CONSTRUCTERS\s0"
.IX Subsection "CONSTRUCTERS"
.IP "create_empty" 4
.IX Item "create_empty"
.Vb 1
\&  my $sl = DBIx::FullTextSearch::StopList\->create_empty($dbh, $sl_name);
.Ve
.Sp
This class method creates a new StopList object.
.IP "create_default" 4
.IX Item "create_default"
.Vb 1
\&  my $sl = DBIx::FullTextSearch::StopList\->create_default($dbh, $sl_name, $language);
.Ve
.Sp
This class method creates a new StopList object, with default words loaded in for the
given language.  Supported languages include Czech, Danish, Dutch, English, Finnish, French,
German, Italian, Portuguese, Spanish, and Swedish.
.IP "open" 4
.IX Item "open"
.Vb 1
\&  my $sl = DBIx::FullTextSearch::StopList\->open($dbh, $sl_name);
.Ve
.Sp
Opens and returns StopList object
.SS "\s-1OBJECT METHODS\s0"
.IX Subsection "OBJECT METHODS"
.IP "add_stop_word" 4
.IX Item "add_stop_word"
.Vb 1
\&  $sl\->add_stop_word(\e@stop_words);
.Ve
.Sp
Adds stop words to StopList object.  Expects array reference as argument.
.IP "remove_stop_word" 4
.IX Item "remove_stop_word"
.Vb 1
\&  $sl\->remove_stop_word(\e@stop_words);
.Ve
.Sp
Remove stop words from StopList object.
.IP "is_stop_word" 4
.IX Item "is_stop_word"
.Vb 1
\&  $bool = $sl\->is_stop_word($stop_word);
.Ve
.Sp
Returns true iff stop_word is StopList object
.IP "empty" 4
.IX Item "empty"
.Vb 1
\&  $sl\->empty;
.Ve
.Sp
Removes all stop words in StopList object.
.IP "drop" 4
.IX Item "drop"
.Vb 1
\&  $sl\->drop;
.Ve
.Sp
Removes table associated with the StopList object.
.SH "AUTHOR"
.IX Header "AUTHOR"
T.J. Mather, tjmather@tjmather.com,
http://www.tjmather.com/
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
All rights reserved. This package is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
DBIx::FullTextSearch
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 203:" 4
.IX Item "Around line 203:"
You forgot a '=back' before '=head2'
.IP "Around line 205:" 4
.IX Item "Around line 205:"
\&'=item' outside of any '=over'
.IP "Around line 225:" 4
.IX Item "Around line 225:"
You forgot a '=back' before '=head2'
.IP "Around line 227:" 4
.IX Item "Around line 227:"
\&'=item' outside of any '=over'