ExaLead

Methods

__error
Accessor. error string if failure occurs
View source
ExaLead::__error


__status
Accessor. either 'no_search', 'search' or 'failure'
View source
ExaLead::__status


__timeout
Accessor. Sets the timeout period for XML retrival
View source
ExaLead::__timeout


_parse
The guts of the parser, takes an XML string, and converts it into a nested hash/array data structure using XML::Simple, which is then traversed to store the results returned by the search engine for later use
View source
ExaLead::_parse


_parse_category_tree
Recursive parser for the main category trees (stored in Exalead::Group object)
View source
ExaLead::_parse_category_tree


_parse_hit_category_tree
Recursive parser for the hit category trees (stored in Exalead::Hit object)
View source
ExaLead::_parse_hit_category_tree


addGroup
Add a Exalead::Query object - these are used to hold the different categorisation of matches (in Ensembl's case these are Feature type and Species)
View source
ExaLead::addGroup


addHit
Add a Exalead::Hit object - these are the actual URL responses for "pages" which match the request.
View source
ExaLead::addHit


addKeyword
Add a Exalead::Keyword object
View source
ExaLead::addKeyword


addSpellingSuggestion
Add a Exalead::SpellingSuggestion object - exalead comes back with alternative spellings if it cannot find the requested ID
View source
ExaLead::addSpellingSuggestion


end
Accessor. Taken from element of the XML returned
View source
ExaLead::end


engineURL
Accessor. URL for search engine itself - that generates the XML hits
View source
ExaLead::engineURL


estimated
Accessor. Taken from element of the XML returned
View source
ExaLead::estimated


groups
Returns array of Exalead::Group objects previously added
View source
ExaLead::groups


hits
Returns array of Exalead::Hits objects previously added
View source
ExaLead::hits


keywords
Returns array of Exalead::Keywords objects previously added
View source
ExaLead::keywords


last
Accessor. Taken from element of the XML returned
View source
ExaLead::last


new
Constructor. Store information about hits
View source
ExaLead::new


nhits
Accessor. Taken from element of the XML returned
View source
ExaLead::nhits


nmatches
Accessor. Taken from element of the XML returned
View source
ExaLead::nmatches


parse
Main function in the Exalead module, constructs the approprate request URL, and retrieves the XML, which then calls the inner function _parse, which actually parses the XML created the Exalead::* objects
View source
ExaLead::parse


query
Accessor. get/set Exalead::Query object, which summarises the query that was sentto the sarch engine
View source
ExaLead::query


rootURL
Accessor. URL for the wrapper script
View source
ExaLead::rootURL


spellingsuggestions
Returns array of Exalead::SpellingSuggestion objects previously added
View source
ExaLead::spellingsuggestions


start
Accessor. Taken from element of the XML returned
View source
ExaLead::start