-
-
11 Aug 2011 02:55:56 UTC
- Distribution: Lucy
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (1)
- Testers (3 / 16 / 0)
- Kwalitee
Bus factor: 1- License: apache_2_0
- Perl: v5.8.3
- Activity
24 month- Tools
- Download (1.02MB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- The Apache Lucy Project <lucy-dev at incubator dot apache dot org>
- Dependencies
- JSON::XS
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
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 Lucy::Object::Obj.
Module Install Instructions
To install Lucy::Simple, copy and paste the appropriate command in to your terminal.
cpanm Lucy::Simple
perl -MCPAN -e shell install Lucy::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.