David E. Wheeler > Lucy-0.2.2 > Lucy::Index::SegWriter

Download:
Lucy-0.2.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Source   Latest Release: Lucy-0.3.3

NAME ^

Lucy::Index::SegWriter - Write one segment of an index.

DESCRIPTION ^

SegWriter is a conduit through which information fed to Indexer passes. It manages Segment and Inverter, invokes the Analyzer chain, and feeds low level DataWriters such as PostingListWriter and DocWriter.

The sub-components of a SegWriter are determined by Architecture. DataWriter components which are added to the stack of writers via add_writer() have add_inverted_doc() invoked for each document supplied to SegWriter's add_doc().

METHODS ^

add_doc( [labeled params] )

Add a document to the segment. Inverts doc, increments the Segment's internal document id, then calls add_inverted_doc(), feeding all sub-writers.

add_writer(writer)

Add a DataWriter to the SegWriter's stack of writers.

register( [labeled params] )

Register a DataWriter component with the SegWriter. (Note that registration simply makes the writer available via fetch(), so you may also want to call add_writer()).

fetch(api)

Retrieve a registered component.

INHERITANCE ^

Lucy::Index::SegWriter isa Lucy::Index::DataWriter isa Lucy::Object::Obj.

syntax highlighting: