org.cytoscape.io.webservice.swing

Class AbstractWebServiceGUIClient

java.lang.Object

org.cytoscape.io.webservice.client.AbstractWebServiceClient

org.cytoscape.io.webservice.swing.AbstractWebServiceGUIClient

All Implemented Interfaces:

WebServiceGUIClient, WebServiceClient

public abstract class AbstractWebServiceGUIClient
extends AbstractWebServiceClient
implements WebServiceGUIClient

Abstract base class for web service clients with Swing GUI.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: webservice-swing-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>webservice-swing-api</artifactId>
</dependency>

Field Summary

Fields

Modifier and Type	Field and Description
protected Container	gui

Constructor Summary

Constructors

Constructor and Description
AbstractWebServiceGUIClient(String uri, String displayName, String description) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Container	getQueryBuilderGUI() Returns query builder UI.

Methods inherited from class org.cytoscape.io.webservice.client.AbstractWebServiceClient

getDescription, getDisplayName, getServiceLocation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cytoscape.io.webservice.WebServiceClient

createTaskIterator

Field Detail

gui

protected Container gui

Constructor Detail

AbstractWebServiceGUIClient

public AbstractWebServiceGUIClient(String uri,
                           String displayName,
                           String description)

Constructor.

Parameters:

uri - A String representation of the URI.

displayName - The display name to be used for this client.

description - The description to be used for this client.

Method Detail

getQueryBuilderGUI

public Container getQueryBuilderGUI()

Returns query builder UI. Since this is a TaskFactory, createTaskIterator() method should use parameters from this GUI.

Specified by:

getQueryBuilderGUI in interface WebServiceGUIClient

Returns:

query builder UI.