/ 
KinoSearch-0.311
River stage two • 9 direct dependents • 10 total dependents
/ KinoSearch::Plan::FullTextType

NAME

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

SYNOPSIS

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

DESCRIPTION

KinoSearch::Plan::FullTextType is an implementation of KinoSearch::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 = KinoSearch::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 KinoSearch::Highlight::Highlighter for excerpt selection and search term highlighting.

highlightable()

Accessor for "highlightable" property.

INHERITANCE

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

COPYRIGHT AND LICENSE

Copyright 2005-2010 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.