-
-
27 Feb 2018 08:40:23 UTC
- Distribution: Lucy
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Clone repository
- Issues
- Testers (1251 / 3 / 7)
- Kwalitee
Bus factor: 1- License: apache_2_0
- Perl: v5.8.3
- Activity
24 month- Tools
- Download (1.12MB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- The Apache Lucy Project <dev at lucy dot apache dot org>
- Dependencies
- Clownfish
- 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
my $doc = Lucy::Document::Doc->new( fields => { foo => 'foo foo', bar => 'bar bar' }, );
Create a new Document.
fields - Field-value pairs.
doc_id - Internal Lucy document id. Default of 0 (an invalid doc id).
METHODS
set_doc_id
$doc->set_doc_id($doc_id);
Set internal Lucy document id.
get_doc_id
my $int = $doc->get_doc_id();
Retrieve internal Lucy document id.
store
$doc->store($field, $value);
Store a field value in the Doc.
field - The field name.
value - The value.
get_fields
my $hashref = $doc->get_fields();
Return the Doc's backing fields hash.
get_size
my $int = $doc->get_size();
Return the number of fields in the Doc.
extract
my $obj = $doc->extract($field);
Retrieve the field’s value, or NULL if the field is not present.
field_names
my $arrayref = $doc->field_names();
Return a list of names of all fields present.
INHERITANCE
Lucy::Document::Doc isa Clownfish::Obj.
Module Install Instructions
To install Lucy, copy and paste the appropriate command in to your terminal.
cpanm Lucy
perl -MCPAN -e shell install Lucy
For more information on module installation, please visit the detailed CPAN module installation guide.