NAME
DataFlow::Node::HTMLFilter - A filter node for HTML content.
SYNOPSIS
use DataFlow::Node::HTMLFilter;
my $filter_html = DataFlow::Node::HTMLFilter->new(
search_xpath => '//td',
result_type => 'HTML',
);
my $filter_value = DataFlow::Node::HTMLFilter->new(
search_xpath => '//td',
result_type => 'VALUE',
);
my $input = <<EOM;
<html><body>
<table>
<tr><td>Line 1</td><td>L1, Column 2</td>
<tr><td>Line 2</td><td>L2, Column 2</td>
</table>
</html></body>
EOM
$filter_html->input( $input );
# @result == '<td>Line 1</td>', ... '<td>L2, Column 2</td>'
$filter_value->input( $input );
# @result == q{Line 1}, ... q{L2, Column 2}DESCRIPTION
This node type provides a filter for HTML content. Each item will be considered as a HTML content and will be filtered using HTML::TreeBuilder::XPath.
ATTRIBUTES
search_xpath
This attribute is a XPath string used to filter down the HTML content. The search_xpath attribute is mandatory.
result_type
This attribute is a string, but its value must be one of: HTML, VALUE, NODE. The default is HTML.
HTML
The result will be the HTML content specified by search_xpath.
VALUE
The result will be the literal value enclosed by the tag and/or attribute specified by search_xpath.
NODE
The result will be a list of HTML::Element objects, as returned by the findnodes method of HTML::TreeBuilder::XPath class.
Most people will probably use HTML or VALUE, but this option is also provided in case someone wants to manipulate the HTML elements directly.
ref_result
This attribute is a boolean, and it signals whether the result list should be added as a list of items to the output queue, or as a reference to an array of items. The default is 0 (false).
There is a semantic subtlety here: if ref_result is 1 (true), then one HTML item (input) may generate one or zero ArrayRef item (output), i.e. it is a one-to-one mapping. On the other hand, by keeping ref_result as 0 (false), one HTML item may produce any number of items as result, i.e. it is a one-to-many mapping.
METHODS
The interface for DataFlow::Node::HTMLFilter is the same of DataFlow::Node, plus the accessor methods for the attributes described above.
DEPENDENCIES
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
Please report any bugs or feature requests to bug-dataflow@rt.cpan.org, or through the web interface at http://rt.cpan.org.
AUTHOR
Alexei Znamensky <russoz@cpan.org>
LICENCE AND COPYRIGHT
Copyright (c) 2010, Alexei Znamensky <russoz@cpan.org>. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.