GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PLUCENE::DOCUMENT::FIELD (3)

.ds Aq ’

NAME

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

CONTENTS

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 UnIndexed.

    is_tokenized

Returns true if the field is or will be tokenized, or false if it was created with UnIndexed 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PLUCENE::DOCUMENT::FIELD (3) 2005-09-05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.