Interface PhylogeniesWebserviceClient
-
- All Known Implementing Classes:
BasicPhylogeniesWebserviceClient
public interface PhylogeniesWebserviceClient
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringQUERY_PLACEHOLDER
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetDescription()A short description of the webservice (~20 characters).java.lang.StringgetInstructions()Instructions (and examples) on how to use the webservice.java.lang.StringgetMenuName()A name/description which can appear on a menu.java.lang.StringgetName()The name of the webservice.PhylogenyMethods.PhylogenyNodeFieldgetNodeField()The node data field in which to place node names from simple unannotated formats (such as Newick).java.lang.ObjectgetProcessingInstructions()This is used to indicate any kind of special processing.java.lang.StringgetReference()To get a type of reference for the webservice (an URL or citation, for example).WebservicesManager.WsPhylogenyFormatgetReturnFormat()The expected format of the response.java.lang.StringgetUrl()Use QUERY_PLACEHOLDER to indicate position of query variable.booleanisQueryInteger()Is the query a number?
-
-
-
Field Detail
-
QUERY_PLACEHOLDER
static final java.lang.String QUERY_PLACEHOLDER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescription
java.lang.String getDescription()
A short description of the webservice (~20 characters).- Returns:
- a short description of the webservice (~20 characters)
-
getInstructions
java.lang.String getInstructions()
Instructions (and examples) on how to use the webservice.- Returns:
- instructions (and examples) on how to use the webservice
-
getMenuName
java.lang.String getMenuName()
A name/description which can appear on a menu.- Returns:
- A name/description which can appear on a menu
-
getName
java.lang.String getName()
The name of the webservice.- Returns:
- the name of the webservice
-
getNodeField
PhylogenyMethods.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
java.lang.Object getProcessingInstructions()
This is used to indicate any kind of special processing.- Returns:
- a reference
-
getReference
java.lang.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
java.lang.String getUrl()
Use QUERY_PLACEHOLDER to indicate position of query variable.- Returns:
- the URL
-
isQueryInteger
boolean isQueryInteger()
Is the query a number?- Returns:
-
-