Fixed problem with rendering atoms in Turnkey Producer.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer.pm
1 package SQL::Translator::Producer;
2
3 # -------------------------------------------------------------------
4 # $Id: Producer.pm,v 1.6 2003-08-22 22:51:51 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 #                    darren chamberlain <darren@cpan.org>,
8 #                    Chris Mungall <cjm@fruitfly.org>
9 #
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License as
12 # published by the Free Software Foundation; version 2.
13 #
14 # This program is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program; if not, write to the Free Software
21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22 # 02111-1307  USA
23 # -------------------------------------------------------------------
24
25 use strict;
26 use vars qw($VERSION);
27 $VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
28
29 sub produce { "" }
30
31 1;
32
33 # -------------------------------------------------------------------
34 # A burnt child loves the fire.
35 # Oscar Wilde
36 # -------------------------------------------------------------------
37
38 =pod
39
40 =head1 NAME
41
42 SQL::Translator::Producer - describes how to write a producer
43
44 =head1 DESCRIPTION
45
46 Producer modules designed to be used with SQL::Translator need to
47 implement a single function, called B<produce>.  B<produce> will be
48 called with the SQL::Translator object from which it is expected to 
49 retrieve the SQL::Translator::Schema object which has been populated 
50 by the parser.  It is expected to return a string.
51
52 =head1 AUTHORS
53
54 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
55 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
56
57 =head1 SEE ALSO
58
59 perl(1), SQL::Translator, SQL::Translator::Schema.
60
61 =cut