lib/NonameTV/Exporter.pm

   1 package NonameTV::Exporter;
   2
   3 use strict;
   4
   5 =head1 NAME
   6
   7 NonameTV::Exporter
   8
   9 =head1 DESCRIPTION
  10
  11 Abstract base-class for the NonameTV::Exporter::* classes.
  12
  13 A package derived from NonameTV::Exporter can be used to export
  14 data from the NonameTV programming database to another format.
  15
  16 NonameTV::Exporter::*-objects are instantiated from the nonametv.conf
  17 configuration file. To instantiate an object, add an entry
  18 in the 'Exporters'-hash. Each entry consists of a hash with
  19 the package-name of the exporter in the Type-key and any other
  20 parameters to the object in other keys.
  21
  22 =head1 METHODS
  23
  24 =over 4
  25
  26 =cut
  27
  28 =item new
  29
  30 The constructor for the object. Called with a hashref as the first parameter.
  31 This is a ref to the configuration for the object from the nonametv.conf-
  32 file. The second parameter is a NonameTV::DataStore object.
  33
  34 =cut
  35
  36 sub new
  37 {
  38   my $class = ref( $_[0] ) || $_[0];
  39
  40   my $self = { };
  41   bless $self, $class;
  42
  43   # Copy the parameters supplied in the constructor.
  44   foreach my $key (keys(%{$_[1]}))
  45   {
  46       $self->{$key} = ($_[1])->{$key};
  47   }
  48
  49   $self->{datastore} = $_[2];
  50
  51   return $self;
  52 }
  53
  54 =item Export
  55
  56 Export is called from the nonametv-export executable. It takes a hashref
  57 as a parameter. The hashref points to a hash with the command-line
  58 parameters decoded by Getopt::Long  using the $NonameTV::Exporter::*::Options
  59 arrayref as format specification.
  60
  61 =cut
  62
  63 sub Export
  64 {
  65   my( $self, $param ) = @_;
  66
  67   die "You must override Export in your own class"
  68 }
  69
  70 =head1 CLASS VARIABLES
  71
  72 =item $Options
  73
  74 Arrayref containing format specifications for Getopt::Long.
  75
  76 Example: $Options = [ qw/offset=i days=i/ ]
  77
  78 =head1 COPYRIGHT
  79
  80 Copyright (C) 2004 Mattias Holmlund.
  81
  82 =cut
  83
  84 1;