InterMine > Webservice-InterMine-1.0300 > Webservice::InterMine::ResultIterator

Download:
Webservice-InterMine-1.0300.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: Webservice-InterMine-1.0405

NAME ^

Webservice::InterMine::ResultIterator - An object for iterating through result rows

SYNOPSIS ^

  my $results = $query->result_iterator;
  while (<$results>) {
    # do something with $_
  }

DESCRIPTION ^

This package provides objects for iterating through result sets, where those result sets are rows from a database query.

CONSTRUCTION ARGUMENTS ^

The following arguments are required when constructing a new ResultIterator.

ATTRIBUTES ^

Other properties of the object. These attributes are derived from the original construction arguments.

######## ERROR CHECKING METHODS

METHODS - ERROR CHECKING ^

[Bool] is_success

Returns true if the server responded with a success-y status.

[Bool] is_error

Returns true if the server responded with an error-ish status.

[Str] status_line

Returns a human readable status line.

METHODS - RESULTS HANDLING (EXTERNAL API)

next

returns the next row in the appropriate format

get_all

Return all rows from the result set.

Returns a list of rows in list context, or an arrayref of rows in scalar context.

METHODS - RESULTS HANDLING (INTERNAL) ^

[Str] read_line

Read the next line from either the content blob, or the open connection, in the correct encoding, with the new line characters stripped.

connect

Connect to the resource specified by the url construction argument.

OVERLOADING ^

The following operators are overloaded:

Iteration: <>

Return the next row of data.

SEE ALSO ^

AUTHOR ^

Alex Kalderimis <dev@intermine.org>

BUGS ^

Please report any bugs or feature requests to dev@intermine.org.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Webservice::InterMine::ResultIterator

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright 2006 - 2011 FlyMine, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: