Marvin Humphrey > KinoSearch-0.30_03 > KinoSearch::FieldType::FullTextType

Download:
KinoSearch-0.30_03.tar.gz

Annotate this POD

CPAN RT

Open  7
View Bugs
Report a bug
Source   Latest Release: KinoSearch-0.30_07

NAME ^

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

SYNOPSIS ^

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

DESCRIPTION ^

KinoSearch::FieldType::FullTextType is an implementation of KinoSearch::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 a sortable, single-value field type using character data, see StringType.

CONSTRUCTORS ^

new( [labeled params] )

    my $type = KinoSearch::FieldType::FullTextType->new(
        analyzer      => $analyzer,    # required
        boost         => 2.0,          # default: 1.0
        indexed       => 1,            # default: true
        stored        => 1,            # default: true
        highlightable => 1,            # default: false
    );

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::FieldType::FullTextType isa KinoSearch::FieldType::TextType isa KinoSearch::FieldType isa KinoSearch::Obj.

COPYRIGHT ^

Copyright 2005-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc. ^

See KinoSearch version 0.30.