Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::filter::saxt(3pm) [debian man page]

SAXT(3pm)						User Contributed Perl Documentation						 SAXT(3pm)

NAME

       XML::Filter::SAXT - Replicates SAX events to several SAX event handlers

SYNOPSIS

	$saxt = new XML::Filter::SAXT ( { Handler => $out1 },
					{ DocumentHandler => $out2 },
					{ DTDHandler => $out3,
					  Handler => $out4
					}
				      );

	$perlsax = new XML::Parser::PerlSAX ( Handler => $saxt );
	$perlsax->parse ( [OPTIONS] );

DESCRIPTION

       SAXT is like the Unix 'tee' command in that it multiplexes the input stream to several output streams. In this case, the input stream is a
       PerlSAX event producer (like XML::Parser::PerlSAX) and the output streams are PerlSAX handlers or filters.

       The SAXT constructor takes a list of hash references. Each hash specifies an output handler. The hash keys can be: DocumentHandler,
       DTDHandler, EntityResolver or Handler, where Handler is a combination of the previous three and acts as the default handler.  E.g. if
       DocumentHandler is not specified, it will try to use Handler.

   EXAMPLE
       In this example we use XML::Parser::PerlSAX to parse an XML file and to invoke the PerlSAX callbacks of our SAXT object. The SAXT object
       then forwards the callbacks to XML::Checker, which will 'die' if it encounters an error, and to XML::Handler::BuildDOM, which will store
       the XML in an XML::DOM::Document.

	use XML::Parser::PerlSAX;
	use XML::Filter::SAXT;
	use XML::Handler::BuildDOM;
	use XML::Checker;

	my $checker = new XML::Checker;
	my $builder = new XML::Handler::BuildDOM (KeepCDATA => 1);
	my $tee = new XML::Filter::SAXT ( { Handler => $checker },
					  { Handler => $builder } );

	my $parser = new XML::Parser::PerlSAX (Handler => $tee);
	eval
	{
	   # This is how you set the error handler for XML::Checker
	   local $XML::Checker::FAIL = &my_fail;

	   my $dom_document = $parser->parsefile ("file.xml");
	   ... your code here ...
	};
	if ($@)
	{
	   # Either XML::Parser::PerlSAX threw an exception (bad XML)
	   # or XML::Checker found an error and my_fail died.
	   ... your error handling code here ...
	}

	# XML::Checker error handler
	sub my_fail
	{
	  my $code = shift;
	  die XML::Checker::error_string ($code, @_)
	       if $code < 200;	 # warnings and info messages are >= 200
	}

CAVEATS

       This is still alpha software.  Package names and interfaces are subject to change.

AUTHOR

       Enno Dersken is the original author.

       Send bug reports, hints, tips, suggestions to T.J. Mather at <tjmather@tjmather.com>.

perl v5.10.1							    2001-09-03								 SAXT(3pm)

Check Out this Related Man Page

XML::Handler::Subs(3)					User Contributed Perl Documentation				     XML::Handler::Subs(3)

NAME

       XML::Handler::Subs - a PerlSAX handler base class for calling user-defined subs

SYNOPSIS

	use XML::Handler::Subs;

	package MyHandlers;
	use vars qw{ @ISA };

	sub s_NAME { my ($self, $element) = @_ };
	sub e_NAME { my ($self, $element) = @_ };

	$self->{Names};    # an array of names
	$self->{Nodes};    # an array of $element nodes

	$handler = MyHandlers->new();
	$self->in_element($name);
	$self->within_element($name);

DESCRIPTION

       "XML::Handler::Subs" is a base class for PerlSAX handlers.  "XML::Handler::Subs" is subclassed to implement complete behavior and to add
       element-specific handling.

       Each time an element starts, a method by that name prefixed with `s_' is called with the element to be processed.  Each time an element
       ends, a method with that name prefixed with `e_' is called.  Any special characters in the element name are replaced by underscores.

       Subclassing XML::Handler::Subs in this way is similar to XML::Parser's Subs style.

       XML::Handler::Subs maintains a stack of element names, `"$self-"{Names}', and a stack of element nodes, `"$self-"{Nodes}>' that can be used
       by subclasses.  The current element is pushed on the stacks before calling an element-name start method and popped off the stacks after
       calling the element-name end method.  The `"in_element()"' and `"within_element()"' calls use these stacks.

       If the subclass implements `"start_document()"', `"end_document()"', `"start_element()"', and `"end_element()"', be sure to use `"SUPER::"'
       to call the the superclass methods also.  See perlobj(1) for details on SUPER::.  `"SUPER::start_element()"' and `"SUPER::end_element()"'
       return 1 if an element-name method is called, they return 0 if no method was called.

       XML::Handler::Subs does not implement any other PerlSAX handlers.

       XML::Handler::Subs supports the following methods:

       new( OPTIONS )
	   A basic `"new()"' method.  `"new()"' takes a list of key, value pairs or a hash and creates and returns a hash with those options; the
	   hash is blessed into the subclass.

       in_element($name)
	   Returns true if `$name' is equal to the name of the innermost currently opened element.

       within_element($name)
	   Returns the number of times the `$name' appears in Names.

AUTHOR

       Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO

       perl(1), PerlSAX.pod(3)

perl v5.8.0							    2000-02-22						     XML::Handler::Subs(3)
Man Page