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  -  KINOSEARCH1::DOCUMENT::DOC (3)

.ds Aq ’

NAME

KinoSearch1::Document::Doc - a document

CONTENTS

SYNOPSIS



    my $doc = $invindexer->new_doc;
    $doc->set_value( title    => $title );
    $doc->set_value( bodytext => $bodytext );
    $invindexer->add($doc);



DESCRIPTION

A Doc object is akin to a row in a database, in that it is made up of several fields, each of which has a value.

Doc objects are only created via factory methods of other classes.

METHODS

    set_value get_value



    $doc->set_value( title => $title_text );
    my $text = $doc->get_value( title );



set_value and get_value are used to modify and access the values of the fields within a Doc object.

    set_boost get_boost



    $doc->set_boost(2.5);



boost is a scoring multiplier. Setting boost to something other than 1 causes a document to score better or worse against a given query relative to other documents.

COPYRIGHT

Copyright 2005-2010 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch1 version 1.01.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 KINOSEARCH1::DOCUMENT::DOC (3) 2016-03-17

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