Marvin Humphrey > Lucy > Lucy::Plan::FullTextType

Download:
Lucy-0.4.1.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.004001   Source  

NAME ^

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

SYNOPSIS ^

    my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
        language => 'en',
    );
    my $type = Lucy::Plan::FullTextType->new(
        analyzer => $easyanalyzer,
    );
    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
    );

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 Clownfish::Obj.

syntax highlighting: