The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

KinoSearch::Search::SortSpec - Specify a custom sort order for search results.

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 $sort_spec = KinoSearch::Search::SortSpec->new(
        rules => [
            KinoSearch::Search::SortRule->new( field => 'date' ),
            KinoSearch::Search::SortRule->new( type  => 'doc_id' ),
        ],
    );
    my $hits = $searcher->hits(
        query     => $query,
        sort_spec => $sort_spec,
    );

DESCRIPTION

By default, searches return results in order of relevance; SortSpec allows you to indicate an alternate order via an array of SortRules.

Fields you wish to sort against must be sortable.

For a stable sort (important when paging through results), add a sort-by-doc rule as the last SortRule.

CONSTRUCTORS

new( [labeled params] )

    my $sort_spec = KinoSearch::Search::SortSpec->new( rules => \@rules );
  • rules - An array of SortRules.

INHERITANCE

KinoSearch::Search::SortSpec 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.