InterMine > Webservice-InterMine-1.0200 > Webservice::InterMine::IDResolutionJob

Download:
Webservice-InterMine-1.0200.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Webservice::InterMine::IDResolutionJob

SYNOPSIS ^

    use strict;
    use Webservice::InterMine;
    use Data::Dumper;

    my $service = Webservice::InterMine->get_service('www.flymine.org/query');

    my $job = $service->resolve_ids(
        identifiers => [qw/eve zen r bib Mad h/],
        type => 'Gene',
        extra => 'D. melanogaster'
    );

    $job->poll until ($job->completed);

    print Dumper($job->results);

DESCRIPTION ^

ID Resolution jobs are asynchronous requests to a web service to resolve a set of identifiers to the objects available in the services data-store. This object records the request made and provides mechanisms for checking the status of the request and retrieving the results when they become available.

ATTRIBUTES ^

service

isa: Webservice::InterMine::Service is: ro required: true

The service this request was made to.

identifiers

isa: Array of Str is: ro required: true

The identifiers to resolve.

uid

isa: Str is: ro

The unique identifier of this job on the server.

type

isa: Str is: ro required: true

The type of objects these identifiers are meant to resolve to (eg. Gene).

extra

isa: Str is: ro required: false

An optional extra value used to disambiguate the ID resolution, such as the organism name.

caseSensitive

isa: Bool is: ro required: false default: false

Whether or not the identifiers should be treated case-sensitively or not.

wildCards

isa: Bool is: ro required: false default: false

Whether or not to interpret '*'s in identifiers as wildcards.

completed

isa: Bool is: ro required: false default: false

whether or not this job has been completed yet.

times_polled

isa: Num is: ro required: false init: 0

The number of times this job has polled for results.

last_poll

isa: Num is: ro required: false

The timestamp of the last poll.

results

The results of the job. Do not call for them before the job reports its completion.

METHODS ^

as_submission()

Get the data transmitted to the service to initialise the job.

poll()

Check the status of the job on the server.

Returns true when the job is complete, and false if it is not ready yet. If the job has resulted in an error on the server, that error message will be confessed here.

fetch_results()

Make a call to the server to fetch results for this job.

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::IDResolutionJob

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright 2006 - 2013 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: