PubMed API Interface - 11791-04/project-team04 GitHub Wiki

Public Interface:

---

Method: getInstance() Returns: GoPubMedService

This method first checks if a GoPubMedService object has been instantiated. If so, it returns the already-instantiated object. If not, it creates a new GoPubMedService object and returns it. If a ConfigurationException occurs, this method throws a new UIMA_IllegalStateException. This method is synchronized.

---

Public Interface:

---

Method: GoPubMedServiceProxy()

Constructor. Calls GoPubMedServiceFactory.getInstance() to get a reference to a GoPubMedService object.

---

Method: getFindingsFromQuery(String query) Returns: List<OntologyServiceResponse.Finding>

Based on String query this method makes all API calls to GoPubMedService that return Finding lists. Included calls are Disease ontology, Gene ontology, Jochem, MeSH, and UniProt.

---

Method: getPubMedDocumentsFromQuery(String query) Returns: List<PubMedSearchServiceResponse.Document>

Based on String query this method makes all API calls to GoPubMedService that return Document lists. Included calls are Pub Med Citations.

---

Method: getEntitiesFromQuery(String query) Returns: List<LinkedLifeDataServiceResponse.Entity>

Based on String query this method makes all API calls to GoPubMedService that return Entity lists. Entity lists also contain lists of Relation objects. Calls to the getRelations() method will return them.

---