Initial checkin.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer.pm
1 package SQL::Translator::Producer;
2
3 #-----------------------------------------------------
4 # $Id: Producer.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
5 #
6 # File       : SQL/Translator/Producer.pm
7 # Programmer : Ken Y. Clark, kclark@logsoft.com
8 # Created    : 2002/02/27
9 # Purpose    : base object for Producers
10 #-----------------------------------------------------
11
12 use strict;
13 use vars qw( $VERSION );
14 $VERSION = (qw$Revision: 1.1.1.1 $)[-1];
15
16 use SQL::Translator;
17 use base qw[ SQL::Translator ];
18
19 sub from { return shift()->{'from'} }
20
21 sub header {
22     my $self = shift;
23     my $from = $self->from || '';
24     my $to   = $self->to   || '';
25     return <<"HEADER";
26 #
27 # $from-to-$to translator
28 # Version: $SQL::Translator::VERSION
29 #
30
31 HEADER
32 }
33
34 1;
35
36 #-----------------------------------------------------
37 # A burnt child loves the fire.
38 # Oscar Wilde
39 #-----------------------------------------------------
40
41 =head1 NAME
42
43 SQL::Translator::Producer - base object for Producers
44
45 =head1 SYNOPSIS
46
47   package SQL::Translator::Producer::Foo;
48   use SQL::Translator::Producer;
49   use base( 'SQL::Translator::Producer' );
50   1;
51
52 =head1 DESCRIPTION
53
54 Intended to serve as a base class for all SQL Translator producers.
55
56 =head1 AUTHOR
57
58 Ken Y. Clark, kclark@logsoft.com
59
60 =head1 SEE ALSO
61
62 perl(1).
63
64 =cut