View on
MetaCPAN
Mike Taylor > ZOOM-IRSpy > ZOOM::IRSpy::Stats

Download:
ZOOM-IRSpy-1.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

ZOOM::IRSpy::Stats - statistics generated for IRSpy about its targets

SYNOPSIS ^

 $stats = new ZOOM::IRSpy::Stats($dbname);
 $stats->print();

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 printed using the built-in debugging print() method, or the application can walk the structure to produce nice output.

METHODS ^

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::Connection("target/string/for/irspy/database"); 
 $stats = new ZOOM::IRSpy::Stats($spy, $query);

Creates a new ZOOM::IRSpy::Stats 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:

$conn (mandatory)

An indication of the IRSpy database that statistics are required for. This may be in the form of a ZOOM::Connection object or a database-name string such as localhost:8018/IR-Explain---1.

$query (optional)

The query with which to select a subset of the database to be analysed. This may be in the form of a ZOOM::Query 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.

print()

 $stats->print();

Prints an ugly but human-readable summary of the statistics on standard output.

SEE ALSO ^

ZOOM::IRSpy

AUTHOR ^

Mike Taylor, <mike@indexdata.com>

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.

syntax highlighting: