org.forester.archaeopteryx.webservices
Interface PhylogeniesWebserviceClient

All Known Implementing Classes:
BasicPhylogeniesWebserviceClient

public interface PhylogeniesWebserviceClient


Field Summary
static String QUERY_PLACEHOLDER
           
 
Method Summary
 String getDescription()
          A short description of the webservice (~20 characters).
 String getInstructions()
          Instructions (and examples) on how to use the webservice.
 String getMenuName()
          A name/description which can appear on a menu.
 String getName()
          The name of the webservice.
 ForesterUtil.PhylogenyNodeField getNodeField()
          The node data field in which to place node names from simple unannotated formats (such as Newick).
 Object getProcessingInstructions()
          This is used to indicate any kind of special processing.
 String getReference()
          To get a type of reference for the webservice (an URL or citation, for example).
 WebservicesManager.WsPhylogenyFormat getReturnFormat()
          The expected format of the response.
 String getUrl()
          Use QUERY_PLACEHOLDER to indicate position of query variable.
 boolean isQueryInteger()
          Is the query a number?
 

Field Detail

QUERY_PLACEHOLDER

static final String QUERY_PLACEHOLDER
See Also:
Constant Field Values
Method Detail

getDescription

String getDescription()
A short description of the webservice (~20 characters).

Returns:
a short description of the webservice (~20 characters)

getInstructions

String getInstructions()
Instructions (and examples) on how to use the webservice.

Returns:
instructions (and examples) on how to use the webservice

getMenuName

String getMenuName()
A name/description which can appear on a menu.

Returns:
A name/description which can appear on a menu

getName

String getName()
The name of the webservice.

Returns:
the name of the webservice

getNodeField

ForesterUtil.PhylogenyNodeField getNodeField()
The node data field in which to place node names from simple unannotated formats (such as Newick). Null means avoiding any such postprocessing.

Returns:
the field code

getProcessingInstructions

Object getProcessingInstructions()
This is used to indicate any kind of special processing.

Returns:
a reference

getReference

String getReference()
To get a type of reference for the webservice (an URL or citation, for example).

Returns:
a reference

getReturnFormat

WebservicesManager.WsPhylogenyFormat getReturnFormat()
The expected format of the response.

Returns:
the expected format of the response

getUrl

String getUrl()
Use QUERY_PLACEHOLDER to indicate position of query variable.

Returns:
the URL

isQueryInteger

boolean isQueryInteger()
Is the query a number?

Returns: