Difference between revisions of "Database Interop Hackathon/Implementations"

From Evolutionary Informatics Working Group
Jump to: navigation, search
Line 96: Line 96:
  
 
=== Describing the interface ===
 
=== Describing the interface ===
The first step is to formally describe the interface. In general terms, PhyloWS/REST proposes that data retrieval services are exposed using a URL API like this: '''<code>/phylows/${dataType}/${nameSpace}:${identifier}</code>''', where '''<code>${dataType}</code>''' is something like "Tree", "Matrix", etc. '''<code>${nameSpace}</code>''' is a naming authority such as ToLWeb, and '''<code>${identifier}</code>''' is unique within '''<code>${nameSpace}</code>''' (and consequently globally unique). This implies URLs such as '''<code>/phylows/Tree/ToLWeb:16299</code>''', which, when accessed using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods GET HTTP method] returns a representation of tree [http://tolweb.org/16299 16299].  
+
The first step is to formally describe the interface. In general terms, PhyloWS/REST proposes that data retrieval services are exposed using a URL API like this: '''<code>/phylows/${dataType}/${nameSpace}:${identifier}</code>''', where '''<code>${dataType}</code>''' is something like "Tree", "Matrix", etc. '''<code>${nameSpace}</code>''' is a naming authority such as ToLWeb, and '''<code>${identifier}</code>''' is unique within '''<code>${nameSpace}</code>''' (and consequently globally unique). This implies URLs such as '''<code>/phylows/Tree/ToLWeb:16299</code>''', which, when accessed using the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods GET HTTP method] returns a representation of tree [http://tolweb.org/16299 16299].
  
A standard way to describe this behaviour is to express it in [http://en.wikipedia.org/wiki/Web_Services_Description_Language WSDL2.0] - there's a nifty example of wsdl generation and annotation [http://www.keith-chapman.org/2008/09/restfull-mashup-with-wsdl-20-wso2.html here]. At the time of writing, the best free editor for wsdl files comes with the WTP extension for [http://eclipse.org eclipse]. The end result is a file such as [http://nexml-dev.nescent.org/nexml/phylows/tolweb?wsdl this one].
+
A standard way to describe this behaviour is to express it in [http://en.wikipedia.org/wiki/Web_Services_Description_Language WSDL2.0] - there's a nifty example of wsdl generation and annotation [http://www.keith-chapman.org/2008/09/restfull-mashup-with-wsdl-20-wso2.html here]. At the time of writing, the best free editor for wsdl files comes with the WTP extension for [http://eclipse.org eclipse]. The end result is a file such as [http://nexml-dev.nescent.org/nexml/phylows/tolweb?wsdl this one] [[Image:Tolrest.jpg]]
  
 
=== Implementing the controller ===
 
=== Implementing the controller ===

Revision as of 20:59, 3 October 2008

Summary

This page discusses potential target implementations that demonstrate the goals for the Evolutionary Database Interop Hackathon, to be held at NESCent in December 2008. The overall goal is to expose evolutionary data resource on the web in a machine readable architecture so that they can be integrated in complex work flows and mash-ups. To this end, we suggest their implementing of the stack produced by the evolutionary informatics working group:

  • Syntax - the NeXML data exchange standard
  • Interface/transport - the PhyloWS API for web services
  • Semantics - the CDAO character data analysis ontology

By combining these three components into a single, integrated stack, online data resources will produce output that is easy to parse and validate, whose semantics are well-defined, and whose interface is uniform across data resources.

Current implementations

Some of the online data resources the hackathon seeks to invite for an implementation drive are listed in the table below. The semantics of the output produced by these resources is diverse, including species trees, taxonomies, gene trees, character state matrices and alignments. Also, the programming languages used to implement these services are diverse, including Java, PHP, Python and Perl. This situation goes a long way to explain why standard industry practices (write a WSDL, generate client and server bindings, implement service) have not seen wide adoption in the evolutionary informatics community: different resources have, semantically and syntactically, different inputs and outputs, and are implemented in languages whose support for web services (especially WS-*) is sometimes incomplete.

ResourceExportable objectsImplementation language
Tree of Life ConceptGlossary#Species_Tree Java
pPOD ?? Java
uBio ConceptGlossary#Taxon, ConceptGlossary#Taxonomic_Rank, ConceptGlossary#Organismal_Taxonomy PHP
TimeTree ConceptGlossary#Species_Tree PHP
PhyloFacts ConceptGlossary#Transition_Model, ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment PHP
MorphBank ConceptGlossary#Character-State_Data_Matrix PHP, Java, JavaScript
MorphoBank ConceptGlossary#Character-State_Data_Matrix PHP, Flash/ActionScript
PhylomeDB ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment JavaScript, Python
PhyloTA ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment Perl
TreeFam ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment Perl
Pandit ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment Perl
MicrobesOnline ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment CGI (=Perl?)
HoVerGen ConceptGlossary#Phylogenetic_Tree, ConceptGlossary#Family_alignment CGI (=Perl?), PHP

Suggested hackathon deliverables

Data retrieval, based on an identifier

This simple reference service returns phylogenetic data that is identifiable by some GUID, such as a ToLWeb accession number. The service is implemented following the PhyloWS/REST proposal, has a CDAO annotated service description and emits NeXML.

Describing the interface

The first step is to formally describe the interface. In general terms, PhyloWS/REST proposes that data retrieval services are exposed using a URL API like this: /phylows/${dataType}/${nameSpace}:${identifier}, where ${dataType} is something like "Tree", "Matrix", etc. ${nameSpace} is a naming authority such as ToLWeb, and ${identifier} is unique within ${nameSpace} (and consequently globally unique). This implies URLs such as /phylows/Tree/ToLWeb:16299, which, when accessed using the GET HTTP method returns a representation of tree 16299.

A standard way to describe this behaviour is to express it in WSDL2.0 - there's a nifty example of wsdl generation and annotation here. At the time of writing, the best free editor for wsdl files comes with the WTP extension for eclipse. The end result is a file such as this one Tolrest.jpg

Implementing the controller