WebService::Lucene - Module to interface with the Lucene indexing webservice
# Connect to the web service $ws = WebService::Lucene->new( $url ); # Create an index $ndex = $ws->create_index( $index ); # Get a particular index $index = $ws->get_index( $name ); # Index a document $document = $index->add_document( $document ); # Get a document $document = $index->get_document( $id ); # Delete the document $document->delete; # Search an index $results = $index->search( $query ); # Get documents from search @documents = $results->documents; # Delete an index $index->delete;
This module is a Perl API in to the Lucene indexing web service. http://lucene-ws.net/
This method will connect to the Lucene Web Service located at $url.
$url
my $ws = WebService::Lucene->new( 'http://localhost:8080/lucene/' );
Accessor for the base url of the service.
Retuens an WebService::Lucene::Index object for $name.
$name
Alias for indices
indices
Returns an array of WebService::Lucene::Index objects.
Hash reference to a list of properties for the service.
Grabs the service.properties documents and sends the contents to _parse_service_properties.
service.properties
_parse_service_properties
Parses the XML and populates the object's properties
properties
Connects to the service url and passes the contents on to _parse_service_document.
_parse_service_document
Parses the Atom Publishing Protocol introspection document and populates the service's indices.
Accessor for the title of the service.
Shortcut for fetching the content at $url.
Creates the index on the server and returns the WebService::Lucene::Index object.
Deletes an index.
Updates the service.properties document.
Genereates an XML::Atom::Entry suitable for updating the service.properties document.
Searches one or more indices for $query. Returns an WebService::Lucene::Results object.
$query
my $results = $ws->search( [ 'index1', 'index2' ], 'foo' );
Gets facets for one or more indices. Returns an WebService::Lucene::Results object.
my $results = $ws->facets( [ 'index1', 'index2' ] );
XML::Atom::Client
WWW::OpenSearch
http://lucene-ws.net/
Brian Cassidy <bricas@cpan.org>
Adam Paynter <adapay@cpan.org>
Copyright 2006-2009 National Adult Literacy Database
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install WebService::Lucene, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::Lucene
CPAN shell
perl -MCPAN -e shell install WebService::Lucene
For more information on module installation, please visit the detailed CPAN module installation guide.