org.eaglei.search.provider.ncbi
Class ESummary

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

public final class ESummary
extends EUtils

Contains logic for using NCBI EUtils.

Author:

rfrost

Nested Class Summary

static class	ESummary.ESummaryResult Simple representation of the result (a DocSum) from an eSummary search
static class	ESummary.Item
static class	ESummary.ListItem

Field Summary

static java.lang.String

EUTILS_SUMMARY_URL

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

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

Constructor Summary

ESummary()

Method Summary

static void	getSummaries(ESearch.ESearchResult result, java.lang.String db, java.lang.String tool, int max) Executes an NCBI search and then series of summary calls for the initial page of results.
static java.util.List<ESummary.ESummaryResult>	parseESummaryResult(org.w3c.dom.Document doc) Parses an eSummary XML result and returns the IDs.

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

Field Detail

EUTILS_SUMMARY_URL

public static final java.lang.String EUTILS_SUMMARY_URL

See Also:

Constant Field Values

Constructor Detail

ESummary

public ESummary()

Method Detail

getSummaries

public static void getSummaries(ESearch.ESearchResult result,
                                java.lang.String db,
                                java.lang.String tool,
                                int max)
                         throws java.io.IOException

Executes an NCBI search and then series of summary calls for the initial page of results.

Throws:

java.io.IOException

parseESummaryResult

public static java.util.List<ESummary.ESummaryResult> parseESummaryResult(org.w3c.dom.Document doc)
                                                                   throws java.io.IOException

Parses an eSummary XML result and returns the IDs.

Parameters:

doc - XML Document.

Returns:

List of IDs

Throws:

java.io.IOException