aphia.v1_0.worms

Interface AphiaNameServicePortType

All Superinterfaces:

Remote

All Known Implementing Classes:

AphiaNameServiceBindingStub

public interface AphiaNameServicePortType
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
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

Method Detail

getAphiaID

int getAphiaID(String scientificname,
             boolean marine_only)
               throws RemoteException

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

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

Throws:

RemoteException

getAphiaRecords

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

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.

Throws:

RemoteException

getAphiaNameByID

String getAphiaNameByID(int aphiaID)
                        throws RemoteException

Get the correct name for a given AphiaID.

Throws:

RemoteException

getAphiaRecordByID

AphiaRecord getAphiaRecordByID(int aphiaID)
                               throws RemoteException

Get the complete Aphia Record for a given AphiaID.

Throws:

RemoteException

getAphiaRecordByTSN

AphiaRecord getAphiaRecordByTSN(int TSN)
                                throws RemoteException

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

Throws:

RemoteException

getAphiaRecordsByNames

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

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.

Throws:

RemoteException

getAphiaRecordsByVernacular

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

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.

Throws:

RemoteException

getAphiaClassificationByID

Classification getAphiaClassificationByID(int aphiaID)
                                          throws RemoteException

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

Throws:

RemoteException

getSourcesByAphiaID

Source[] getSourcesByAphiaID(int aphiaID)
                             throws RemoteException

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

Throws:

RemoteException

getAphiaSynonymsByID

AphiaRecord[] getAphiaSynonymsByID(int aphiaID)
                                   throws RemoteException

Get all synonyms for a given AphiaID.

Throws:

RemoteException

getAphiaVernacularsByID

Vernacular[] getAphiaVernacularsByID(int aphiaID)
                                     throws RemoteException

Get all vernaculars for a given AphiaID.

Throws:

RemoteException

getAphiaChildrenByID

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

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

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

Throws:

RemoteException