lib/SQL/Translator/Producer/DiaUml.pm

   1 package SQL::Translator::Producer::DiaUml;
   2
   3 # -------------------------------------------------------------------
   4 # Copyright (C) 2002-2009 SQLFairy Authors
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License as
   8 # published by the Free Software Foundation; version 2.
   9 #
  10 # This program is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18 # 02111-1307  USA
  19 # -------------------------------------------------------------------
  20
  21 =pod
  22
  23 =head1 NAME
  24
  25 SQL::Translator::Producer::DiaUml -
  26     Produces dia UML diagrams from schema.
  27
  28 =head1 SYNOPSIS
  29
  30   use SQL::Translator;
  31   my $translator     = SQL::Translator->new(
  32       from           => 'MySQL',
  33       filename       => 'foo_schema.sql',
  34       to             => 'DiaUml',
  35   );
  36   print $translator->translate;
  37
  38 =head1 DESCRIPTION
  39
  40 Currently you will get one class (with the a table
  41 stereotype) generated per table in the schema. The fields are added as
  42 attributes of the classes and their datatypes set. It doesn't currently set any
  43 of the relationships. It doesn't do any layout, all the classses are in one big
  44 stack. However it is still useful as you can use the layout tools in Dia to
  45 automatically arrange them horizontally or vertically.
  46
  47 =head2 Producer Args
  48
  49 =over 4
  50
  51 =back
  52
  53 =cut
  54
  55 # -------------------------------------------------------------------
  56
  57 use strict;
  58
  59 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
  60 $VERSION = '1.60';
  61 $DEBUG   = 0 unless defined $DEBUG;
  62
  63 use File::ShareDir qw/dist_dir/;
  64
  65 use SQL::Translator::Utils 'debug';
  66 use base qw/SQL::Translator::Producer::TT::Base/;
  67 # Convert produce call into a method call on our class
  68 sub produce { return __PACKAGE__->new( translator => shift )->run; };
  69
  70 sub tt_config {
  71     ( INCLUDE_PATH => File::Spec->catdir (dist_dir('SQL-Translator'), 'DiaUml') );
  72 }
  73
  74 sub tt_schema { 'schema.tt2' }
  75
  76 1;
  77
  78 # -------------------------------------------------------------------
  79
  80 =pod
  81
  82 =head1 AUTHOR
  83
  84 Mark Addison E<lt>grommit@users.sourceforge.netE<gt>.
  85
  86 =head1 TODO
  87
  88 * Add the foriegn keys from the schema as UML relations.
  89
  90 * Layout the classes.
  91
  92 =head1 SEE ALSO
  93
  94 SQL::Translator.
  95
  96 =cut