The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Search::Kinosearch::Doc - a document.

DEPRECATED

Search::Kinosearch has been superseded by KinoSearch. Please use the new version.

SYNOPSIS

    my $kindexer = Search::Kinosearch::Kindexer->new;
    ...
    my $doc = $kindexer->new_doc( $unique_doc_id );
    
    ### or...
    
    my $ksearch = Search::Kinosearch::KSearch->new;
    ...
    while (my $doc = $ksearch->fetch_next_result) {
        print $doc->get_field('title') . "\n";
    }

DESCRIPTION

Search::Kinosearch::Doc objects are logical representations of documents that you feed into the Kindexer. They are organized as collections of fields -- like database rows.

CONSTRUCTOR

Not accessible. Doc objects must be spawned by either Kindexer or KSearch objects.

METHODS

set_field()

Set the contents of a field.

get_field()

Retrieve the contents of a field.

set_datetime()

    $doc->set_datetime($Y,$M,$D,$h,$m,$s);

Assign a datetime to the document. 6 arguments are required: year month day hour minute second. Kinosearch uses the same conventions as Steffen Beyer's excellent Date::Calc module, which you will probably want to use.

The value for the year must fit within a 16 bit signed int (at least until someone points me at a module that can turn YMDHMS into a 64bit timestamp).

SEE ALSO

AUTHOR

Marvin Humphrey <marvin at rectangular dot com> http://www.rectangular.com

COPYRIGHT

Copyright (c) 2005 Marvin Humphrey. All rights reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.