Stray Taoist > Plucene-1.19 > Plucene::Document::Field

Download:
Plucene-1.19.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  4
View Bugs
Report a bug
Source   Latest Release: Plucene-1.25

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::Fields. Each of these fields can be stored, indexed or tokenised.

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.