ExaLead

Location: /modules/ExaLead.pm
Source code · Permalink
No superclasses
No subclasses

Overview

The Exalead class heirarchy is a Perl wrapper around the Exalead one XML search engine output

Accessor

Constructor

Method

Documentation coverage: 100 %

Methods

    __error
    Accessor. error string if failure occurs
    View source

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

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

    _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

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

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

    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

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

    addKeyword
    Add a Exalead::Keyword object
    View source

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

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

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

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

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

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

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

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

    new
    Constructor. Store information about hits
    View source

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

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

    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

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

    rootURL
    Accessor. URL for the wrapper script
    View source

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

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