.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Autodia::Handler::Torque 3pm"
.TH Autodia::Handler::Torque 3pm "2022-11-02" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Autodia::Handler::Torque.pm \- AutoDia handler for Torque xml database schema
.SH "INTRODUCTION"
.IX Header "INTRODUCTION"
This provides Autodia with the ability to read Torque Database Schema files, allowing you to convert them via the Diagram Export methods to images (using GraphViz and \s-1VCG\s0) or html/xml using custom templates or to Dia.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use Autodia::Handler::Torque;
.PP
my \f(CW$handler\fR = Autodia::Handler::dia\->New(\e%Config);
.PP
\&\f(CW$handler\fR\->Parse(filename); # where filename includes full or relative path.
.SH "Description"
.IX Header "Description"
The Torque handler will parse the xml file using XML::Simple and populating the diagram object with class, superclass, and relationships representing tables and relationships.
.PP
The Torque handler is registered in the Autodia.pm module, which contains a hash of language names and the name of their respective language.
.PP
An example Torque database schema is shown here \- its actually a rather nice format apart from the Java studlyCaps..
.PP
<?xml version=\*(L"1.0\*(R" encoding=\*(L"\s-1ISO\-8859\-1\*(R"\s0 standalone=\*(L"no\*(R" ?>
.PP
<!DOCTYPE database \s-1SYSTEM\s0 \*(L"http://db.apache.org/torque/dtd/database_3_0_1.dtd\*(R">
.PP
<database name=\*(L"\s-1INTERPLANETARY\*(R"\s0>
.PP
.Vb 4
\&  <table name="CIVILIZATION">
\&    <column name="CIV_ID" required="true" autoIncrement="true" primaryKey="true" type="INTEGER"/>
\&    <column name="NAME" required="true" type="LONGVARCHAR"/>
\&  </table>
\&
\&  <table name="CIV_PEOPLE">
\&    <column name="CIV_ID" required="true" primaryKey="true" type="INTEGER"/>
\&    <column name="PEOPLE_ID" required="true" primaryKey="true" type="INTEGER"/>
\&
\&    <foreign\-key foreignTable="CIVILIZATION">
\&        <reference local="CIV_ID" foreign="CIV_ID"/>
\&    </foreign\-key>
\&    <foreign\-key foreignTable="PEOPLE">
\&        <reference local="PEOPLE_ID" foreign="PEOPLE_ID"/>
\&    </foreign\-key>
\&  </table>
\&
\&  <table name="PEOPLE">
\&    <column name="PEOPLE_ID" required="true" autoIncrement="true" primaryKey="true" type="INTEGER"/>
\&    <column name="NAME" required="true" size="255" type="VARCHAR"/>
\&    <column name="SPECIES" type="INTEGER" default="\-2"/>
\&    <column name="PLANET" type="INTEGER" default="\-1"/>
\&  </table>
\&</database>
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1CONSTRUCTION METHOD\s0"
.IX Subsection "CONSTRUCTION METHOD"
use Autodia::Handler::Torque;
.PP
my \f(CW$handler\fR = Autodia::Handler::Torque\->New(\e%Config);
This creates a new handler using the Configuration hash to provide rules selected at the command line.
.SS "\s-1ACCESS METHODS\s0"
.IX Subsection "ACCESS METHODS"
\&\f(CW$handler\fR\->Parse(filename); # where filename includes full or relative path.
.PP
This parses the named file and returns 1 if successful or 0 if the file could not be opened.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Autodia
.PP
Torque
.PP
Autodia::Handler