org.eaglei.search.provider.ncbi
Class ESearch

java.lang.Object
  org.eaglei.search.provider.ncbi.EUtils
      org.eaglei.search.provider.ncbi.ESearch

public final class ESearch
extends EUtils

Contains logic for using NCBI ESearch.

Author:

rfrost

Nested Class Summary

static class

ESearch.ESearchResult Simple representation of an eSearch result and, optionally, the results of a subsequent set of sSummary or eFetch calls.

Field Summary

Fields inherited from class org.eaglei.search.provider.ncbi.EUtils

DB, EUTILS_URL, ID, ID_PARAM, IDLIST, RETMAX, RETMODE, RETSTART, TERM, TOOL

Constructor Summary

ESearch()

Method Summary

static java.lang.String	buildSearchURL(java.lang.String query, java.lang.String db, java.lang.String tool, int start, int max) Builds an ESearchURL
static ESearch.ESearchResult	search(java.lang.String query, java.lang.String db, java.lang.String tool, int startIndex, int maxResults) Executes an NCBI search.

Methods inherited from class org.eaglei.search.provider.ncbi.EUtils

buildServiceURL, executeNCBIRequest, serializeDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ESearch

public ESearch()

Method Detail

search

public static ESearch.ESearchResult search(java.lang.String query,
                                           java.lang.String db,
                                           java.lang.String tool,
                                           int startIndex,
                                           int maxResults)
                                    throws java.io.IOException

Executes an NCBI search.

Throws:

java.io.IOException

buildSearchURL

public static java.lang.String buildSearchURL(java.lang.String query,
                                              java.lang.String db,
                                              java.lang.String tool,
                                              int start,
                                              int max)

Builds an ESearchURL

Parameters:

query - The Entrez DB query

db - The target Entrez DB

tool - Source tool

start - Start index

max - Max number of results

Returns:

Query URL.