webservice::solr::document(3pm) [debian man page]

WebService::Solr::Document(3pm) 			User Contributed Perl Documentation			   WebService::Solr::Document(3pm)

NAME

       WebService::Solr::Document - A document object

SYNOPSIS

	   my $doc = WebService::Solr::Document->new;
	   $doc->add_fields( @fields );
	   $doc->boost( 2.0 );
	   my $id = $doc->value_for( 'id' );
	   my @subjects = $doc->values_for( 'subject' );

DESCRIPTION

       This class represents a basic document object, which is basically a collection of fields.

ACCESSORS

       o   fields - an array of fields

       o   boost - a floating-point "boost" value

METHODS

   new( @fields|@fields )
       Constructs a new document object given @fields. A field can be a WebService::Solr::Field object, or a structure accepted by
       "WebService::Solr::Field->new".

   BUILDARGS( @args )
       A Moose override to allow our custom constructor.

   add_fields( @fields|@fields )
       Adds @fields to the document.

   field_names
       Returns a list of field names that are in this document.

   value_for( $name )
       Returns the first value for $name.

   values_for( $name )
       Returns all values for $name.

   to_element( )
       Serializes the object to an XML::Easy::Element object.

   to_xml( )
       Serializes the object to xml.

AUTHORS

       Brian Cassidy <bricas@cpan.org>

       Kirk Beers

COPYRIGHT AND LICENSE

       Copyright 2008-2012 National Adult Literacy Database

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

perl v5.14.2							    2012-05-24					   WebService::Solr::Document(3pm)

WebService::Solr::Response(3pm) 			User Contributed Perl Documentation			   WebService::Solr::Response(3pm)

NAME

       WebService::Solr::Response - Parse responses from Solr

SYNOPSIS

	   my $res = WebService::Solr::Response->new( $http_res );
	   for my $doc( $res->docs ) {
	       print $doc->value_for( 'id'), "
";
	   }
	   my $pager = $res->pager;

DESCRIPTION

       This class encapsulates responses from the Solr Web Service. Typically it is used when documents are returned from a search query, though
       it will accept all responses from the service.

ACCESSORS

       o   raw_response - the raw HTTP::Response object.

       o   content - a hashref of deserialized JSON data from the response.

       o   docs - an array of WebService::Solr::Document objects.

       o   pager - a Data::Page object for the search results.

       o   pageset - a Data::Pageset object for the search results. Takes the same arguments as "Data::Pageset->new" does. All arguments optional.

METHODS

   new( $response )
       Given an HTTP::Response object, it will parse the returned data as required.

   BUILDARGS( @args )
       A Moose override to allow our custom constructor.

   facet_counts( )
       A shortcut to the "facet_counts" key in the response data.

   spellcheck( )
       A shortcut to the "spellcheck" key in the response data.

   solr_status( )
       Looks for the status value in the response data.

   ok( )
       Calls "solr_status()" and check that it is equal to 0.

AUTHORS

       Brian Cassidy <bricas@cpan.org>

       Kirk Beers

COPYRIGHT AND LICENSE

       Copyright 2008-2012 National Adult Literacy Database

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

perl v5.14.2							    2012-05-24					   WebService::Solr::Response(3pm)