GraphViz::XML - Visualise XML as a tree

GraphViz documentation Contained in the GraphViz distribution.

Index

Code Index:

NAME

Top

GraphViz::XML - Visualise XML as a tree

SYNOPSIS

Top

  use GraphViz::XML;

  my $graph = GraphViz::XML->new($xml);
  print $g->as_png;

DESCRIPTION

Top

This module makes it easy to visualise XML as a tree. XML is hard for humans to grasp, especially if the XML is computer-generated. This modules aims to visualise the XML as a graph in order to make the structure of the XML clear and to aid in understanding the XML.

XML elements are represented as diamond nodes, with links to elements within them. Character data is represented in round nodes.

Note that the XML::Twig module should be installed.

METHODS

Top

new

This is the constructor. It takes one mandatory argument, which is the XML to be visualised. A GraphViz object is returned.

  my $graph = GraphViz::XML->new($xml);

as_*

The XML can be visualised in a number of different graphical formats. Methods include as_ps, as_hpgl, as_pcl, as_mif, as_pic, as_gd, as_gd2, as_gif, as_jpeg, as_png, as_wbmp, as_ismap, as_imap, as_vrml, as_vtx, as_mp, as_fig, as_svg. See the GraphViz documentation for more information. The two most common methods are:

  # Print out a PNG-format file
  print $g->as_png;

  # Print out a PostScript-format file
  print $g->as_ps;

BUGS

Top

GraphViz tends to reorder the nodes. I hope to find a work around soon (possibly with ports).

AUTHOR

Top

Leon Brocard <acme@astray.com>

COPYRIGHT

Top

Copyright (C) 2001, Leon Brocard

This module is free software; you can redistribute it or modify it under the same terms as Perl itself.

GraphViz documentation Contained in the GraphViz distribution. 
package GraphViz::XML;

use strict;
use warnings;
use vars qw($VERSION);
use Carp;
use lib '..';
use GraphViz;
use XML::Twig;

# This is incremented every time there is a change to the API
$VERSION = '0.01';


sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $xml   = shift;

    my $t = XML::Twig->new();
    $t->parse($xml);
    my $graph = GraphViz->new();
    _init( $graph, $t->root );

    return $graph;
}


sub _init {
    my ( $g, $root ) = @_;

    #warn "$root $root->gi\n";

    my $label  = $root->gi;
    my $colour = 'blue';
    my $shape  = 'ellipse';

    if ( $root->is_pcdata ) {
        $label = $root->text;
        $label =~ s|^\s+||;
        $label =~ s|\s+$||;
        $colour = 'black';
    } else {
        $shape = "diamond";
    }

    $g->add_node( $root, label => $label, color => $colour, shape => $shape );
    foreach my $child ( $root->children ) {
        $g->add_edge( $root => $child );
        _init( $g, $child );
    }

}


1;