POD: Search::Lemur::Result

NAME

Search::Lemur::Result

VERSION

Version 1.0

DESCRIPTION

Stores the results from a lemur query for a single term. 

# create a new result object.  This should only be called by a
# Lemur object, in its query method.  One of these will be created
# for every result returned by the query.
#
# The arguments are query term, the document ID, document length,
# and term frequency.
#
# If these arguments are not given, this will return undef
sub _new {
    my $class = shift;
    my $self = {};
    if (scalar(@_) >= 3) {
        my ($term, $ctf, $df) = @_;
        $self = { term => $term,
                 ctf => $ctf,
                 df => $df,
                 lines => [] };
    } else { return undef; }
    bless $self, $class;
    return $self;
}

Main Methods

ctf

Get the corpus term frequency for this result.

term

Get the query term for this result.

Returns the number of times this term occured in the corpus.

df

Get the document frequency for this result.

Returns the number of documents this term occurred in.

docs

Get the array of documents returned by this query.

Returns an array of resultItem objects.

equals

Test equality between this result and the given one (used mostly for
testing).

AUTHOR

Patrick Kaeding, <pkaeding at cpan.org>

BUGS

Please report any bugs or feature requests to
bug-search-lemur at rt.cpan.org, or through the web interface at
http://rt.cpan.org/NoAuth/ReportBug.html.
I will be notified, and then you’ll automatically be notified of progress on
your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Search::Lemur
    You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2007 Patrick Kaeding, all rights reserved.

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