/ 
Data-SearchEngine-0.04
River stage one • 2 direct dependents • 2 total dependents
/ Data::SearchEngine

NAME

Data::SearchEngine - A role for search engines and serializable results.

SYNOPSIS

package Data::SearchEngine::MySearch;

with 'Data::SearchEngine';

sub search {
  my ($self, $query) = @_;

  # ... your internal search junk

  my $result = Data::SearchEngine::Results->new(
      query => $query,
      pager => # ... make a Data::Page
  );

  foreach my $hit (@hits) {
      $result->add(Data::SearchEngine::Item->new(
          values => {
              name => $hit->name,
              description => $hit->description
          },
          score => $hit->score
      ));
  }

  return $result;
}

DESCRIPTION

There are lots of search engine libraries. Each has a different interface. The goal of Data::SearchEngine is to provide a simple, extensive set of classes and roles that you can use to wrap a search implementation. The net result will be an easily swappable backend with a common set of features, such as serialize of results for use with a cache.

Step 1 - Extend the Query

Subclass the Data::SearchEngine::Query object and add attributes that are needed for your implementation. Be sure to use the Digestable trait for any attributes that contribute to the results to guarantee uniqueness.

Step 2 - Wrap a search implementation

The first step is to use the Data::SearchEngine role in a class that wraps your search implementation. You can find an example in Data::SearchEngine::Results.

Step 3 - Profit!!!

Optionally setup a caching implementation using Query's digest method and the freeze/thaw methods from Results.

WARNING

This module is under very active development and the API may change. Consider this a development release and please send along sugguestions!

AUTHOR

Cory G Watson, <gphat at cpan.org>

COPYRIGHT & LICENSE

Copyright 2009 Cory G Watson

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.