File Coverage

blib/lib/Querylet/Output.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch	2	2	100.0
condition			n/a
subroutine	6	6	100.0
pod	2	2	100.0
total	25	25	100.0

use strict;
use warnings;
package Querylet::Output 0.402;
# ABSTRACT: generic output handler for Querlet::Query

use Carp;

#pod =head1 SYNOPSIS
#pod
#pod This is an abstract base class, meant for subclassing.
#pod
#pod  package Querylet::Output::Tabbed;
#pod  use base qw(Querylet::Output);
#pod
#pod  sub default_type { 'tabbed' }
#pod  sub handler      { \&as_tabbed }
#pod
#pod  sub as_tabbed {
#pod    my ($query) = @_;
#pod    my @output;
#pod    push @output, join("\t", @{$query->columns});
#pod 	 push @output, join("\t", @{$_{@{$query->colummns}}}) for @{$query->results};
#pod    return join("\n", @output);
#pod  }
#pod
#pod  1;
#pod
#pod Then, in a querylet:
#pod
#pod  use Querylet::Output::Tabbed;
#pod
#pod  output format: tabbed
#pod
#pod Or, to override the registered type:
#pod
#pod  use Querylet::Output::Tabbed 'tsv';
#pod
#pod  output format: tsv
#pod
#pod =head1 DESCRIPTION
#pod
#pod This class provides a simple way to write output handlers for Querylet, mostly
#pod by providing an import routine that will register the handler with the
#pod type-name requested by the using script.
#pod
#pod The methods C and C must exist, as described below.
#pod
#pod =head1 IMPORT
#pod
#pod Querylet::Output provides an C method that will register the handler
#pod when the module is imported.  If an argument is given, it will be used as the
#pod type name to register.  Otherwise, the result of C is used.
#pod
#pod =cut

sub import {
	my ($class, $type) = @_;
	$type = $class->default_type unless $type;

	my $handler = $class->handler;

	Querylet::Query->register_output_handler($type => $handler);
}

#pod =head1 METHODS
#pod
#pod =over 4
#pod
#pod =item default_type
#pod
#pod This method returns the name of the type for which the output handler will be
#pod registered if no override is given.
#pod
#pod =cut

sub default_type { croak "default_type method unimplemented" }

#pod =item handler
#pod
#pod This method returns a reference to the handler, which will be used to register
#pod the handler.
#pod
#pod =cut

sub handler { croak "handler method unimplemented" }

#pod =back
#pod
#pod =cut

"I do endeavor to give satisfaction, sir.";

__END__