EpnTapController.java 6.21 KB
/*
 * 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.controller;

import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import eu.omp.irap.vespa.epntapclient.utils.Queries;
import eu.omp.irap.vespa.epntapclient.view.EpnTapMainView;
import eu.omp.irap.vespa.epntapclient.view.EpnTapMainView.MainViewListener;
import eu.omp.irap.vespa.epntapclient.view.Event;
import eu.omp.irap.vespa.epntapclient.votable.controller.VOTableController;
import eu.omp.irap.vespa.epntapclient.votable.controller.VOTableException;
import eu.omp.irap.vespa.epntapclient.votable.utils.Const;

/**
 * The main controller which manage views and controllers.
 *
 * @author N. Jourdane
 */
public class EpnTapController implements MainViewListener {
	/** The logger for the class EpnTapController. */
	private Logger logger = Logger.getLogger(EpnTapController.class.getName());

	/** The view of EPN-TAP application. */
	private EpnTapMainView mainView;

	/** The controller of the VOTable displaying the list of services. */
	private VOTableController servicesController;

	/** The controller of the VOTable displaying the query results. */
	private VOTableController resultsController;

	/** The name of the table selected by the user on the table list panel. */
	private String selectedTableName;

	/** The URL of the service corresponding to the selected table. */
	private String selectedTableServiceURL;

	/**
	 * The parameters fields for the request.
	 */
	private Map<String, Object> paramValues = new HashMap<>();

	/**
	 * Method constructor, which initialize servicesController, resultsController and mainView.
	 */
	public EpnTapController() {
		servicesController = new VOTableController(Const.DEFAULT_REGISTRY_URL, "ADQL",
				Queries.GET_EPN_TAP_SERVICES);
		resultsController = new VOTableController();

		mainView = new EpnTapMainView(servicesController.getView(), resultsController.getView());
		mainView.addMainViewListener(this);
		updateSelected(0);
	}

	/**
	 * @return the EPN-TAP main view.
	 */
	public EpnTapMainView getView() {
		return mainView;
	}

	/**
	 * @return The controller of the VOTable which displays the result of the query.
	 */
	public VOTableController getResultsController() {
		return resultsController;
	}

	/**
	 * @return The controller of the VOTable which displays the list of services.
	 */
	public VOTableController getServicesController() {
		return servicesController;
	}

	/**
	 * Update the row selected by the user on the Services Panel.
	 *
	 * @param row The row selected by the user on the Jtable.
	 */
	public void updateSelected(int row) {
		String serviceURL = mainView.getServicesPanel().getServiceURL(row);
		String tableName = mainView.getServicesPanel().getTableName(row);
		if (!tableName.equals(selectedTableName)) {
			selectedTableServiceURL = serviceURL;
			selectedTableName = tableName;
			updateQueryArea();
			logger.info("Selected table: " + selectedTableName + " - service: "
					+ selectedTableServiceURL);
		}
	}

	/**
	 * Remove a query parameter from the parameters list.
	 *
	 * @param paramName The name of the parameter as described in REG-TAP specifications.
	 */
	public void removeParameter(String paramName) {
		paramValues.remove(paramName);
		updateQueryArea();
		logger.info("removed " + paramName);
	}

	/**
	 * Update a query parameter in the parameter list.
	 *
	 * @param paramName The name of the parameter as described in REG-TAP specifications.
	 * @param value The value of the parameter to update.
	 */
	public void updateParameter(String paramName, Object value) {
		paramValues.put(paramName, value);
		updateQueryArea();
		logger.info("uploaded " + paramName + ": " + value);
	}

	/**
	 * Update the query area with a working ADQL query, based on the parameters list.
	 */
	private void updateQueryArea() {
		String query = Queries.getQuery(selectedTableName, paramValues, 10);
		mainView.getRequestPanel().updateQueryArea(query);
	}

	/**
	 * Send a query to the selected service on the services panel.
	 *
	 * @param query The query to send to the selected service.
	 * @throws VOTableException Can not fill the Table
	 */
	public void sendQuery(String query) throws VOTableException {
		logger.info("Sending query: " + query + " on " + selectedTableServiceURL);
		resultsController.fillTable(selectedTableServiceURL, "ADQL", query);
	}

	/**
	 * This methods is called each time a graphical event is detected from a view.
	 *
	 * @param event The type of the detected event. @see Event
	 * @param args The possible arguments which comes with the event (ie. a row column).
	 */
	@Override
	public void event(Event event, Object... args) {
		logger.info("new event: " + event.toString());

		try {
			Object object = args[0];
			switch (event) {
			case SERVICE_SELECTED:
				updateSelected(((Integer) args[0]).intValue());
				break;
			case SEND_BUTTON_CLICKED:
				sendQuery((String) object);
				break;
			case PARAMETER_CHANGED:
				updateParameter((String) object, args[1]);
				break;
			case PARAMETER_REMOVED:
				removeParameter((String) object);
				break;
			default:
				logger.warning("Event " + event.toString() + " detected but is not implemented.");
			}
		} catch (Exception e) {
			mainView.displayError("Error", e.getMessage());
			logger.log(Level.WARNING,
					"Exception thrown when " + event.toString() + ": " + e.getMessage(), e);
		}
	}
}