debian man page for dbix::fulltextsearch::stoplist

DBIx::FullTextSearch::StopList(3pm)			User Contributed Perl Documentation		       DBIx::FullTextSearch::StopList(3pm)

NAME
       DBIx::FullTextSearch::StopList - Stopwords for DBIx::FullTextSearch

SYNOPSIS
	 use DBIx::FullTextSearch::StopList;
	 # connect to database (regular DBI)
	 my $dbh = DBI->connect('dbi:mysql:database', 'user', 'passwd');

	 # create a new empty stop word list
	 my $sl1 = DBIx::FullTextSearch::StopList->create_empty($dbh, 'sl_web_1');

	 # or create a new one with default stop words
	 my $sl2 = DBIx::FullTextSearch::StopList->create_default($dbh, 'sl_web_2', 'english');

	 # or open an existing one
	 my $sl3 = DBIx::FullTextSearch::StopList->open($dbh, 'sl_web_3');

	 # add stop words
	 $sl1->add_stop_word(['a','in','on','the']);

	 # remove stop words
	 $sl2->remove_stop_word(['be','because','been','but','by']);

	 # check if word is in stoplist
	 $bool = $sl1->is_stop_word('in');

	 # empty stop words
	 $sl3->empty;

	 # drop stop word table
	 $sl2->drop;

DESCRIPTION
       DBIx::FullTextSearch::StopList provides stop lists that can be used -DBIx::FullTextSearch.  StopList objects can be reused accross several
       FullTextSearch objects.

METHODS
       CONSTRUCTERS

       create_empty
	     my $sl = DBIx::FullTextSearch::StopList->create_empty($dbh, $sl_name);

	   This class method creates a new StopList object.

       create_default
	     my $sl = DBIx::FullTextSearch::StopList->create_default($dbh, $sl_name, $language);

	   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.

       open
	     my $sl = DBIx::FullTextSearch::StopList->open($dbh, $sl_name);

	   Opens and returns StopList object

       OBJECT METHODS

       add_stop_word
	     $sl->add_stop_word(@stop_words);

	   Adds stop words to StopList object.	Expects array reference as argument.

       remove_stop_word
	     $sl->remove_stop_word(@stop_words);

	   Remove stop words from StopList object.

       is_stop_word
	     $bool = $sl->is_stop_word($stop_word);

	   Returns true iff stop_word is StopList object

       empty
	     $sl->empty;

	   Removes all stop words in StopList object.

       drop
	     $sl->drop;

	   Removes table associated with the StopList object.

AUTHOR
       T.J. Mather, tjmather@tjmather.com, http://www.tjmather.com/

COPYRIGHT
       All rights reserved. This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO
       DBIx::FullTextSearch

perl v5.8.8							    2007-10-23				       DBIx::FullTextSearch::StopList(3pm)