SRU::Request::Scan - A class for representing SRU scan requests

SRU documentation Contained in the SRU distribution.

Index

Code Index:

NAME

Top

SRU::Request::Scan - A class for representing SRU scan requests

SYNOPSIS

Top

    ## creating a new request
    my $request = SRU::Request::Scan->new();

DESCRIPTION

Top

SRU::Request::Scan is a class for representing SRU 'scan' requests.

METHODS

Top

new()

The constructor, which you can pass the parameters: version, scanClause responsePosition, maximumTerms, stylesheet, extraRequestData.

    my $request = SRU::Request::Explain->new( 
        version     => '1.1',
        scanClause  => 'horses',
    );

version()

scanClause()

responsePosition()

maximumTerms()

stylesheet()

extraRequestData()

validParams()

cql()

Fetch the root node of the CQL parse tree for the scan clause.

SRU documentation Contained in the SRU distribution. 
package SRU::Request::Scan;

use strict;
use warnings;
use base qw( Class::Accessor SRU::Request );
use SRU::Utils qw( error );


sub new {
    my ($class,%args) = @_;
    return $class->SUPER::new( \%args );
}


my @validParams = qw( 
    version
    scanClause
    responsePosition
    maximumTerms
    stylesheet
    extraRequestData
);


sub validParams { return @validParams; }

SRU::Request::Scan->mk_accessors( @validParams );


sub cql {
    my $self = shift;
    my $clause = $self->scanClause();
    return '' unless $clause;
    my $node;
    my $parser = CQL::Parser->new();
    eval { $node = $parser->parse( $clause ) };
    return $node;
}


1;