aphia.v1_0

Class AphiaNameServiceBindingStub

java.lang.Object

org.apache.axis.client.Stub

aphia.v1_0.AphiaNameServiceBindingStub

All Implemented Interfaces:

AphiaNameServicePortType, Remote, javax.xml.rpc.Stub

public class AphiaNameServiceBindingStub
extends org.apache.axis.client.Stub
implements AphiaNameServicePortType

Field Summary

Fields inherited from class org.apache.axis.client.Stub

cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AphiaNameServiceBindingStub()
AphiaNameServiceBindingStub(javax.xml.rpc.Service service)
AphiaNameServiceBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
AphiaRecord[]	getAphiaChildrenByID(int aphiaID, int offset) Get the direct children (max.
Classification	getAphiaClassificationByID(int aphiaID) Get the complete classification for one taxon.
int	getAphiaID(String scientificname, boolean marine_only) Get the (first) exact matching AphiaID for a given name. Parameters: marine_only: limit to marine taxa.
String	getAphiaNameByID(int aphiaID) Get the correct name for a given AphiaID.
AphiaRecord	getAphiaRecordByID(int aphiaID) Get the complete Aphia Record for a given AphiaID.
AphiaRecord	getAphiaRecordByTSN(int TSN) Get the Aphia Record for a given TSN (ITIS Taxonomic Serial Number).
AphiaRecord[]	getAphiaRecords(String scientificname, boolean like, boolean fuzzy, boolean marine_only, int offset) Get one or more matching (max.
AphiaRecord[][]	getAphiaRecordsByNames(String[] scientificnames, boolean like, boolean fuzzy, boolean marine_only) For each given scientific name, try to find one or more AphiaRecords. This allows you to match multiple names in one call.
AphiaRecord[]	getAphiaRecordsByVernacular(String vernacular, boolean like, int offset) Get one or more Aphia Records (max.
AphiaRecord[]	getAphiaSynonymsByID(int aphiaID) Get all synonyms for a given AphiaID.
Vernacular[]	getAphiaVernacularsByID(int aphiaID) Get all vernaculars for a given AphiaID.
Source[]	getSourcesByAphiaID(int aphiaID) Get one or more sources/references including links, for one AphiaID

Methods inherited from class org.apache.axis.client.Stub

_getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AphiaNameServiceBindingStub

public AphiaNameServiceBindingStub()
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

AphiaNameServiceBindingStub

public AphiaNameServiceBindingStub(URL endpointURL,
                           javax.xml.rpc.Service service)
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

AphiaNameServiceBindingStub

public AphiaNameServiceBindingStub(javax.xml.rpc.Service service)
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

getAphiaID

public int getAphiaID(String scientificname,
             boolean marine_only)
               throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the (first) exact matching AphiaID for a given name.
Parameters:

• marine_only: limit to marine taxa. Default=true.

Specified by:

getAphiaID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaRecords

public AphiaRecord[] getAphiaRecords(String scientificname,
                            boolean like,
                            boolean fuzzy,
                            boolean marine_only,
                            int offset)
                              throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get one or more matching (max. 50) AphiaRecords for a given name.
Parameters:

• like: add a '%'-sign added after the ScientificName (SQL LIKE function). Default=true.
• fuzzy: fuzzy matching. Default=true.
• marine_only: limit to marine taxa. Default=true.
• offset: starting recordnumber, when retrieving next chunck of (50) records. Default=1.

Specified by:

getAphiaRecords in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaNameByID

public String getAphiaNameByID(int aphiaID)
                        throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the correct name for a given AphiaID.

Specified by:

getAphiaNameByID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaRecordByID

public AphiaRecord getAphiaRecordByID(int aphiaID)
                               throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the complete Aphia Record for a given AphiaID.

Specified by:

getAphiaRecordByID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaRecordByTSN

public AphiaRecord getAphiaRecordByTSN(int TSN)
                                throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the Aphia Record for a given TSN (ITIS Taxonomic Serial Number).

Specified by:

getAphiaRecordByTSN in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaRecordsByNames

public AphiaRecord[][] getAphiaRecordsByNames(String[] scientificnames,
                                     boolean like,
                                     boolean fuzzy,
                                     boolean marine_only)
                                       throws RemoteException

Description copied from interface: AphiaNameServicePortType

For each given scientific name, try to find one or more AphiaRecords.
This allows you to match multiple names in one call. Limited to 500 names at once for performance reasons.
Parameters:

• like: add a '%'-sign after the ScientificName (SQL LIKE function). Default=false.
• fuzzy: fuzzy matching. Default=true.
• marine_only: limit to marine taxa. Default=true.

Specified by:

getAphiaRecordsByNames in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaRecordsByVernacular

public AphiaRecord[] getAphiaRecordsByVernacular(String vernacular,
                                        boolean like,
                                        int offset)
                                          throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get one or more Aphia Records (max. 50) for a given vernacular.
Parameters:

• like: add a '%'-sign before and after the input (SQL LIKE '%vernacular%' function). Default=false.
• offset: starting record number, when retrieving next chunck of (50) records. Default=1.

Specified by:

getAphiaRecordsByVernacular in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaClassificationByID

public Classification getAphiaClassificationByID(int aphiaID)
                                          throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the complete classification for one taxon. This also includes any sub or super ranks.

Specified by:

getAphiaClassificationByID in interface AphiaNameServicePortType

Throws:

RemoteException

getSourcesByAphiaID

public Source[] getSourcesByAphiaID(int aphiaID)
                             throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get one or more sources/references including links, for one AphiaID

Specified by:

getSourcesByAphiaID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaSynonymsByID

public AphiaRecord[] getAphiaSynonymsByID(int aphiaID)
                                   throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get all synonyms for a given AphiaID.

Specified by:

getAphiaSynonymsByID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaVernacularsByID

public Vernacular[] getAphiaVernacularsByID(int aphiaID)
                                     throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get all vernaculars for a given AphiaID.

Specified by:

getAphiaVernacularsByID in interface AphiaNameServicePortType

Throws:

RemoteException

getAphiaChildrenByID

public AphiaRecord[] getAphiaChildrenByID(int aphiaID,
                                 int offset)
                                   throws RemoteException

Description copied from interface: AphiaNameServicePortType

Get the direct children (max. 50) for a given AphiaID.
Parameters:

• offset: starting record number, when retrieving next chunck of (50) records. Default=1.

Specified by:

getAphiaChildrenByID in interface AphiaNameServicePortType

Throws:

RemoteException