catalyst::controller::sru(3pm) [debian man page]

Catalyst::Controller::SRU(3pm)				User Contributed Perl Documentation			    Catalyst::Controller::SRU(3pm)

NAME

       Catalyst::Controller::SRU - Dispatch SRU methods with Catalyst

SYNOPSIS

	   package MyApp::Controller::SRU;

	   # use it as a base controller
	   use base qw( Catalyst::Controller::SRU );

	   # explain, scan and searchretrieve methods
	   sub explain {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::Explain
		   $sru_response, # ISA SRU::Response::Explain
	       ) = @_;
	   }

	   sub scan {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::Scan
		   $sru_response, # ISA SRU::Response::Scan
		   $cql,	  # ISA CQL::Parser root node
	       ) = @_;

	   }

	   sub searchRetrieve {
	       my ( $self, $c,
		   $sru_request,  # ISA SRU::Request::SearchRetrieve
		   $sru_response, # ISA SRU::Response::SearchRetrieve
		   $cql,	  # ISA CQL::Parser root node
	       ) = @_;
	   }

DESCRIPTION

       This module allows your controller class to dispatch SRU actions ("explain", "scan", and "searchRetrieve") from its own class.

METHODS

   index : Private
       This method will create an SRU request, response and possibly a CQL object based on the type of SRU request it finds. It will then pass the
       data over to your customized method.

SEE ALSO

       o   Catalyst

AUTHOR

       Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE

       Copyright 2005-2009 by Brian Cassidy

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

perl v5.12.4							    2009-12-02					    Catalyst::Controller::SRU(3pm)

SRU::Response::Record(3pm)				User Contributed Perl Documentation				SRU::Response::Record(3pm)

NAME

       SRU::Response::Record - A class for representing a result record in a searchRetrieve response.

SYNOPSIS

	   my $record = SRU::Response::Record->new();
	   $record->recordData( '<title>Huck Finn</title>' );
	   $response->addRecord( $record );

DESCRIPTION

       SRU::Response::Record is used to bundle up the information about a particular metadata record in a SRU::Response::SearchRetrieve object.
       Typically you'll construct a record object and add it to the SearchRetrieve response.

METHODS

   new()
       You must supply the recordSchema and recordData parameters. recordPacking, recordPosition, and extraRecordData may also be supplied.

	   my $record = SRU::Response::Record->new(
	       recordSchema	   => 'info:srw/schema/1/dc-v1.1',
	       recordData	   => '<title>Huckleberry Finn</title>'
	   );

   recordSchema()
       The URI identifier of the XML schema in which the record is encoded. Although the request may use the server's assigned short name, the
       response must always be the full URI.

   recordData()
       The record itself, either as a string or embedded XML. If would like to pass an object in here you may do so as long as it imlements the
       asXML() method.

   recordPacking()
       The packing used in recordData, as requested by the client or the default: "XML".

   recordPosition()
       The position of the record within the result set. If you don't pass this in recordPosition will be automaticlly calculated for you when add
       or retrieve a record from a SRU::Response::SearchRetrieve object.

   extraRecordData()
       Any extra data associated with the record.  See the section on extensions for more information.

   asXML()
perl v5.12.4							    2009-11-20						SRU::Response::Record(3pm)