/usr/lib/x86_64-linux-gnu/perl5/5.24/Lucy/Index/DataReader.pod is in liblucy-perl 0.3.3-7+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | # Auto-generated file -- DO NOT EDIT!!!!!
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
=head1 NAME
Lucy::Index::DataReader - Abstract base class for reading index data.
=head1 SYNOPSIS
# Abstract base class.
=head1 DESCRIPTION
DataReader is the companion class to
L<DataWriter|Lucy::Index::DataWriter>. Every index component will
implement one of each.
=head1 CONSTRUCTORS
=head2 new( I<[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
);
=over
=item *
B<schema> - A Schema.
=item *
B<folder> - A Folder.
=item *
B<snapshot> - A Snapshot.
=item *
B<segments> - An array of Segments.
=item *
B<seg_tick> - The array index of the Segment object within the
C<< segments >> array that this particular DataReader is assigned
to, if any. A value of -1 indicates that no Segment should be
assigned.
=back
=head1 ABSTRACT METHODS
=head2 aggregator( I<[labeled params]> )
Create a reader which aggregates the output of several lower level
readers. Return undef if such a reader is not valid.
=over
=item *
B<readers> - An array of DataReaders.
=item *
B<offsets> - Doc id start offsets for each reader.
=back
=head1 METHODS
=head2 get_schema()
Accessor for "schema" member var.
=head2 get_folder()
Accessor for "folder" member var.
=head2 get_snapshot()
Accessor for "snapshot" member var.
=head2 get_segments()
Accessor for "segments" member var.
=head2 get_segment()
Accessor for "segment" member var.
=head2 get_seg_tick()
Accessor for "seg_tick" member var.
=head1 INHERITANCE
Lucy::Index::DataReader isa L<Lucy::Object::Obj>.
=cut
|