File Coverage

blib/lib/DDC/Format.pm

Criterion	Covered	Total	%
statement	9	22	40.9
branch	0	6	0.0
condition	0	3	0.0
subroutine	3	8	37.5
pod	5	5	100.0
total	17	44	38.6

#-*- Mode: CPerl -*-

## File: DDC::Format.pm
## Author: Bryan Jurish
## Description:
##  + DDC Query utilities: output formatting
##======================================================================

package DDC::Format;
use IO::File;
use Carp;
use strict;

##======================================================================
## Globals

##======================================================================
## Constructors, etc.

## $fmt = $CLASS_OR_OBJ->new(%args)
##  + %args:
sub new {
  my $that = shift;
  return bless { @_ }, ref($that)||$that;
}

## $fmt = $fmt->reset()
##  + reset counters, etc.
sub reset { return $_[0]; }

##======================================================================
## API

## $str = $fmt->toString($hitList)
sub toString {
  my ($fmt,$hits) = @_;
  return "$hits";
}

## undef = $fmt->toFile($hitList,$file)
##  + default implementation calls $fmt->toFh()
sub toFile {
  my ($fmt,$hits,$file) = @_;
  my $fh = ref($file) ? $file : IO::File->new(">$file");
  confess(ref($fmt)."::toFile(): open failed for '$file': $!") if (!$fh);
  my $rc = $fmt->toFh($hits,$fh);
  $fh->close() if (!ref($file));
  return $rc;
}

## undef = $fmt->toFh($hitList,$fh)
##  + default implementation calls $fmt->toString()
sub toFh {
  my ($fmt,$hits,$fh) = @_;
  $fh->print($fmt->toString($hits));
}


1; ##-- be happy

__END__