Lucy::Index::DataReader(3pm)

Lucy::Index::DataReader3pm

Abstract base class for reading index data.

Usage

    # Abstract base class.

Overview

DataReader is the companion class to DataWriter. Every index component will implement one of each.

Constructors

new( [labeled params] )

    my $reader = MyDataReader->new(
        schema   => $seg_reader->get_schema,      # default undef
        folder   => $seg_reader->get_folder,      # default undef
        snapshot => $seg_reader->get_snapshot,    # default undef
        segments => $seg_reader->get_segments,    # default undef
        seg_tick => $seg_reader->get_seg_tick,    # default -1
    );
•

schema - A Schema.

•

folder - A Folder.

•

snapshot - A Snapshot.

•

segments - An array of Segments.

•

seg_tick - The array index of the Segment object within the "segments" array that this particular DataReader is assigned to, if any. A value of -1 indicates that no Segment should be assigned.

Abstract methods

aggregator( [labeled params] )

Create a reader which aggregates the output of several lower level readers. Return undef if such a reader is not valid.

•

readers - An array of DataReaders.

•

offsets - Doc id start offsets for each reader.

Methods

get_schema()

Accessor for "schema" member var.

get_folder()

Accessor for "folder" member var.

get_snapshot()

Accessor for "snapshot" member var.

get_segments()

Accessor for "segments" member var.

get_segment()

Accessor for "segment" member var.

get_seg_tick()

Accessor for "seg_tick" member var.

Inheritance

Lucy::Index::DataReader isa Lucy::Object::Obj.

Releases

2 releases since Debian 8 (Jessie); the text changed 1 time.

  1. 8
  2. 9

From liblucy-perl 0.3.3-7+b1 in Debian 9 (Stretch). Parsed by carta from the page's man source.