File Coverage

blib/lib/XML/Idiom.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

# XML::Idiom.pm
#
# Copyright (c) 2004 Joe Minieri  and OpenService (www.open.com).
# All rights reserved.
# This program is free software; you can redistribute it and/or modify it under the same
# terms as Perl itself.
#

package XML::Idiom;

use 5.006001;
use strict;
use warnings;

use XML::Simple;

our $VERSION = '0.02';

##########################################################################################
#
# Methods to manage the errors
#
##########################################################################################
sub isError { my $self = shift; return $self->{ _isError }; }
sub errorType { my $self = shift; return $self->{ _errorType }; }
sub errorContent { my $self = shift; return $self->{ _errorContent }; }
sub getError { my $self = shift; return $self->{ _errorHash }; }

##########################################################################################
#
# Methods to manage the events and event list
#
##########################################################################################
sub getNextEvent { my $self = shift; return pop @{ $self->{ _eventList }}; }
sub getNumberOfEvents { my $self = shift; return (scalar @{ $self->{ _eventList }});  }
sub getEvents { my $self = shift; return @{ $self->{ _eventList }}; }

##########################################################################################
#
# Methods to manage the raw and unparsed data
#
##########################################################################################
my $_IDIOM_document;
my $_IDIOM_xml;
sub Idiom {
	my ($self, $doc) = @_;
	if(defined($doc)) {
		return $self->{ _IDIOM_document } = $doc;
	} else {
		return $self->{ _IDIOM_document }
	}
}

sub XML {
	my ($self, $doc) = @_;
	if(defined($doc)) {
		if(defined($self->{ _IDIOM_document } = $doc)) {
			return $self->{ _IDIOM_xml } = XMLin($self->{ _IDIOM_document });
		} else {
			return undef;
		}
	} else {
		return $self->{ _IDIOM_xml };
	}
}

sub consume {
	my ($self, $idiom_doc) = @_;

	$self->{ _isError} = undef;
	$self->{ _errorType} = undef;
	$self->{ _errorContent} = undef;
	@{ $self->{ _eventList }} = ();
	$self->{ _IDIOM_document} = undef;
	$self->{ _IDIOM_xml} = undef;

	unless(defined($idiom_doc) and $idiom_doc ne '') { return undef }

	my $idiom_ref = $self->XML($idiom_doc);

	if(my $alerts_ref = $idiom_ref->{ 'evAlert' }) {
		if(ref $alerts_ref eq 'ARRAY') {
			# mutliple alerts
			foreach my $alert_hash_ref ( @$alerts_ref ) {
				push(@{ $self->{ _eventList }}, $alert_hash_ref);
			}
		} elsif( ref $alerts_ref eq 'HASH' ) {
			# one alert
			push(@{ $self->{ _eventList }}, $alerts_ref);
		} # else no alerts!
		return (scalar @{ $self->{ _eventList }});
	} elsif(my $error_ref = $idiom_ref->{ 'errorMessage' }) {
		$self->{ _isError } = 1;
		$self->{ _errorType } = $error_ref->{ 'name' };
		$self->{ _errorContent } = $error_ref->{ 'content' };
		$self->{ _errorHash } = $error_ref;
		return undef;
	}
}

sub new {
        my ($class, $document) = @_;

        my $self = {};

        bless( $self, $class );
	if(defined($document)) { $self->consume($document) }

        $XML::Simple::PREFERRED_PARSER='XML::Parser';

        return $self;
}

1;
__END__