InterMine
and 1 contributors

NAME

Webservice::InterMine::Simple::Template

SYNOPSIS

  my $template = $service->template("Gene_Pathways");

  @rows = $query2->results_table(constraint1 => "eq", value1 => "ABC trans*");
  for my $row (@rows) {
    print @$row;
  }

DESCRIPTION

This is a basic representation of a query. It can handle straight-forward requests and result sets, but for anything more complicated, we recommend you look as the more fully featured Webservice::InterMine. This is especially true of large data sets, as this implementation has the potential to use lots of memory when receiving and processing results.

METHODS

new(name => $name) - Construct a new template.

Create an object representing the template with the given name.

results_with - get the results for this query as a single string.

Returns the string representation of the template's results.

Parameters:

  • %template_parameters

    Specification of the template parameters to use. These take the form:

    constraint? => $path
    op? => $op
    value? => $value
    extra? => $extra_value

    Where ? represents a number that is used to group properties for each template constraint.

  • as => $format

    Specifies the result format.

  • size => int

    Specifies the maximum number of rows to return. A query can return up to 10,000,000 rows in a single page.

  • start => int

    Specifies the index of the first result to return.

  • columnheaders => bool

    Whether or not you want the first row to be the names of the output columns.

results_table - get a list of rows (as array-references)

Performs very naïve parsing of returned tabular data and splits rows into array references based using a failure-prone "tab" split.

Takes the same arguments as results_with.

get_count - get the number of rows the query returns

Returns a number representing the total number of rows in the result set.

Takes the same arguments as results_with.

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

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.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 114:

Non-ASCII character seen before =encoding in 'naïve'. Assuming UTF-8