NAME

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

SYNOPSIS

           my $proximity_query = LucyX::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 Lucy::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

       LucyX::Search::ProximityQuery isa Lucy::Search::Query isa Lucy::Object::Obj.