.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "XML::SAX::Manifold 3pm" .TH XML::SAX::Manifold 3pm "2020-12-29" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" XML::SAX::Manifold \- Multipass processing of documents .SH "VERSION" .IX Header "VERSION" version 0.46 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use XML::SAX::Machines qw( Manifold ) ; \& \& my $m = Manifold( \& $channel0, \& $channel1, \& $channel2, \& { \& Handler => $h, ## optional \& } \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" XML::SAX::Manifold is a \s-1SAX\s0 machine that allows \*(L"multipass\*(R" processing of a document by sending the document through several channels of \s-1SAX\s0 processors one channel at a time. A channel may be a single \s-1SAX\s0 processor or a pipeline (see XML::SAX::Pipeline). .PP The results of each channel are aggregated by a \s-1SAX\s0 filter that supports the \f(CW\*(C`end_all\*(C'\fR event, \f(CW\*(C`XML::Filter::Merger\*(C'\fR by default. See the section on writing an aggregator and XML::Filter::Merger. .PP This differs from XML::Filter::SAXT in that the channels are prioritized and each channel receives all events for a document before the next channel receives any events. XML::SAX::Manifold buffers all events while feeding them to the highest priority channel (\f(CW$processor1\fR in the synopsis), and replays them for each lower priority channel one at a time. .PP The event flow for the example in the \s-1SYNOPSIS\s0 would look like the following, with the numbers next to the connection arrow indicating when the document's events flow along that arrow. .PP .Vb 10 \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ \& | An XML::SAX::Manifold instance | \& | | \& | +\-\-\-\-\-\-\-\-\-\-\-+ | \& | +\->| Channel_0 |\-+ | \& | 1/ +\-\-\-\-\-\-\-\-\-\-\-+ \e1 | \& | Intake / \e | \& 1 | +\-\-\-\-\-\-+ 2 +\-\-\-\-\-\-\-\-\-\-\-+ 2 \e +\-\-\-\-\-\-\-\-+ Exhaust | \& \-\-+\->| Dist |\-\-\-\->| Channel_1 |\-\-\-\-\-*\-\->| Merger |\-\-\-\-\-\-\-\-\-+\-\-> $h \& | +\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-+ / +\-\-\-\-\-\-\-\-+ | \& | \e3 3/ | \& | \e +\-\-\-\-\-\-\-\-\-\-\-+ / | \& | +\->| Channel_2 |\-+ | \& | +\-\-\-\-\-\-\-\-\-\-\-+ | \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ .Ve .PP Here's the timing of the event flows: .PP .Vb 3 \& 1: upstream \-> Dist. \-> Channel_0 \-> Merger \-> downstream \& 2: Dist. \-> Channel_1 \-> Merger \-> downstream \& 3: Dist. \-> Channel_2 \-> Merger \-> downstream .Ve .PP When the document arrives from upstream, the events all arrive during time period 1 and are buffered and also passed through Channel_0 and Channel_0's output is sent to the Merger. After all events have been received (as indicated by an \f(CW\*(C`end_document\*(C'\fR event from upstream), all events are then played back through Channel_1 and then through Channel_2 (which also output to the Merger). .PP It's the merger's job to assemble the three documents it receives in to one document; see XML::Filter::Merger for details. .SH "NAME" XML::SAX::Manifold \- Multipass processing of documents .SH "METHODS" .IX Header "METHODS" .IP "new" 4 .IX Item "new" .Vb 1 \& my $d = XML::SAX::Manifold\->new( @channels, \e%options ); .Ve .Sp Longhand for calling the Manifold function exported by XML::SAX::Machines. .SH "Writing an aggregator." .IX Header "Writing an aggregator." To be written. Pretty much just that \f(CW\*(C`start_manifold_processing\*(C'\fR and \&\f(CW\*(C`end_manifold_processing\*(C'\fR need to be provided. See XML::Filter::Merger and it's source code for a starter. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Barry Slaymaker .IP "\(bu" 4 Chris Prather .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Barry Slaymaker. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.