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 (3)

.ds Aq ’

NAME

Plucene::Document - The unit of indexing and searching

CONTENTS

SYNOPSIS



        my $document = Plucene::Document->new;

        $document->add( Plucene::Document::Field $field);
        my Plucene::Document::Field $field = $document->get($field_name);
       
        my Plucene::Document::Fields @fields = $document->fields;



DESCRIPTION

Documents are the unit of indexing and search, and each document is a set of fields. Each field has a name and a textual value.

A field may be stored with the document, in which case it is returned with search hits on the document. Thus each document should typically contain stored fields which uniquely identify it.

METHODS

    get



        my Plucene::Document::Field $field = $document->get($field_name);



This returns the Plucene::Document::Field object of the field with the given name if any exist in this document, or null.

    add



        $document->add( Plucene::Document::Field $field);



This will add a field to the document.

    fields



        my Plucene::Document::Field @fields = $document->fields;



This returns an list of all the fields in a document.

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


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

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