XML::Grove::PerlSAX(3pm)

1XML::Grove::PerlSAX(3)User Contributed Perl DocumentationXML::Grove::PerlSAX(3)
2
3
4

NAME

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

SYNOPSIS

9        use XML::Grove::PerlSAX;
10
11        $parser = XML::Grove::PerlSAX->new( [OPTIONS] );
12        $result = $parser->parse( [OPTIONS] );
13
14        # or
15        $result = $xml_object->parse( [OPTIONS] );
16

DESCRIPTION

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

METHODS

25       new Creates a new parser object.  Default options for parsing,
26           described below, are passed as key-value pairs or as a single hash.
27           Options may be changed directly in the parser object unless stated
28           otherwise.  Options passed to `parse()' override the default
29           options in the parser object for the duration of the parse.
30
31       parse
32           Parses a document.  Options, described below, are passed as key-
33           value pairs or as a single hash.  Options passed to `parse()'
34           override default options in the parser object.
35

OPTIONS

37       The following options are supported by "XML::Grove::PerlSAX":
38
39        Handler          default handler to receive events
40        DocumentHandler  handler to receive document events
41        Source           hash containing the input source for parsing
42
43       If no handlers are provided then all events will be silently ignored.
44
45       If a single grove argument is passed to the `parse()' method, it is
46       treated as if a `"Source"' option was given with a `"Grove"' parameter.
47
48       The `"Source"' hash may contain the following parameters:
49
50        Grove            The grove object used to generate parse events..
51

HANDLERS

53       The following events are generated by "XML::Grove::PerlSAX".
54       XML::Grove::PerlSAX passes the corresponding grove object as it's
55       parameter so the properties passed to the handler are those that were
56       used to create or were assigned to the grove.  Please see the docs for
57       the parser used to create the grove for a list of properties that were
58       provided.
59
60   DocumentHandler methods
61       start_document
62           Receive notification of the beginning of a document.  This is
63           called from the XML::Grove::Document object before processing any
64           document content.
65
66       end_document
67           Receive notification of the end of a document.  This is called from
68           the XML::Grove::Document object after processing all document
69           content.
70
71       start_element
72           Receive notification of the beginning of an element.  This is
73           called from the XML::Grove::Element object before processing any
74           element content.
75
76       end_element
77           Receive notification of the end of an element.  This is called from
78           the XML::Grove::Element object after processing all element
79           content.
80
81       characters
82           Receive notification of character data.  This is called from the
83           XML::Grove::Characters object.
84
85       processing_instruction
86           Receive notification of a processing instruction.  This is called
87           from the XML::Grove::PI object.
88
89       comment
90           Receive notification of a comment.  This is called from the
91           XML::Grove::Comment object.
92

AUTHOR

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