POD: Search::Lemur::ResultItem

NAME

Search::Lemur::ResultItem

VERSION

Version 1.0

DESCRIPTION

# 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 die.
sub _new {
    my $class = shift;
    my $self = {};
    if (scalar(@_) == 3) {
        my ($docid, $doclen, $tf) = @_;
        $self = { docid => $docid,
                 doclen => $doclen,
                 tf => $tf };
    } else { die ``Not enough arguments to create a resultItem object.''; }
    bless $self, $class;
    return $self;
}

Main Methods

docid

Get the document ID value for this result.

doclen

Get the document length for this result.

tf

Get the term frequency value for this result.

equals

Test equality between this resultItem 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.