xml::handler::subs(3) [redhat 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)

XML::Grove::PerlSAX(3pm)				User Contributed Perl Documentation				  XML::Grove::PerlSAX(3pm)

NAME

       XML::Grove::PerlSAX - an PerlSAX event interface for XML objects

SYNOPSIS

	use XML::Grove::PerlSAX;

	$parser = XML::Grove::PerlSAX->new( [OPTIONS] );
	$result = $parser->parse( [OPTIONS] );

	# or
	$result = $xml_object->parse( [OPTIONS] );

DESCRIPTION

       "XML::Grove::PerlSAX" is a PerlSAX parser that generates PerlSAX events from XML::Grove objects.  This man page summarizes the specific
       options, handlers, and properties supported by "XML::Grove::PerlSAX"; please refer to the PerlSAX standard in `"PerlSAX.pod"' for general
       usage information.

METHODS

       new Creates a new parser object.  Default options for parsing, described below, are passed as key-value pairs or as a single hash.  Options
	   may be changed directly in the parser object unless stated otherwise.  Options passed to `"parse()"' override the default options in
	   the parser object for the duration of the parse.

       parse
	   Parses a document.  Options, described below, are passed as key-value pairs or as a single hash.  Options passed to `"parse()"'
	   override default options in the parser object.

OPTIONS

       The following options are supported by "XML::Grove::PerlSAX":

	Handler 	 default handler to receive events
	DocumentHandler  handler to receive document events
	Source		 hash containing the input source for parsing

       If no handlers are provided then all events will be silently ignored.

       If a single grove argument is passed to the `"parse()"' method, it is treated as if a `"Source"' option was given with a `"Grove"'
       parameter.

       The `"Source"' hash may contain the following parameters:

	Grove		 The grove object used to generate parse events..

HANDLERS

       The following events are generated by "XML::Grove::PerlSAX".  XML::Grove::PerlSAX passes the corresponding grove object as it's parameter
       so the properties passed to the handler are those that were used to create or were assigned to the grove.  Please see the docs for the
       parser used to create the grove for a list of properties that were provided.

   DocumentHandler methods
       start_document
	   Receive notification of the beginning of a document.  This is called from the XML::Grove::Document object before processing any
	   document content.

       end_document
	   Receive notification of the end of a document.  This is called from the XML::Grove::Document object after processing all document
	   content.

       start_element
	   Receive notification of the beginning of an element.  This is called from the XML::Grove::Element object before processing any element
	   content.

       end_element
	   Receive notification of the end of an element.  This is called from the XML::Grove::Element object after processing all element
	   content.

       characters
	   Receive notification of character data.  This is called from the XML::Grove::Characters object.

       processing_instruction
	   Receive notification of a processing instruction.  This is called from the XML::Grove::PI object.

       comment
	   Receive notification of a comment.  This is called from the XML::Grove::Comment object.

AUTHOR

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

SEE ALSO

       perl(1), XML::Grove(3)

       Extensible Markup Language (XML) <http://www.w3c.org/XML>

perl v5.10.1							    1999-10-23						  XML::Grove::PerlSAX(3pm)