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

Lucy::Index::LexiconReader

parcel Lucy
class variable LUCY_LEXICONREADER
struct symbol lucy_LexiconReader
class nickname lucy_LexReader
header file Lucy/Index/LexiconReader.h

Name

Lucy::Index::LexiconReader – Read Lexicon data.

Description

LexiconReader reads term dictionary information.

Methods

Lexicon (abstract)
lucy_Lexicon* // incremented
lucy_LexReader_Lexicon(
    lucy_LexiconReader *self,
    cfish_String *field,
    cfish_Obj *term
);

Return a new Lexicon for the given field. Will return NULL if either the field is not indexed, or if no documents contain a value for the field.

field

Field name.

term

Pre-locate the Lexicon to this term.

Doc_Freq (abstract)
uint32_t
lucy_LexReader_Doc_Freq(
    lucy_LexiconReader *self,
    cfish_String *field,
    cfish_Obj *term
);

Return the number of documents where the specified term is present.

Aggregator
lucy_LexiconReader* // incremented
lucy_LexReader_Aggregator(
    lucy_LexiconReader *self,
    cfish_Vector *readers,
    lucy_I32Array *offsets
);

Return a LexiconReader which merges the output of other LexiconReaders.

readers

An array of LexiconReaders.

offsets

Doc id start offsets for each reader.

Methods inherited from Lucy::Index::DataReader

Get_Schema
lucy_Schema*
lucy_LexReader_Get_Schema(
    lucy_LexiconReader *self
);

Accessor for “schema” member var.

Get_Folder
lucy_Folder*
lucy_LexReader_Get_Folder(
    lucy_LexiconReader *self
);

Accessor for “folder” member var.

Get_Snapshot
lucy_Snapshot*
lucy_LexReader_Get_Snapshot(
    lucy_LexiconReader *self
);

Accessor for “snapshot” member var.

Get_Segments
cfish_Vector*
lucy_LexReader_Get_Segments(
    lucy_LexiconReader *self
);

Accessor for “segments” member var.

Get_Segment
lucy_Segment*
lucy_LexReader_Get_Segment(
    lucy_LexiconReader *self
);

Accessor for “segment” member var.

Get_Seg_Tick
int32_t
lucy_LexReader_Get_Seg_Tick(
    lucy_LexiconReader *self
);

Accessor for “seg_tick” member var.

Inheritance

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