NAME

Data::SearchEngine::Modifiable - A role for search engines with an updateable index.

SYNOPSIS

This is an add-on role that is used in conjunction with Data::SearchEngine when wrapping an index that can be updated. Since some indexes may be read only, the idea is to keep the required methods in this role separate from the base one.

METHODS

add ($thing)

Adds the specified thing to the index.

present ($thing)

Returns true if the specified thing is present in the index.

remove ($thing)

Removes the specified thing from the index. Consult the documentation for your specific backend.

remove_by_id ($id)

Remove a specific thing by id.

update ($thing)

Updates the specified thing in the index.

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.