NAME

       Lucy::Plan::FullTextType - Full-text search field type.

SYNOPSIS

           my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new(
               language => 'en',
           );
           my $type = Lucy::Plan::FullTextType->new(
               analyzer => $polyanalyzer,
           );
           my $schema = Lucy::Plan::Schema->new;
           $schema->spec_field( name => 'title',   type => $type );
           $schema->spec_field( name => 'content', type => $type );

DESCRIPTION

       Lucy::Plan::FullTextType is an implementation of Lucy::Plan::FieldType tuned for "full
       text search".

       Full text fields are associated with an Analyzer, which is used to tokenize and normalize
       the text so that it can be searched for individual words.

       For an exact-match, single value field type using character data, see StringType.

CONSTRUCTORS

   new( [labeled params] )
           my $type = Lucy::Plan::FullTextType->new(
               analyzer      => $analyzer,    # required
               boost         => 2.0,          # default: 1.0
               indexed       => 1,            # default: true
               stored        => 1,            # default: true
               sortable      => 1,            # default: false
               highlightable => 1,            # default: false
           );

       •   analyzer - An Analyzer.

       •   boost - floating point per-field boost.

       •   indexed - boolean indicating whether the field should be indexed.

       •   stored - boolean indicating whether the field should be stored.

       •   sortable - boolean indicating whether the field should be sortable.

       •   highlightable - boolean indicating whether the field should be highlightable.

METHODS

   set_highlightable(highlightable)
       Indicate whether to store data required by Lucy::Highlight::Highlighter for excerpt
       selection and search term highlighting.

   highlightable()
       Accessor for "highlightable" property.

INHERITANCE

       Lucy::Plan::FullTextType isa Lucy::Plan::TextType isa Lucy::Plan::FieldType isa
       Lucy::Object::Obj.