The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
KinoSearch-0.315
River stage two • 9 direct dependents • 10 total dependents
1 ++
/ KSx::Search::ProximityQuery

NAME

KSx::Search::ProximityQuery - Query matching an ordered list of terms.

DEPRECATED

The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home: http://lucy.apache.org/

SYNOPSIS

    my $proximity_query = KSx::Search::ProximityQuery->new( 
        field  => 'content',
        terms  => [qw( the who )],
        within => 10,    # match within 10 positions
    );
    my $hits = $searcher->hits( query => $proximity_query );

DESCRIPTION

ProximityQuery is a subclass of KinoSearch::Search::Query for matching against an ordered sequence of terms.

CONSTRUCTORS

new( [labeled params] )

  • field - The field that the phrase must occur in.

  • terms - The ordered array of terms that must match.

METHODS

get_field()

Accessor for object's field attribute.

get_terms()

Accessor for object's array of terms.

get_within()

Accessor for object's within attribute.

INHERITANCE

KSx::Search::ProximityQuery isa KinoSearch::Search::Query isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE

Copyright 2005-2011 Marvin Humphrey

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