/usr/lib/x86_64-linux-gnu/perl5/5.24/Lucy/Plan/FieldType.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 | # 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::Plan::FieldType - Define a field's behavior.
=head1 SYNOPSIS
my @sortable;
for my $field ( @{ $schema->all_fields } ) {
my $type = $schema->fetch_type($field);
next unless $type->sortable;
push @sortable, $field;
}
=head1 DESCRIPTION
FieldType is an abstract class defining a set of traits and behaviors which
may be associated with one or more field names.
Properties which are common to all field types include C<< boost >>,
C<< indexed >>, C<< stored >>, C<< sortable >>,
C<< binary >>, and C<< similarity >>.
The C<< boost >> property is a floating point scoring multiplier
which defaults to 1.0. Values greater than 1.0 cause the field to
contribute more to a document's score, lower values, less.
The C<< indexed >> property indicates whether the field should be
indexed (so that it can be searched).
The C<< stored >> property indicates whether to store the raw field
value, so that it can be retrieved when a document turns up in a search.
The C<< sortable >> property indicates whether search results should
be sortable based on the contents of the field.
The C<< binary >> property indicates whether the field contains
binary or text data. Unlike most other properties, C<< binary >> is
not settable.
The C<< similarity >> property is a
L<Similarity|Lucy::Index::Similarity> object which defines matching
and scoring behavior for the field. It is required if the field is
C<< indexed >>.
=head1 METHODS
=head2 get_boost()
Accessor for C<< boost >>.
=head2 indexed()
Accessor for C<< indexed >>.
=head2 stored()
Accessor for C<< stored >>.
=head2 sortable()
Accessor for C<< sortable >>.
=head2 binary()
Indicate whether the field contains binary data.
=head1 INHERITANCE
Lucy::Plan::FieldType isa L<Lucy::Object::Obj>.
=cut
|