Andrew Nelson > Data-SearchEngine-0.33 > Data::SearchEngine::Modifiable

Download:
Data-SearchEngine-0.33.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.33   Source  

NAME ^

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

VERSION ^

version 0.33

DESCRIPTION ^

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@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Cold Hard Code, LLC.

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

syntax highlighting: