cytoscape.data.webservice
Interface WebServiceClient<S>

Type Parameters:

S - Client stub object. This is service dependent. For example, NCBI's eUtils stub has the class EUtilsServiceSoap.

All Known Implementing Classes:

WebServiceClientImpl, WebServiceClientImplWithGUI

public interface WebServiceClient<S>

Web service client wrapper for Cytoscape.

Usually, developers first use code generator to create Java code from WSDL. The generated code should be wrapped by this interface to be used in Cytoscape framework.

All web service clients must implement this method.

Since:

Cytoscape 2.6

Version:

0.5

Author:

kono

Method Summary

Collection<Method>	getAccessibleMethods() Returns all available methods accessible through client stub.
String	getClientID() Returns client ID.
S	getClientStub() Get client stub object.
WebServiceClientManager.ClientType[]	getClientType() Returns client type.
String	getDescription() Get description for this client.
String	getDisplayName() Returns display name of this client.
ModuleProperties	getProps() Get properties used by the Tunable.
boolean	isCompatibleType(WebServiceClientManager.ClientType ct) Return true if the given ClientType is compatible with this client.
void	setClientStub(S clientStub) Set stub to this client.
void	setDescription(String description) Set description for this service.
void	setProps(ModuleProperties props) Set props used by Tunable.

Method Detail

getClientID

String getClientID()

Returns client ID. This ID should be unique.

Returns:

client ID as String.

getDisplayName

String getDisplayName()

Returns display name of this client. This is more human readable name for this client.

Returns:

display name for this client.

getClientType

WebServiceClientManager.ClientType[] getClientType()

Returns client type. A client can have multiple types. For example, NCBI Client can be used as network import and attribute import, so this array contains both types.

Returns:

Array of client types.

See Also:

WebServiceClientManager.ClientType

isCompatibleType

boolean isCompatibleType(WebServiceClientManager.ClientType ct)

Return true if the given ClientType is compatible with this client. If a client is used as network importer, isCompatibleType(ClientType.NETWORK) returns true, but isCompatibleType(ClientType.ATTRIBUTE) returns false.

Parameters:

ct - Client type.

Returns:

true if compatible.

getClientStub

S getClientStub()

Get client stub object. All services available from this client will be accessed through this stub. This will be used when developer wants to access "raw" API of this service.

Returns:

Client stub. This object type depends on service.

setClientStub

void setClientStub(S clientStub)

Set stub to this client.

Parameters:

stub - client stub used in this client.

getProps

ModuleProperties getProps()

Get properties used by the Tunable.

Returns:

setProps

void setProps(ModuleProperties props)

Set props used by Tunable.

Parameters:

props - Property.

getAccessibleMethods

Collection<Method> getAccessibleMethods()

Returns all available methods accessible through client stub.

Returns:

Collection of methods available through stub.

getDescription

String getDescription()

Get description for this client.

Returns:

Description as a string. Users should write parser for this return value.

setDescription

void setDescription(String description)

Set description for this service.

Parameters:

description - Description as a String.