Bumping version to 1.61
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / XML.pm
index 2315b20..02f6413 100644 (file)
 package SQL::Translator::Producer::XML;
 
-# -------------------------------------------------------------------
-# $Id: XML.pm,v 1.11 2003-07-31 20:48:23 dlc Exp $
-# -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-#                    darren chamberlain <darren@cpan.org>,
-#                    Chris Mungall <cjm@fruitfly.org>
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307  USA
-# -------------------------------------------------------------------
+=pod
 
-use strict;
-use vars qw[ $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.11 $ =~ /(\d+)\.(\d+)/;
-
-use IO::Scalar;
-use SQL::Translator::Utils qw(header_comment);
-use XML::Writer;
-
-my $namespace = 'http://sqlfairy.sourceforge.net/sqlfairy.xml';
-my $name = 'sqlt';
-
-# -------------------------------------------------------------------
-sub produce {
-    my $translator = shift;
-    my $schema     = $translator->schema;
-    my $args       = $translator->producer_args;
-
-    my $io          = IO::Scalar->new;
-    my $xml         = XML::Writer->new(
-        OUTPUT      => $io,
-        NAMESPACES  => 1,
-        PREFIX_MAP  => { $namespace => $name },
-        DATA_MODE   => 1,
-        DATA_INDENT => 2,
-    );
-
-    $xml->xmlDecl('UTF-8');
-    $xml->comment(header_comment('', ''));
-    $xml->startTag([ $namespace => 'schema' ]);
-
-    for my $table ( $schema->get_tables ) {
-        my $table_name = $table->name or next;
-        $xml->startTag   ( [ $namespace => 'table' ] );
-        $xml->dataElement( [ $namespace => 'name'  ], $table_name );
-        $xml->dataElement( [ $namespace => 'order' ], $table->order );
-
-        #
-        # Fields
-        #
-        $xml->startTag( [ $namespace => 'fields' ] );
-        for my $field ( $table->get_fields ) {
-            $xml->startTag( [ $namespace => 'field' ] );
-
-            for my $method ( 
-                qw[ 
-                    name data_type default_value is_auto_increment 
-                    is_primary_key is_nullable is_foreign_key order size
-                ]
-            ) {
-                my $val = $field->$method || '';
-                $xml->dataElement( [ $namespace => $method ], $val )
-                    if ( defined $val || 
-                        ( !defined $val && $args->{'emit_empty_tags'} ) );
-            }
+=head1 NAME
 
-            $xml->endTag( [ $namespace => 'field' ] );
-        }
+SQL::Translator::Producer::XML - Alias to XML::SQLFairy producer
 
-        $xml->endTag( [ $namespace => 'fields' ] );
+=head1 DESCRIPTION
 
-        #
-        # Indices
-        #
-        $xml->startTag( [ $namespace => 'indices' ] );
-        for my $index ( $table->get_indices ) {
-            $xml->startTag( [ $namespace => 'index' ] );
+Previous versions of SQL::Translator included an XML producer, but the
+namespace has since been further subdivided.  Therefore, this module is
+now just an alias to the XML::SQLFairy producer.
 
-            for my $method ( qw[ fields name options type ] ) {
-                my $val = $index->$method || '';
-                   $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
-                $xml->dataElement( [ $namespace => $method ], $val )
-                    if ( defined $val || 
-                        ( !defined $val && $args->{'emit_empty_tags'} ) );
-            }
+=head1 SEE ALSO
 
-            $xml->endTag( [ $namespace => 'index' ] );
-        }
-        $xml->endTag( [ $namespace => 'indices' ] );
+SQL::Translator::Producer::XML::SQLFairy.
 
-        #
-        # Constraints
-        #
-        $xml->startTag( [ $namespace => 'constraints' ] );
-        for my $index ( $table->get_constraints ) {
-            $xml->startTag( [ $namespace => 'constraint' ] );
+=head1 AUTHOR
 
-            for my $method ( 
-                qw[ 
-                    deferrable expression fields match_type name 
-                    options on_delete on_update reference_fields
-                    reference_table type 
-                ] 
-            ) {
-                my $val = $index->$method || '';
-                   $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
-                $xml->dataElement( [ $namespace => $method ], $val )
-                    if ( defined $val || 
-                        ( !defined $val && $args->{'emit_empty_tags'} ) );
-            }
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
-            $xml->endTag( [ $namespace => 'constraint' ] );
-        }
-        $xml->endTag( [ $namespace => 'constraints' ] );
+=cut
 
-        $xml->endTag( [ $namespace => 'table' ] );
-    }
+use strict;
+use warnings;
+our $DEBUG;
+our $VERSION = '1.61';
+$DEBUG = 1 unless defined $DEBUG;
 
-    $xml->endTag([ $namespace => 'schema' ]);
-    $xml->end;
+use SQL::Translator::Producer::XML::SQLFairy;
 
-    return $io;
-}
+*produce = \&SQL::Translator::Producer::XML::SQLFairy::produce;
 
 1;
-
-# -------------------------------------------------------------------
-# The eyes of fire, the nostrils of air,
-# The mouth of water, the beard of earth.
-# William Blake
-# -------------------------------------------------------------------
-
-=head1 NAME
-
-SQL::Translator::Producer::XML - XML output
-
-=head1 SYNOPSIS
-
-  use SQL::Translator::Producer::XML;
-
-=head1 DESCRIPTION
-
-Creates XML output of a schema.
-
-=head1 AUTHOR
-
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>, darren chamberlain E<lt>darren@cpan.orgE<gt>
-
-=head1 SEE ALSO
-
-L<XML::Writer>