Add the EPNTAP interface.

Nathanael Jourdane
1 parent ccd40d6d
Showing 2 changed files with 87 additions and 33 deletions Show diff stats
src/main/java/eu/omp/irap/vespa/epntapclient/EPNTAPInterface.java
src/main/java/eu/omp/irap/vespa/epntapclient/view/Event.java
@@ -0,0 +1,87 @@
+/*
+ * This file is a part of EpnTAPClient.
+ * This program aims to provide EPN-TAP support for software clients, like CASSIS spectrum analyzer.
+ * See draft specifications: https://voparis-confluence.obspm.fr/pages/viewpage.action?pageId=559861
+ * Copyright (C) 2016 Institut de Recherche en Astrophysique et Planétologie.
+ *
+ * This program is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or (at your option) any later
+ * version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details. You should have received a copy of
+ * the GNU General Public License along with this program. If not, see
+ * <http://www.gnu.org/licenses/>.
+ */
+
+package eu.omp.irap.vespa.epntapclient;
+
+import java.util.List;
+
+/**
+ * @author N. Jourdane
+ */
+public interface EPNTAPInterface {
+
+	/** returns a set of VOResource elements (one per EPN-TAP service) */
+	void getEPNVOResources();
+
+	/**
+	 * Returns a set of VOREsource elements (one per EPN-TAP service corresponding to the
+	 * keywords).The way keywords are defined is still to be defined.
+	 */
+	void getEPNVOResources(List<String> keywords);
+
+	/** returns the VOResource element of the service identified by the ivoID. */
+	void getEPNVOresource(String ivoid);
+
+	/**
+	 * returns a VOTable containing the list of EPN-TAP services and their attributes (from a
+	 * predefined list)
+	 */
+	void getEPNServices();
+
+	/**
+	 * returns a VOTable containing the list of EPN-TAP services and their attributes (from the list
+	 * of attributes)
+	 */
+	void getEPNServices(List<String> attributes);
+
+	/**
+	 * returns a VOTable containing the list of EPN-TAP services corresponding to the keywords and
+	 * their attributes (from the list of attributes)
+	 */
+	void getEPNServices(List<String> keywords, List<String> attributes);
+
+	/**
+	 * returns a VOTable containing the attributes of the corresponding service (from a predefined
+	 * list)
+	 */
+	void getEPNService(String ivoID);
+
+	/**
+	 * returns a VOTable containing the attributes of the corresponding service (from the list of
+	 * attributes)
+	 */
+	void getEPNService(String ivoID, List<String> attributes);
+
+	/** returns the name of the EPNCore Table related to a service. */
+	void getEPNCoreTableName(String service_ivoid);
+
+	/** returns the Access URL of an EPN-TAP Service. */
+	void getTAPURL(String service_ivoid);
+
+	/**
+	 * returns the list of granules which are compliant with the ADQL Query, in VOTable format .
+	 * TAPURL is build from elements taken in VOResource. "ADQLQuery" is created by the Client. It
+	 * is a full query containing the name of the EPNCore table, taken in VOResource.
+	 */
+	void sendADQLQuery(String TAPURL, String ADQLQuery);
+
+	/**
+	 * returns the list of granules which are compliant with the Query, in VOTable format. "Query"
+	 * is not an ADQL query. It is taken from a list of predefined queries. This list must be
+	 * created.
+	 */
+	void sendQuery(String TAPURL, String schema_name, String Query);
+}
@@ -1,33 +0,0 @@
-/*
- * This file is a part of EpnTAPClient.
- * This program aims to provide EPN-TAP support for software clients, like CASSIS spectrum analyzer.
- * See draft specifications: https://voparis-confluence.obspm.fr/pages/viewpage.action?pageId=559861
- * Copyright (C) 2016 Institut de Recherche en Astrophysique et Planétologie.
- *
- * This program is free software: you can
- * redistribute it and/or modify it under the terms of the GNU General Public License as published
- * by the Free Software Foundation, either version 3 of the License, or (at your option) any later
- * version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
- * PURPOSE. See the GNU General Public License for more details. You should have received a copy of
- * the GNU General Public License along with this program. If not, see
- * <http://www.gnu.org/licenses/>.
- */
-
-package eu.omp.irap.vespa.epntapclient.view;
-
-/**
- * @author N. Jourdane
- */
-public enum Event {
-	/** When a service is selected on the service panel. */
-	SERVICE_SELECTED,
-	/** When the `Send query` button is clicked. */
-	SEND_BUTTON_CLICKED,
-	/** When the `Download VOTable` button is clicked. */
-	DOWNLOAD_BUTTON_CLICKED,
-	/** When a parameter is removed on the parameter panel. */
-	PARAMETER_REMOVED,
-	/** When a parameter is updated to a valid value on the parameter panel. */
-	PARAMETER_CHANGED;
-}