Plucene::Document::Field (3pm)

        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);

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

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 \*(C`UnStored\*(C'.

is_indexed

Returns true if the field is or will be indexed, or false if it was created with \*(C`UnIndexed\*(C'.

is_tokenized

Returns true if the field is or will be tokenized, or false if it was created with \*(C`UnIndexed\*(C' or \*(C`Keyword\*(C'.

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.