Marvin Humphrey > Lucy > Lucy::Search::Searcher

Download:
Lucy-0.3.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Module Version: 0.003003   Source  

NAME ^

Lucy::Search::Searcher - Base class for searching collections of documents.

SYNOPSIS ^

    # Abstract base class.

DESCRIPTION ^

Abstract base class for objects which search. Core subclasses include Lucy::Search::IndexSearcher and Lucy::Search::PolySearcher.

CONSTRUCTORS ^

new( [labeled params] )

    package MySearcher;
    use base qw( Lucy::Search::Searcher );
    sub new {
        my $self = shift->SUPER::new;
        ...
        return $self;
    }

Abstract constructor.

ABSTRACT METHODS ^

collect( [labeled params] )

Iterate over hits, feeding them into a Collector.

doc_max()

Return the maximum number of docs in the collection represented by the Searcher, which is also the highest possible internal doc id. Documents which have been marked as deleted but not yet purged are included in this count.

doc_freq( [labeled params] )

Return the number of documents which contain the term in the given field.

fetch_doc(doc_id)

Retrieve a document. Throws an error if the doc id is out of range.

METHODS ^

hits( [labeled params] )

Return a Hits object containing the top results.

glean_query(query)

If the supplied object is a Query, return it; if it's a query string, create a QueryParser and parse it to produce a query against all indexed fields.

get_schema()

Accessor for the object's schema member.

INHERITANCE ^

Lucy::Search::Searcher isa Lucy::Object::Obj.

syntax highlighting: