• NAME
• DEPRECATED
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
  • new( [labeled params] )
• METHODS
  • get_field()
  • get_reverse()
• INHERITANCE
• COPYRIGHT AND LICENSE

NAME

KinoSearch::Search::SortRule - Element of a SortSpec.

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' ),
        ],
    );

DESCRIPTION

SortRules are the building blocks used to assemble SortSpecs; each SortRule defines a single level of sorting. For example, sorting first by "category" then by score requires a SortSpec with two SortRule elements.

CONSTRUCTORS

new( [labeled params] )

    my $by_title   = KinoSearch::Search::SortRule->new( field => 'title' );
    my $by_score   = KinoSearch::Search::SortRule->new( type  => 'score' );
    my $by_doc_id  = KinoSearch::Search::SortRule->new( type  => 'doc_id' );
    my $reverse_date = KinoSearch::Search::SortRule->new(
        field   => 'date',
        reverse => 1,
    );

• type - Indicate whether to sort by score, field, etc. (The default is to sort by a field.)

• field - The name of a sortable field.

• reverse - If true, reverse the order of the sort for this rule.

METHODS

get_field()

Accessor for "field" member.

get_reverse()

Accessor for "reverse" member.

INHERITANCE

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