Peter Karman > SWISH-Prog-0.71 > SWISH::Prog::Native::Searcher

Download:
SWISH-Prog-0.71.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.71   Source   Latest Release: SWISH-Prog-0.75

NAME ^

SWISH::Prog::Native::Searcher - wrapper for SWISH::API::Object

SYNOPSIS ^

 # see SWISH::Prog::Searcher

DESCRIPTION ^

The Native Searcher is a thin wrapper around SWISH::API::Object.

METHODS ^

init

Instantiates the SWISH::API::Object instance and stores it in the swish() accessor.

sao_opts( array_ref )

Options to pass to SWISH::API::Object in new().

result_class( class_name )

Passed to SWISH::API::Object in new().

swish

The SWISH::API::Object instance.

search( query, opts )

Calls the query() method on the internal SWISH::API::Object. Returns a SWISH::API::Object::Results object.

opts is an optional hashref with the following supported key/values:

start

The starting position. Default is 0.

max

The ending position. Default is max_hits() as documented in SWISH::Prog::Searcher.

order

Takes a SQL-like sort string in pattern field direction. See the Swish-e docs for sort string details.

limit

Takes an arrayref of arrayrefs. Each child arrayref should have three values: a field (PropertyName) value, a lower limit and an upper limit.

rank_scheme

Takes an int, 0 or 1. Default is 1.

default_boolop

The default boolean connector for parsing query. Valid values are AND and OR. The default is AND.

AUTHOR ^

Peter Karman, <perl@peknet.com>

BUGS ^

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. 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 SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright 2008-2009 by Peter Karman

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

SEE ALSO ^

http://swish-e.org/

syntax highlighting: