File Coverage

blib/lib/Workflow/XPDL.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

package Workflow::XPDL;

use 5.008008;
use strict;
use warnings;
use XML::XPath;
use Data::Dumper;
use Carp;

require Exporter;
use AutoLoader qw(AUTOLOAD);
our $debug = 0;

our @ISA = qw(Exporter);

# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.

# This allows declaration	use Workflow::XPDL ':all';
# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
# will save memory.
our %EXPORT_TAGS = ( 'all' => [ qw(
	header_info
	is_valid_workflow
	get_transition_ids
	get_imp_details
	get_app_datatypes
	new
	xml_file
	workflow_id
	activity_id
	application_id

) ] );

our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );

our @EXPORT = qw(

);

our $VERSION = '0.40';


# Preloaded methods go here.

sub header_info {
  my $self = shift;
  my $xml_file = $self->{XML_FILE};
  my $headerval;
  my $headertext;
  my %headerhash;
  my $sub_name = "header_info";
  my $dump;
  chomp $xml_file;
  _debug ("$sub_name: Got $xml_file\n");

   my $xp = XML::XPath->new(filename => $xml_file);
   my $nodeset = $xp->find("//*[ancestor::PackageHeader]");

    foreach my $node ($nodeset->get_nodelist) {
            my $headerval = $node->getLocalName();
            my $headertext = $node->string_value();
            $headerhash{$headerval} = "$headertext";

    }

  $dump = Dumper(%headerhash);
  _debug ("$dump");
  return (%headerhash);
}

sub is_valid_workflow {
  my $self = shift;
   if ($_[0]) {
    $self->{WORKFLOW_ID} = $_[0];
   }
  my $sub_name = "is_valid_workflow";
  my $xml_file = $self->{XML_FILE};
  my $workflow_id = $self->{WORKFLOW_ID};
  my $found_id = 1;
  chomp $xml_file;
  _debug ("$sub_name: Got $xml_file\n");
  _debug ("$sub_name: Got $workflow_id\n");

   my $xp = XML::XPath->new(filename => $xml_file);
   my $nodeset = $xp->exists("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]"); # find all paragraphs
   if ($nodeset) {
     $found_id = 0;
   }
  return $found_id;
}

sub _debug {
  my $output = $_[0];
  if ($debug) {
    print STDERR "$output";
  }
}

sub get_transition_ids {
   my $self = shift;
   if ($_[0]) {
    $self->{ACTIVITY_ID} = $_[0];
   }
  my $xml_file = $self->{XML_FILE};
  my $workflow_id = $self->{WORKFLOW_ID};
  my $activity_id = $self->{ACTIVITY_ID};
  my $trans_id;
  my %transition_hash;
  my $split_type;
  my $restrictions_exist = 0;
  my $restriction_type;
  my $transitions_exist = 0;
  my $conditions_exist = 0;
  my $dump;


  chomp $xml_file;
  my $xp = XML::XPath->new(filename => $xml_file);
  $transitions_exist = $xp->exists("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Transitions/Transition[\@From=$activity_id]");
  if ($transitions_exist) {
    $transition_hash{'trans_exist'} = 'TRUE';
    my $nodeset = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Transitions/Transition[\@From=$activity_id]");
    foreach my $node ($nodeset->get_nodelist) {
      my $condition;
      my $trans_to_id = $node->findvalue('@To');
      _debug("Trans to id is $trans_to_id\n");
      my $trans_id = $node->findvalue('@Id');
      _debug("Trans id is $trans_id\n");
      my $conditions_exist = $xp->exists ("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Transitions/Transition[\@Id=$trans_id]/Condition");
      if ($conditions_exist) {
        my $conditionset = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Transitions/Transition[\@Id=$trans_id]/Condition");
        foreach my $conditions ($conditionset->get_nodelist) {
          $condition = $conditions->string_value();
          my %temp_hash = ( 'transition_to_id' => $trans_to_id, 'transition_condition' => $condition );
          $transition_hash{$trans_id} = \%temp_hash;
        }
      }
      else {
        my %temp_hash = ( 'transition_to_id' => $trans_to_id, 'transition_condition' => 'NULL' );
        $transition_hash{$trans_id} = \%temp_hash;
      }
    }
    $restrictions_exist = $xp->exists("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Activities/Activity[\@Id=$activity_id]/TransitionRestrictions/TransitionRestriction/Split/TransitionRefs/TransitionRef");
    if ($restrictions_exist) {
      my $nodeset = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Activities/Activity[\@Id=$activity_id]/TransitionRestrictions/TransitionRestriction/Split");
      foreach my $node ($nodeset->get_nodelist) {
      $restriction_type = $node->findvalue('@Type');
      $transition_hash{'restriction_type'} = $restriction_type;
      }
    }
    else {
      $transition_hash{'restriction_type'} = 'NULL';
    }
  }
  else {
   $transition_hash{'trans_exist'} = 'FALSE';
  }
  $dump = Dumper(%transition_hash);
  _debug("$dump");
  return %transition_hash;
}

