lib/SQL/Translator/Producer.pm

   1 package SQL::Translator::Producer;
   2
   3 #-----------------------------------------------------
   4 # $Id: Producer.pm,v 1.2 2002-03-21 18:50:53 dlc Exp $
   5 #-----------------------------------------------------
   6 # Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
   7 #                    darren chamberlain <darren@cpan.org>
   8 #
   9 # This program is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License as
  11 # published by the Free Software Foundation; version 2.
  12 #
  13 # This program is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  21 # 02111-1307  USA
  22 # -------------------------------------------------------------------
  23
  24 use strict;
  25 use vars qw($VERSION);
  26 $VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/;
  27
  28 sub produce { "" }
  29
  30 1;
  31
  32 #-----------------------------------------------------
  33 # A burnt child loves the fire.
  34 # Oscar Wilde
  35 #-----------------------------------------------------
  36
  37 =head1 NAME
  38
  39 SQL::Translator::Producer - base object for Producers
  40
  41 =head1 SYNOPSIS
  42
  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 a data structure created by a SQL::Translator::Parser
  49 subclass.  It is expected to return a string containing a valid SQL
  50 create statement.
  51
  52 =head1 AUTHOR
  53
  54 Ken Y. Clark, kclark@logsoft.com
  55
  56 =head1 SEE ALSO
  57
  58 perl(1).
  59
  60 =cut