From ee18d29eeacad380a9382878bf7fcfb3e43b6f0b Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Thu, 14 Dec 2006 17:34:57 +0000 Subject: [PATCH] New, fully documented but not much code yet! --- lib/ZOOM/IRSpy/Stats.pm | 93 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 lib/ZOOM/IRSpy/Stats.pm diff --git a/lib/ZOOM/IRSpy/Stats.pm b/lib/ZOOM/IRSpy/Stats.pm new file mode 100644 index 0000000..631b516 --- /dev/null +++ b/lib/ZOOM/IRSpy/Stats.pm @@ -0,0 +1,93 @@ +# $Id: Stats.pm,v 1.1 2006-12-14 17:34:57 mike Exp $ + +package ZOOM::IRSpy::Stats; + +use 5.008; +use strict; +use warnings; + +=head1 NAME + +ZOOM::IRSpy::Stats - statistics generated for IRSpy about its targets + +=head1 SYNOPSIS + + $stats = new ZOOM::IRSpy::Stats($dbname); + use Data::Dumper; print Dumper($stats); + +=head1 DESCRIPTION + +Provides a simple API to obtaining statistics about targets registered +in IRSpy. This is done just by creating a Stats object. Once this +object is made, it can be crudely dumped, or the application can walk +the structure to produce nice output. + +=head1 METHODS + +=head2 new() + + $stats = new ZOOM::IRSpy::Stats($dbname, "dc.creator=wedel"); + # Or: + $stats = new ZOOM::IRSpy::Stats($dbname, + new ZOOM::Query::PQF('@attr 1=1003 wedel'); + # Or: + $spy = new ZOOM::IRSpy("target/string/for/irspy/database"); + $stats = new ZOOM::IRSpy::Stats($spy, $query); + +Creates a new C object and populates it with +statistics for the targets in the nominated database. This process +involves analysing the nominated IRSpy database at some length, and +which therefore takes some time + +Either one or two arguments are required: + +=over 4 + +=item $irspy (mandatory) + +An indication of the IRSpy database that statistics are required for. +This may be in the form of a C object or a database-name +string such as C. + +=item $query (optional) + +The query with which to select a subset of the database to be +analysed. This may be in the form of a C object (using +any of the supported subclasses) or a CQL string. If this is omitted, +then all records in the database are included in the generated +statistics. + +=back + +=cut + +sub new { + my $class = shift(); + my($irspy, $query) = @_; + + return bless { + irspy => $irspy, + query => $query || "cql.allRecords=1", + }, $class; +} + + +=head1 SEE ALSO + +ZOOM::IRSpy + +=head1 AUTHOR + +Mike Taylor, Emike@indexdata.comE + +=head1 COPYRIGHT AND LICENSE + +Copyright (C) 2006 by Index Data ApS. + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself, either Perl version 5.8.7 or, +at your option, any later version of Perl 5 you may have available. + +=cut + +1; -- 1.7.10.4