1 package SQL::Translator::XMI::Parser;
3 # -------------------------------------------------------------------
4 # $Id: Parser.pm,v 1.5 2003-09-29 12:02:35 grommit Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Mark Addison <mark.addison@itn.co.uk>,
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
27 SQL::Translator::XMI::Parser - XMI Parser class for use in SQL Fairy's XMI
34 use vars qw/$VERSION/;
35 $VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
39 use XML::XPath::XMLParser;
40 use Storable qw/dclone/;
44 # See SQL::Translator::XMI::Parser::V12 and SQL::Translator::XMI::Parser:V10
47 # Hash ref used to describe the 2 xmi formats 1.2 and 1.0. Neither is complete!
49 # NB The names of the data keys MUST be the same for both specs so the
50 # data structures returned are the same.
54 # * There is currently no way to set the data key name for attrib_data, it just
55 # uses the attribute name from the XMI. This isn't a problem at the moment as
56 # xmi1.0 names all these things with tags so we don't need the attrib data!
57 # Also use of names seems to be consistant between the versions.
62 # Call as class method to set up the parser from a spec (see above). This
63 # generates the get_ methods for the version of XMI the spec is for. Called by
64 # the sub-classes (e.g. V12 and V10) to create parsers for each version.
72 # Build lookups etc. Its important that each spec item becomes self contained
73 # so we can build good closures, therefore we do all the lookups 1st.
77 foreach my $spec ( values %$specs ) {
78 # Look up for kids get method
79 foreach ( @{$spec->{kids}} ) {
80 $_->{get_method} = "get_".$specs->{$_->{class}}{plural};
83 # Add xmi.id ti all specs. Everything we want at the moment (in both
84 # versions) has an id. The tags that don't seem to be used for
86 my $attrib_data = $spec->{attrib_data} ||= [];
87 push @$attrib_data, "xmi.id";
92 # Create get methods from spec
95 my ($proto,$specs) = @_;
96 my $class = ref($proto) || $proto;
97 foreach ( values %$specs ) {
98 # Clone from specs and sort out the lookups into it so we get a
99 # self contained spec to use as a proper closure.
100 my $spec = dclone($_);
102 # Create _get_* method with get_* as an alias unless the user has
103 # defined it. Allows for override. Note the alias is in this package
104 # so we can add overrides to both specs.
106 my $meth = "_get_$spec->{plural}";
107 *{$meth} = mk_get($spec);
108 *{__PACKAGE__."::get_$spec->{plural}"} = sub {shift->$meth(@_);}
109 unless $class->can("get_$spec->{plural}");
113 # e.g. of overriding both versions.
115 # print "HELLO Both\n";
116 # return shift->_get_classes(@_);
120 # Sets up the XML::XPath object and then checks the version of the XMI file and
121 # blesses its self into either the V10 or V12 class.
125 my $class = ref($proto) || $proto;
129 # Create the XML::XPath object
130 # TODO Docs recommend we only use 1 XPath object per application
132 foreach (qw/filename xml ioref/) {
134 $xp = XML::XPath->new( $_ => $args{$_});
135 $xp->set_namespace("UML", "org.omg.xmi.namespace.UML");
139 $me = { xml_xpath => $xp };
141 # Work out the version of XMI we have and return as that sub class
142 my $xmiv = $args{xmi_version}
143 || "".$xp->findvalue('/XMI/@xmi.version')
144 || die "Can't find XMI version";
146 $class = __PACKAGE__."::V$xmiv";
148 die "Failed to load version sub class $class : $@" if $@;
150 return bless $me, $class;
156 # Generates and returns a get_ sub for the spec given.
157 # So, if you want to change how the get methods (e.g. get_classes) work do it
160 # The get methods made have the args described in the docs and 2 private args
161 # used internally, to call other get methods from paths in the spec.
162 # NB: DO NOT use publicly as you will break the version independance. e.g. When
163 # using _xpath you need to know which version of XMI to use. This is handled by
164 # the use of different paths in the specs.
166 # _context => The context node to use, if not given starts from root.
168 # _xpath => The xpath to use for finding stuff.
173 # get_* closure using $spec
175 my ($me, %args) = @_;
176 my $xp = delete $args{_context} || $me->{xml_xpath};
179 my $xpath = $args{_xpath} ||= $spec->{default_path};
180 #warn "Searching for $spec->{plural} using:$xpath\n";
182 my @nodes = $xp->findnodes($xpath);
183 #warn "None.\n" unless @nodes;
184 return unless @nodes;
186 for my $node (@nodes) {
187 #warn " Found $spec->{name} xmi.id=".$node->getAttribute("xmi.id")." name=".$node->getAttribute("name")."\n";
189 # my $thing = { xpNode => $node };
191 # Have we seen this before? If so just use the ref we have.
192 if ( my $id = $node->getAttribute("xmi.id") ) {
193 if ( my $foo = $me->{model}{things}{$id} ) {
194 #warn " Reffing from model **********************\n";
200 # Get the Tag attributes
201 foreach ( @{$spec->{attrib_data}} ) {
202 $thing->{$_} = $node->getAttribute($_);
206 foreach ( @{$spec->{path_data}} ) {
207 #warn " $spec->{name} - $_->{name} using:$_->{path}\n";
208 my @nodes = $node->findnodes($_->{path});
209 $thing->{$_->{name}} = @nodes ? $nodes[0]->getData
210 : (exists $_->{default} ? $_->{default} : undef);
213 # Run any filters set
215 # Should we do this after the kids as we may want to test them?
216 # e.g. test for number of attribs
217 if ( my $filter = $args{filter} ) {
219 next unless $filter->($thing);
222 # Add anything with an id to the things lookup
223 push @$things, $thing;
224 if ( exists $thing->{"xmi.id"} and defined $thing->{"xmi.id"}
225 and my $id = $thing->{"xmi.id"}
227 $me->{model}{things}{$id} = $thing; }
231 foreach ( @{$spec->{kids}} ) {
233 my $meth = $_->{get_method};
234 my $path = $_->{path};
236 # Variable subs on the path from thing
237 $path =~ s/\$\{(.*?)\}/$thing->{$1}/g;
238 $data = $me->$meth( _context => $node, _xpath => $path,
239 filter => $args{"filter_$_->{name}"} );
241 if ( $_->{multiplicity} eq "1" ) {
242 $thing->{$_->{name}} = shift @$data;
245 my $kids = $thing->{$_->{name}} = $data || [];
246 if ( my $key = $_->{"map"} ) {
247 $thing->{"_map_$_->{name}"} = _mk_map($kids,$key);
253 if ( $spec->{isRoot} ) {
254 push(@{$me->{model}{$spec->{plural}}}, $_) foreach @$things;
262 my ($kids,$key) = @_;
265 $map->{$_->{$key}} = $_ if exists $_->{$key};
270 1; #===========================================================================
273 package XML::XPath::Function;
276 # May need to look at doing deref on all paths just to be on the safe side!
278 # Will also want some caching as these calls are expensive as the whole doc
279 # is used but the same ref will likley be requested lots of times.
283 my ($node, @params) = @_;
285 die "xmiDeref() function takes one or no parameters\n";
288 my $nodeset = shift(@params);
289 return $nodeset unless $nodeset->size;
290 $node = $nodeset->get_node(1);
292 die "xmiDeref() needs an Element node."
293 unless $node->isa("XML::XPath::Node::Element");
295 my $id = $node->getAttribute("xmi.idref") or return $node;
296 return $node->getRootNode->find('//*[@xmi.id="'.$id.'"]');
307 use SQL::Translator::XMI::Parser;
308 my $xmip = SQL::Translator::XMI::Parser->new( xml => $xml );
309 my $classes = $xmip->get_classes();
313 Parses XMI files (XML version of UML diagrams) to perl data structures and
314 provides hooks to filter the data down to what you want.
318 Pass in name/value arg of either C<filename>, C<xml> or C<ioref> for the XMI
319 data you want to parse.
321 The version of XMI to use either 1.0 or 1.2 is worked out from the file. You
322 can also use a C<xmi_version> arg to set it explicitley.
326 Doc below is for classes method, all the other calls follow this form.
328 =head2 get_classes( ARGS )
330 ARGS - Name/Value list of args.
332 filter => A sub to filter the node to see if we want it. Has the nodes data,
333 before kids are added, referenced to $_. Should return true if you
334 want it, false otherwise.
336 e.g. To find only classes with a "Foo" stereotype.
338 filter => sub { return $_->{stereotype} eq "Foo"; }
340 filter_attributes => A filter sub to pass onto get_attributes.
342 filter_operations => A filter sub to pass onto get_operations.
344 Returns a perl data structure including all the kids. e.g.
348 'visibility' => 'public',
349 'isActive' => 'false',
350 'isAbstract' => 'false',
351 'isSpecification' => 'false',
352 'stereotype' => 'Table',
358 'stereotype' => 'PK',
360 'ownerScope' => 'instance',
361 'visibility' => 'public',
362 'initialValue' => undef,
363 'isSpecification' => 'false',
368 'datatype' => 'varchar'
369 'ownerScope' => 'instance',
370 'visibility' => 'public',
371 'initialValue' => '',
372 'isSpecification' => 'false',
378 'isQuery' => 'false',
379 'ownerScope' => 'instance',
380 'visibility' => 'public',
381 'isSpecification' => 'false',
383 'isAbstract' => 'false',
386 'concurrency' => 'sequential'
390 'isSpecification' => 'false',
397 'isSpecification' => 'false',
404 'isSpecification' => 'false',
414 =head1 XMI XPath Functions
416 The Parser adds the following extra XPath functions for use in the Specs.
420 Deals with xmi.id/xmi.idref pairs of attributes. You give it an
421 xPath e.g 'UML:ModelElement.stereotype/UML:stereotype' if the the
422 tag it points at has an xmi.idref it looks up the tag with that
423 xmi.id and returns it.
425 If it doesn't have an xmi.id, the path is returned as normal.
429 <UML:ModelElement.stereotype>
430 <UML:Stereotype xmi.idref = 'stTable'/>
431 </UML:ModelElement.stereotype>
433 <UML:Stereotype xmi.id='stTable' name='Table' visibility='public'
434 isAbstract='false' isSpecification='false' isRoot='false' isLeaf='false'>
435 <UML:Stereotype.baseClass>Class</UML:Stereotype.baseClass>
438 Using xmideref(//UML:ModelElement.stereotype/UML:stereotype) would return the
439 <UML:Stereotype xmi.id = '3b4b1e:f762a35f6b:-7fb6' ...> tag.
441 Using xmideref(//UML:ModelElement.stereotype/UML:stereotype)/@name would give
452 =head1 VERSION HISTORY
456 grommit <mark.addison@itn.co.uk>