• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
  • new( [labeled params] )
• METHODS
  • set_doc_id(doc_id)
  • get_doc_id()
  • get_fields()
• INHERITANCE

NAME

Lucy::Document::Doc - A document.

SYNOPSIS

    my $doc = Lucy::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 = Lucy::Document::Doc->new(
        fields => { foo => 'foo foo', bar => 'bar bar' },
    );

• fields - Field-value pairs.

• doc_id - Internal Lucy document id. Default of 0 (an invalid doc id).

METHODS

set_doc_id(doc_id)

Set internal Lucy document id.

get_doc_id()

Retrieve internal Lucy document id.

get_fields()

Return the Doc's backing fields hash.

INHERITANCE

Lucy::Document::Doc isa Clownfish::Obj.