Project Lucy has retired. For details please refer to its Attic page.
Lucy::Index::PostingListReader – C API Documentation
Apache Lucy™

Lucy::Index::PostingListReader

parcel Lucy
class variable LUCY_POSTINGLISTREADER
struct symbol lucy_PostingListReader
class nickname lucy_PListReader
header file Lucy/Index/PostingListReader.h

Name

Lucy::Index::PostingListReader – Read postings data.

Description

PostingListReaders produce PostingList objects which convey document matching information.

Methods

Posting_List (abstract)
lucy_PostingList* // incremented
lucy_PListReader_Posting_List(
    lucy_PostingListReader *self,
    cfish_String *field,
    cfish_Obj *term
);

Returns a PostingList, or NULL if either field is NULL or field is not present in any documents.

field

A field name.

term

If supplied, the PostingList will be pre-located to this term using Seek().

Aggregator
lucy_PostingListReader* // incremented
lucy_PListReader_Aggregator(
    lucy_PostingListReader *self,
    cfish_Vector *readers,
    lucy_I32Array *offsets
);

Returns NULL since PostingLists may only be iterated at the segment level.

Methods inherited from Lucy::Index::DataReader

Get_Schema
lucy_Schema*
lucy_PListReader_Get_Schema(
    lucy_PostingListReader *self
);

Accessor for “schema” member var.

Get_Folder
lucy_Folder*
lucy_PListReader_Get_Folder(
    lucy_PostingListReader *self
);

Accessor for “folder” member var.

Get_Snapshot
lucy_Snapshot*
lucy_PListReader_Get_Snapshot(
    lucy_PostingListReader *self
);

Accessor for “snapshot” member var.

Get_Segments
cfish_Vector*
lucy_PListReader_Get_Segments(
    lucy_PostingListReader *self
);

Accessor for “segments” member var.

Get_Segment
lucy_Segment*
lucy_PListReader_Get_Segment(
    lucy_PostingListReader *self
);

Accessor for “segment” member var.

Get_Seg_Tick
int32_t
lucy_PListReader_Get_Seg_Tick(
    lucy_PostingListReader *self
);

Accessor for “seg_tick” member var.

Inheritance

Lucy::Index::PostingListReader is a Lucy::Index::DataReader is a Clownfish::Obj.