Logan Bell > Lucy-0.3.2 > Lucy::Document::Doc

Download:
Lucy-0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.003002   Source   Latest Release: Lucy-0.3.3

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' },
    );

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 Lucy::Object::Obj.

syntax highlighting: