Lingua::AtD::Results - Encapsulate conversion of XML from /checkDocument or /checkGrammar call to Error objects.
version 1.112980
use Lingua::AtD; # Create a new service proxy my $atd = Lingua::AtD->new( { host => 'service.afterthedeadline.com', port => 80 }); # Run spelling and grammar checks. Returns a Lingua::AtD::Response object. my $atd_response = $atd->check_document('Text to check.'); # Loop through reported document errors. foreach my $atd_error ($atd_response->get_errors()) { # Do something with... print "Error string: ", $atd_error->get_string(), "\n"; } # Run only grammar checks. Essentially the same as # check_document(), sans spell-check. my $atd_response = $atd->check_grammar('Text to check.'); # Loop through reported document errors. foreach my $atd_error ($atd_response->get_errors()) { # Do something with... print "Error string: ", $atd_error->get_string(), "\n"; } # Get statistics on a document. Returns a Lingua::AtD::Scores object. my $atd_scores = $atd->stats('Text to check.'); # Loop through reported document errors. foreach my $atd_metric ($atd_scores->get_metrics()) { # Do something with... print $atd_metric->get_type(), "/", $atd_metric->get_key(), " = ", $atd_metric->get_value(), "\n"; }
Encapsulates conversion of the XML response from the AtD server into a list of spelling/grammar/style error objects (Lingua::AtD::Error).
# Possible, but not likely my $atd_results = Lingua::AtD::Results->new($xml_response); foreach my $atd_error ($atd_results->get_errors()) { # Do something really fun... }
Lingua::AtD::Results objects should only ever be created from method calls to Lingua::AtD. However, if you have saved XML responses from prior calls to AtD, you can use this object to convert those responses into PERL objects. I won't stop you.
See the SYNOPSIS for typical usage.
Convenience method to see if the AtD server returned an error message.
Exception message from the server.
Convenience method to see if the XML response from AtD actually contained any spelling/grammar/style errors. These are not exceptions (see get_server_exception). These are expected, and in fact are what you've asked for.
Returns a list of spelling/grammar/style errors as Lingua::AtD::Error objects.
Returns a string containing the raw XML response from the AtD service call.
See the API Documentation at After the Deadline's website.
David L. Day <dday376@gmail.com>
This software is copyright (c) 2011 by David L. Day.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Lingua::AtD, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Lingua::AtD
CPAN shell
perl -MCPAN -e shell install Lingua::AtD
For more information on module installation, please visit the detailed CPAN module installation guide.