Author: kono
Date: 2011-01-19 17:12:20 -0800 (Wed, 19 Jan 2011)
New Revision: 23521
Added:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
Removed:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClientManager.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/CyTableImportTask.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/NetworkImportTask.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/Query.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/SearchTask.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/WebServiceClientTaskFactory.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/ui/
Modified:
core3/webservice-api/trunk/pom.xml
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
Log:
Major update version of web service API. Biomart client still needs some
refactoring to use this new API.
Modified: core3/webservice-api/trunk/pom.xml
===================================================================
--- core3/webservice-api/trunk/pom.xml 2011-01-20 01:12:08 UTC (rev 23520)
+++ core3/webservice-api/trunk/pom.xml 2011-01-20 01:12:20 UTC (rev 23521)
@@ -106,6 +106,11 @@
<artifactId>io-api</artifactId>
<version>3.0.0-alpha2-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.cytoscape</groupId>
+ <artifactId>work-api</artifactId>
+ <version>3.0.0-alpha2-SNAPSHOT</version>
+ </dependency>
<!-- Testing -->
Added:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
(rev 0)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/NetworkImportWebServiceClient.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -0,0 +1,9 @@
+package org.cytoscape.io.webservice;
+
+import java.util.Set;
+
+import org.cytoscape.model.CyNetwork;
+
+public interface NetworkImportWebServiceClient {
+ Set<CyNetwork> getNetworks();
+}
Added:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
(rev 0)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/TableImportWebServiceClient.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -0,0 +1,9 @@
+package org.cytoscape.io.webservice;
+
+import java.util.Set;
+
+import org.cytoscape.model.CyTable;
+
+public interface TableImportWebServiceClient {
+ Set<CyTable> getTables();
+}
Modified:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClient.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -34,8 +34,11 @@
*/
package org.cytoscape.io.webservice;
+import java.awt.Container;
import java.net.URI;
+import org.cytoscape.work.TaskFactory;
+
/**
* Thin wrapper for SOAP/REST web service clients.
*
@@ -46,8 +49,8 @@
* eUtils stub has the class EUtilsServiceSoap.
*
*/
-public interface WebServiceClient<S> {
-
+public interface WebServiceClient extends TaskFactory {
+
/**
* Returns resource location of this service, i.e., service URL.
* This is guaranteed to be globally unique and can be used as
identifier.
@@ -74,17 +77,13 @@
*/
String getDescription();
-
+
/**
- * Get client endpoint 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 query builder UI. Since this is a TaskFactory,
+ * getTaskIterator() method should use parameters from this GUI.
*
- *
- * This is an immutable object.
- *
- * @return Endpoint of the service. This object type depends on service.
+ * @return
*/
- S getClient();
+ Container getQueryBuilderGUI();
}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClientManager.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClientManager.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/WebServiceClientManager.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,33 +0,0 @@
-package org.cytoscape.io.webservice;
-
-import java.net.URI;
-import java.util.Set;
-
-/**
- * Manager object of web service clients.
- *
- * User bundles can access registered web services by injecting this object.
- *
- */
-public interface WebServiceClientManager {
-
- /**
- * Returns all registered services.
- *
- * @return set of all registered web service clients.
- *
- */
- Set<WebServiceClient<?>> getAllClients();
-
-
- /**
- * Get a service client by URI.
- *
- * @param serviceURI Service location as URI.
- *
- * @return registered web service client.
- *
- */
- WebServiceClient<?> getClient(final URI serviceURI);
-
-}
Modified:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/AbstractWebServiceClient.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -34,10 +34,12 @@
*/
package org.cytoscape.io.webservice.client;
+import java.awt.Container;
import java.net.URI;
import java.net.URISyntaxException;
import org.cytoscape.io.webservice.WebServiceClient;
+import org.cytoscape.work.TaskIterator;
@@ -47,21 +49,20 @@
* @param <S> Stub object type. This is service dependent.
*/
-public abstract class AbstractWebServiceClient<S> implements
WebServiceClient<S> {
+public abstract class AbstractWebServiceClient implements WebServiceClient {
// Service locaiton
protected final URI serviceURI;
- // Endpoint
- protected final S clientStub;
-
// Display Name for this client.
private final String displayName;
private final String description;
+
+ // By default, this is null.
+ protected final Container panel = null;
- public AbstractWebServiceClient(final String uri, final String
displayName, final String description,
- final S endpoint) {
+ public AbstractWebServiceClient(final String uri, final String
displayName, final String description) {
// Create URI
try {
@@ -73,7 +74,6 @@
this.displayName = displayName;
this.description = description;
- this.clientStub = endpoint;
}
@@ -92,8 +92,11 @@
return this.serviceURI;
}
+
@Override
- public S getClient() {
- return this.clientStub;
+ public Container getQueryBuilderGUI() {
+ return panel;
}
+
+
}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/CyTableImportTask.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/CyTableImportTask.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/CyTableImportTask.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,21 +0,0 @@
-package org.cytoscape.io.webservice.client;
-
-import java.util.Set;
-
-import org.cytoscape.model.CyTable;
-import org.cytoscape.work.Task;
-
-/**
- * If a client can import key-value pair (attributes), it should implement
this.
- *
- */
-public interface CyTableImportTask extends Task {
-
- /**
- * Send a query to the service and get a set of key-value pairs.
- *
- * @return Set of CyTables created from service call result.
- */
- Set<CyTable> getCyTables();
-
-}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/NetworkImportTask.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/NetworkImportTask.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/NetworkImportTask.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,23 +0,0 @@
-package org.cytoscape.io.webservice.client;
-
-import java.util.Set;
-
-import org.cytoscape.model.CyNetwork;
-import org.cytoscape.work.Task;
-
-
-/**
- * If a client can import networks from service, it should implement this.
- *
- */
-public interface NetworkImportTask extends Task {
-
- /**
- * Send a query to the service and import network(s).
- * Usually, this method creates attributes, too. They are local to
network.
- *
- * @return Set of networks imported.
- *
- */
- Set<CyNetwork> importNetwork();
-}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/Query.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/Query.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/Query.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,19 +0,0 @@
-package org.cytoscape.io.webservice.client;
-
-/**
- * Wrapper interface for arbitrary query objects.
- *
- * If client is JAX-RS based, Query is {@link MultivaluedMap}.
- * Otherwise, it is a class generated from WSDL.
- *
- *
- */
-public interface Query {
-
- /**
- * Get the query as a string.
- *
- * @return String version of query.
- */
- String getQueryAsString();
-}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/SearchTask.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/SearchTask.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/SearchTask.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,12 +0,0 @@
-package org.cytoscape.io.webservice.client;
-
-import org.cytoscape.work.Task;
-
-
-/**
- * All web service clients which have search function should implement this
interface.
- *
- */
-public interface SearchTask<T> extends Task {
- T search();
-}
Deleted:
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/WebServiceClientTaskFactory.java
===================================================================
---
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/WebServiceClientTaskFactory.java
2011-01-20 01:12:08 UTC (rev 23520)
+++
core3/webservice-api/trunk/src/main/java/org/cytoscape/io/webservice/client/WebServiceClientTaskFactory.java
2011-01-20 01:12:20 UTC (rev 23521)
@@ -1,13 +0,0 @@
-package org.cytoscape.io.webservice.client;
-
-import org.cytoscape.work.TaskFactory;
-
-/**
- * Task factory for ALL web service clients.
- * Search/fetch query parameter will be set through this factory.
- *
- */
-public interface WebServiceClientTaskFactory extends TaskFactory {
-
- void setQuery(final Query quqey);
-}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
