Plucene::Document::Field(3pm) - phpMan

Plucene::Document::Field(3pm)  User Contributed Perl Documentation  Plucene::Document::Field(3pm)



NAME
       Plucene::Document::Field - A field in a Plucene::Document

SYNOPSIS
               my $field = Plucene::Document::Field->Keyword($name, $string);
               my $field = Plucene::Document::Field->Text($name, $string);

               my $field = Plucene::Document::Field->UnIndexded($name, $string);
               my $field = Plucene::Document::Field->UnStored($name, $string);

DESCRIPTION
       Each Plucene::Document is made up of Plucene::Document::Field objects. Each of these
       fields can be stored, indexed or tokenised.

FIELDS
       name

       Returns the name of the field.

       string

       Returns the value of the field.

       is_stored

       Returns true if the field is or will be stored, or false if it was created with
       "UnStored".

       is_indexed

       Returns true if the field is or will be indexed, or false if it was created with "UnIn-
       dexed".

       is_tokenized

       Returns true if the field is or will be tokenized, or false if it was created with "UnIn-
       dexed" or "Keyword".

METHODS
       Keyword

               my $field = Plucene::Document::Field->Keyword($name, $string);

       This will make a new Plucene::Document::Field object that is stored and indexed, but not
       tokenised.

       UnIndexed

               my $field = Plucene::Document::Field->UnIndexded($name, $string);

       This will make a new Plucene::Document::Field object that is stored, but not indexed or
       tokenised.

       Text

               my $field = Plucene::Document::Field->Text($name, $string);

       This will make a new Plucene::Document::Field object that is stored, indexed and
       tokenised.

       UnStored

               my $field = Plucene::Document::Field->UnStored($name, $string);

       This will make a new Plucene::Document::Field object that isn't stored, but is indexed and
       tokenised.



perl v5.8.8                                 2008-03-01              Plucene::Document::Field(3pm)

Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-25 00:50 @38.107.179.239 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)