File Coverage

blib/lib/XML/TinyXML/Selector.pm

Criterion	Covered	Total	%
statement	14	18	77.7
branch	2	4	50.0
condition	2	6	33.3
subroutine	3	5	60.0
pod	1	3	33.3
total	22	36	61.1

# -*- tab-width: 4 -*-
# ex: set tabstop=4:

=head1 NAME

XML::TinyXML::Selector - Tinyxml Selector base class

=head1 SYNOPSIS

=over 4

  use XML::TinyXML;
  use XML::TinyXML::Selector;

  # first obtain an xml context:
  $xml = XML::TinyXML->new("rootnode", param => "somevalue", attrs => { attr1 => "v1", attr2 => "v2" });
  $selector = XML::TinyXML::Selector->new($xml, "XPath"); # create an xpath selector;

  my @attributes = $selector->select("attribute::*");
  or
  my $attr2 = $selector->select("attribute::attr2");

  # Check XML::TinyXML::Selector::XPath documentation for more xpath-specific examples

=back

=head1 DESCRIPTION

Selector base class

=head1 INSTANCE VARIABLES

=over 4

=back

=head1 METHODS

=over 4

=cut
package XML::TinyXML::Selector;

use strict;
use warnings;
our $VERSION = '0.34';

=item * new ($xml, $type, %args)

Creates a new XML::TinyXML::Selector::$type object.

$xml must be a valid XML::TinyXML instance
$type must be a known selector $type
%args will be passed to the specific selector initializer
      (for instance to XML::TinyXML::Selector::XPath
       if using the xpath selector)

Returns a valid XML::TinyXML::Node object
Returns undef is $type is not known or if $xml is not a valid instance

=cut
sub new {
    my ($class, $xml, $type, %args) = @_;
    return undef
        unless($xml && ref($xml) && UNIVERSAL::isa($xml, "XML::TinyXML"));
    my $module = __PACKAGE__ . "::" . $type;
    if (eval "require $module; 1") {
        my $self = {};
        bless($self, $module);
        $self->{_xml} = $xml;
        return $self->init(%args);
    }
    return undef;
}

sub init {
    my $self = shift;
    # this is an optional method. Just return $self
    # if not overridden by a subclass implementation
    return $self;
}

sub select {
    die __PACKAGE__." You MUST Override Me!!"
}

1;

=back

=head1 SEE ALSO

=over 4

XML::TinyXML

=back

=head1 AUTHOR

xant, [e-mail]

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2010 by xant

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.


=cut