java.lang.Object
- org.forester.archaeopteryx.webservices.BasicPhylogeniesWebserviceClient

All Implemented Interfaces:: PhylogeniesWebserviceClient

public class BasicPhylogeniesWebserviceClient
extends java.lang.Object
implements PhylogeniesWebserviceClient

Field Summary
- Fields inherited from interface org.forester.archaeopteryx.webservices.PhylogeniesWebserviceClient
  QUERY_PLACEHOLDER

Constructor Summary

Constructors
Constructor	Description
`BasicPhylogeniesWebserviceClient(java.lang.String name, java.lang.String menu_name, java.lang.String desc, java.lang.String instructions, WebservicesManager.WsPhylogenyFormat format, PhylogenyMethods.PhylogenyNodeField node_field, java.lang.String url, boolean integer, java.lang.String ref, java.lang.Object proc_inst)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`	A short description of the webservice (~20 characters).
`java.lang.String`	`getInstructions()`	Instructions (and examples) on how to use the webservice.
`java.lang.String`	`getMenuName()`	A name/description which can appear on a menu.
`java.lang.String`	`getName()`	The name of the webservice.
`PhylogenyMethods.PhylogenyNodeField`	`getNodeField()`	The node data field in which to place node names from simple unannotated formats (such as Newick).
`java.lang.Object`	`getProcessingInstructions()`	This is used to indicate any kind of special processing.
`java.lang.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.
`java.lang.String`	`getUrl()`	Use QUERY_PLACEHOLDER to indicate position of query variable.
`boolean`	`isQueryInteger()`	Is the query a number?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BasicPhylogeniesWebserviceClient
```
public BasicPhylogeniesWebserviceClient(java.lang.String name,
                                        java.lang.String menu_name,
                                        java.lang.String desc,
                                        java.lang.String instructions,
                                        WebservicesManager.WsPhylogenyFormat format,
                                        PhylogenyMethods.PhylogenyNodeField node_field,
                                        java.lang.String url,
                                        boolean integer,
                                        java.lang.String ref,
                                        java.lang.Object proc_inst)
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    A short description of the webservice (~20 characters).
    
    Specified by:
    
    getDescription in interface PhylogeniesWebserviceClient
    
    Returns:
    
    a short description of the webservice (~20 characters)
  - getInstructions
```
public java.lang.String getInstructions()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    Instructions (and examples) on how to use the webservice.
    
    Specified by:
    
    getInstructions in interface PhylogeniesWebserviceClient
    
    Returns:
    
    instructions (and examples) on how to use the webservice
  - getMenuName
```
public java.lang.String getMenuName()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    A name/description which can appear on a menu.
    
    Specified by:
    
    getMenuName in interface PhylogeniesWebserviceClient
    
    Returns:
    
    A name/description which can appear on a menu
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    The name of the webservice.
    
    Specified by:
    
    getName in interface PhylogeniesWebserviceClient
    
    Returns:
    
    the name of the webservice
  - getNodeField
```
public PhylogenyMethods.PhylogenyNodeField getNodeField()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    The node data field in which to place node names from simple unannotated formats (such as Newick). Null means avoiding any such postprocessing.
    
    Specified by:
    
    getNodeField in interface PhylogeniesWebserviceClient
    
    Returns:
    
    the field code
  - getProcessingInstructions
```
public java.lang.Object getProcessingInstructions()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    This is used to indicate any kind of special processing.
    
    Specified by:
    
    getProcessingInstructions in interface PhylogeniesWebserviceClient
    
    Returns:
    
    a reference
  - getReference
```
public java.lang.String getReference()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    To get a type of reference for the webservice (an URL or citation, for example).
    
    Specified by:
    
    getReference in interface PhylogeniesWebserviceClient
    
    Returns:
    
    a reference
  - getReturnFormat
```
public WebservicesManager.WsPhylogenyFormat getReturnFormat()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    The expected format of the response.
    
    Specified by:
    
    getReturnFormat in interface PhylogeniesWebserviceClient
    
    Returns:
    
    the expected format of the response
  - getUrl
```
public java.lang.String getUrl()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    Use QUERY_PLACEHOLDER to indicate position of query variable.
    
    Specified by:
    
    getUrl in interface PhylogeniesWebserviceClient
    
    Returns:
    
    the URL
  - isQueryInteger
```
public boolean isQueryInteger()
```
    Description copied from interface: PhylogeniesWebserviceClient
    
    Is the query a number?
    
    Specified by:
    
    isQueryInteger in interface PhylogeniesWebserviceClient
    
    Returns:

Class BasicPhylogeniesWebserviceClient

Field Summary

Fields inherited from interface org.forester.archaeopteryx.webservices.PhylogeniesWebserviceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicPhylogeniesWebserviceClient

Method Detail

getDescription

getInstructions

getMenuName

getName

getNodeField

getProcessingInstructions

getReference

getReturnFormat

getUrl

isQueryInteger