• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
• • new
• METHODS
• • set_doc_id
  • get_doc_id
  • get_fields
• INHERITANCE
• COPYRIGHT AND LICENSE

NAME

KinoSearch::Document::Doc - A document.

SYNOPSIS

    my $doc = KinoSearch::Document::Doc->new(
        fields => { foo => 'foo foo', bar => 'bar bar' },
    );
    $indexer->add_doc($doc);

Doc objects allow access to field values via hashref overloading:

    $doc->{foo} = 'new value for field "foo"';
    print "foo: $doc->{foo}\n";

DESCRIPTION

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

CONSTRUCTORS

new( [labeled params] )

    my $doc = KinoSearch::Document::Doc->new(
        fields => { foo => 'foo foo', bar => 'bar bar' },
    );

• fields - Field-value pairs.
• doc_id - Internal KinoSearch document id. Default of 0 (an invalid doc id).

METHODS

set_doc_id(doc_id)

Set internal KinoSearch document id.

get_doc_id()

Retrieve internal KinoSearch document id.

get_fields()

Return the Doc's backing fields hash.

INHERITANCE

KinoSearch::Document::Doc isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE

Copyright 2005-2011 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.