sub get_imp_details {
   my $self = shift;
   if ($_[0]) {
    $self->{ACTIVITY_ID} = $_[0];
   }
  my $xml_file = $self->{XML_FILE};
  my $workflow_id = $self->{WORKFLOW_ID};
  my $activity_id = $self->{ACTIVITY_ID};
  my $impl_name;
  my $exists = 0;
  my @imp_array = "";
  my $appl_id;
  my $appl_type;
  my $dump;

  my $xp = XML::XPath->new(filename => $xml_file);
  $exists = $xp->exists("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Activities/Activity[\@Id=$activity_id]/Implementation");

  if ($exists) {
   my $nodeset = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Activities/Activity[\@Id=$activity_id]/Implementation/*");
    foreach my $node ($nodeset->get_nodelist) {
       $impl_name = $node->getLocalName();
       if ( $impl_name  eq "Tool") {
         $appl_id = $node->findvalue('@Id');
         $appl_type = $node->findvalue('@Type');
       }
       elsif ( $impl_name eq "No") {
         $appl_id = "";
         $appl_type = "";
       }
       elsif ( $impl_name eq "SubFlow") {
         $appl_id = $node->findvalue('@Id');
         $appl_type = $node->findvalue('@Execution');
       }
       else {
         $impl_name = "NULL";
         $appl_id = "";
         $appl_type = "";
       }
     }
   }
   else {
     $impl_name = "NULL";
     $appl_id = "";
     $appl_type = "";
   }
   @imp_array = [$impl_name,  $appl_id, $appl_type];
   $dump = Dumper(@imp_array);
   _debug("$dump");
   return (@imp_array);
}

sub get_app_datatypes {
   my $self = shift;
   if ($_[0]) {
    $self->{APPLICATION_ID} = $_[0];
   }
  my $xml_file = $self->{XML_FILE};
  my $workflow_id = $self->{WORKFLOW_ID};
  my $application_id = $self->{APPLICATION_ID};
  my $impl_name;
  my $exists = 0;
  my @imp_array = "";
  my $appl_id;
  my $appl_type;
  my $dump;
  my %param_hash;


  my $xp = XML::XPath->new(filename => $xml_file);
  $exists = $xp->exists("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Applications/Application[\@Id=\'$application_id\']/FormalParameters");

  if ($exists) {
    my $nodeset = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Applications/Application[\@Id=\'$application_id\']/FormalParameters/FormalParameter");
    foreach my $node ($nodeset->get_nodelist) {
      my $param_id = $node->findvalue('@Id');
      my $param_index = $node->findvalue('@Index');
      my $param_mode = $node->findvalue('@Mode');
      my $param_type = "";
      my $param_type_val = "";
      my $nodeset2 = $xp->find("/Package/WorkflowProcesses/WorkflowProcess[\@Id=$workflow_id]/Applications/Application[\@Id=\'$application_id\']/FormalParameters/FormalParameter[\@Id=\'$param_id\']/DataType/*");
      foreach my $node2 ($nodeset2->get_nodelist) {
        $param_type = $node2->getLocalName();
        if ($param_type eq "BasicType") {
          $param_type_val = $node2->findvalue('@Type');
        }
        else {
          $param_type_val = $node2->findvalue('@Id');
        }
      }
      $param_hash{$param_id} = [ $param_index, $param_mode, $param_type, $param_type_val];

    }
  }
  else {
    _debug("Not found.");
  }
  $dump = Dumper(%param_hash);
   _debug("$dump");
  return %param_hash;
}

sub get_formal_parameters {
  return "Not yet implemented\n";
}

sub new {
  my $classed = 1;
  my $self  = {};
  my $class;
  my @args;
  ($class, @args) = @_;
  my $count = 2;
  foreach my $params (@args) {
    if ($params eq "xml_file") {
      $self->{XML_FILE} = $_[$count];
    }
    if ($params eq "workflow_id") {
      $self->{WORKFLOW_ID} = $_[$count];
    }
    if ($params eq "activity_id") {
      $self->{ACTIVITY_ID} = $_[$count];
    }
    if ($params eq "application_id") {
      $self->{APPLICATION_ID} = $_[$count];
    }
    $count++;
  }
  unless ($self->{XML_FILE}) {
    $self->{XML_FILE} = undef;
  }
  unless ($self->{WORKFLOW_ID}) {
    $self->{WORKFLOW_ID} = undef;
  }
  unless ($self->{ACTIVITY_ID}) {
    $self->{ACTIVITY_ID} = undef;
  }
  unless ($self->{APPLICATION_ID}) {
    $self->{APPLICATION_ID} = undef;
  }
  bless($self, $class);
  return $self;
}

sub xml_file {
   my $self = shift;
   if ($_[0]) {
    $self->{XML_FILE} = $_[0];
   }
  return $self->{XML_FILE};
}

sub workflow_id {
   my $self = shift;
   if ($_[0]) {
    $self->{WORKFLOW_ID} = $_[0];
   }
  return $self->{WORKFLOW_ID};
}

sub activity_id {
   my $self = {};
   if ($_[0]) {
    $self->{ACTIVITY_ID} = $_[0];
   }
  return $self->{ACTIVITY_ID};
}

sub application_id {
   my $self = {};
   if ($_[0]) {
    $self->{APPLICATION_ID} = $_[0];
   }
  return $self->{APPLICATION_ID};
}

sub DESTROY {
  my $self = shift;
  if ($debug ) {
    carp "Destroying $self\n";
  }
}

# Autoload methods go after =cut, and are processed by the autosplit program.

1;
__END__