If a list of record ids is returned by the call, ids() will return these as
an array reference:
The total count of returned records is provided by count():
If usehistory was specified in the SOAP call, the NCBI-assigned web environment (that can be used in future calls) is available in webenv, and the query key assigned to the result in query_key:
|Walking the response||
This module uses AUTOLOAD to provide accessor methods for all response data.
Here is an example of a SOAP response as returned by a method() call off the SOAP::SOM object:
Some of the data values here (at the tips of the data structure) are actually arrays of values ( e.g., the tip IdList = Id> ), other tips are simple scalars. With this in mind, Result accessor methods work as follows:
Data values (at the tips of the response structure) are acquired by calling a method with the structure keys separated by underscores (if necessary):
Data sets below a particular node in the response structure can also be obtained with similarly constructed method names. These internal node accessors return a hashref, containing all data leaves below the node, keyed by the accessor names:
Similarly, the call $result-TranslationStack_TermSet > would return a similar hash containing the last 4 elements of the example hash above.
Creating accessors is somewhat costly, especially for fetch responses which can be deep and complex (not unlike BioPerl developers). Portions of the response tree can be ignored by setting -prune_at_node to a arrayref of nodes to skip. Nodes should be specified in SOAP::SOM format, e.g.
Accessor creation can be skipped altogether by passing -no_parse = 1> to the Result constructor. This is recommended if a result is being passed to a Bio::DB::SoapEUtilities::FetchAdaptor. The original SOAP message with all data is always available in $result-som>.
An array of available data accessor names. This contains only the data tips. The internal node accessors are autoloaded.
Returns the SOAP fault error string.
The original SOAP::SOM message.
The EUtility associated with the result.
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.
Please direct usage questions or support issues to the mailing list:
rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.
Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:
Email maj -at- fortinbras -dot- us
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
parse_methods()Title : parse_methods Usage : Function: parse out the accessor methods Returns : self (Result object) Args : $alias_hash (hashref), $prune_at_nodes (scalar or arrayref)
util()Title : util Usage : Function: Name of the utility producing this result object. Returns : scalar string Args :
som()Title : som Usage : Function: get the original SOAP::SOM object Returns : a SOAP::SOM object Args : none
errstr()Title : errstr Usage : Function: Returns : fault string of SOAP object Args : noneTitle : accessors Usage : Function: get the list of created accessors for this result Returns : array of scalar strings Args : none Note : does not include valid AUTOLOADed accessors; see DESCRIPTION
webenv()Title : webenv Usage : Function: contains WebEnv key referencing this results session Returns : scalar Args : none
query_key()()Title : query_key() Usage : Function: contains the web query key assigned to this result Returns : scalar Args :
fetch_type()Title : fetch_type Usage : Function: Get the efetch database name according to WSDL Returns : scalar string (db name) or undef if N/A Args : none
Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 137: You cant have =items (as at line 141) unless the first thing after the =over is an =item
|perl v5.20.3||BIO::DB::SOAPEUTILITIES::RESULT (3)||2016-04-05|