ServiceCtrl.java 6.46 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.service;

import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.xml.datatype.XMLGregorianCalendar;

import eu.omp.irap.vespa.epntapclient.voresource.model.ContentLevel;
import eu.omp.irap.vespa.epntapclient.voresource.model.Creator;
import eu.omp.irap.vespa.epntapclient.voresource.model.Resource;
import eu.omp.irap.vespa.epntapclient.voresource.model.Type;
import eu.omp.irap.vespa.epntapclient.votable.model.Table;
import eu.omp.irap.vespa.epntapclient.votable.model.VOTABLE;
import eu.omp.irap.vespa.votable.Consts;
import eu.omp.irap.vespa.votable.controller.CantGetVOTableException;
import eu.omp.irap.vespa.votable.controller.VOTableController;
import eu.omp.irap.vespa.votable.utils.StringJoiner;
import eu.omp.irap.vespa.votable.votabledata.VOTableData;
import eu.omp.irap.vespa.votable.votabledata.VOTableDataParser;

/**
 * @author N. Jourdane
 */
public class ServiceCtrl {

	/** The date format used to serialize date parameters. */
	public static final String DATE_FORMAT = "yyyy/MM/dd HH:mm:ss";


	/** Private constructor to hide the implicit public one. */
	private ServiceCtrl() {
	}

	/**
	 * Parse a Resource and returns the corresponding Service.
	 *
	 * @param resource the resource to parse.
	 * @return The corresponding service.
	 */
	public static final Service getService(Resource resource) {
		Service service = new Service(resource.getIdentifier());
		service.setTitle(resource.getTitle());
		service.setShortName(resource.getShortName());
		StringJoiner types = new StringJoiner(", ");
		for (Type type : resource.getContent().getType()) {
			types.add(type.toString());
		}
		service.setType(types.toString());
		service.setDescription(resource.getContent().getDescription());
		StringJoiner creators = new StringJoiner(", ");
		for (Creator creator : resource.getCuration().getCreator()) {
			creators.add(creator.getName().getValue());
		}
		service.setCreator(creators.toString());
		StringJoiner contentLevels = new StringJoiner(", ");
		for (ContentLevel contentLevel : resource.getContent().getContentLevel()) {
			contentLevels.add(contentLevel.value());
		}

		service.setContentLevel(contentLevels.toString());
		service.setReferenceURL(resource.getContent().getReferenceURL());
		service.setCreated(ServiceCtrl.xmlDateToString(resource.getCreated()));
		service.setUpdated(ServiceCtrl.xmlDateToString(resource.getUpdated()));
		return service;
	}

	/**
	 * Parse a VOTableData and returns the corresponding list of services.
	 *
	 * @param data The VOTableData of the service, created by the VOTable parser. Each row of the
	 *            data set is a service.
	 * @return The corresponding list of service.
	 */
	public static final List<Service> getServices(VOTableData data) {
		List<Service> services = new ArrayList<>();
		for (int i = 0; i < data.getNbRows(); i++) {
			Service service = new Service((String) data.getCell(i, "ivoid"));
			service.setTitle((String) data.getCell(i, "res_title"));
			service.setShortName((String) data.getCell(i, "short_name"));
			service.setType((String) data.getCell(i, "content_type"));
			service.setDescription((String) data.getCell(i, "res_description"));
			service.setCreator((String) data.getCell(i, "creator_seq"));
			service.setContentLevel((String) data.getCell(i, "content_level"));
			service.setReferenceURL((String) data.getCell(i, "reference_url"));
			service.setCreated((String) data.getCell(i, "created"));
			service.setUpdated((String) data.getCell(i, "updated"));
			// TODO: Convert date format
			services.add(service);
		}
		return services;
	}

	/**
	 * @param query The query to get the service.
	 * @return The VOTableData
	 * @throws CantGetVOTableException Can not get the VOTable.
	 */
	public static VOTableData getVoTableData(String query) throws CantGetVOTableException {
		return getVoTableData(getVoTable(query));
	}

	/**
	 * Parse a VOTable and returns the corresponding VOTableData.
	 *
	 * @param voTable The VOTable parsed.
	 * @return The corresponding VOTableData.
	 * @throws CantGetVOTableException Can not get the VOTable.
	 */
	public static VOTableData getVoTableData(VOTABLE voTable) throws CantGetVOTableException {
		VOTableController.checkVOTable(voTable);

		Table table = (Table) voTable.getRESOURCE().get(0).getLINKAndTABLEOrRESOURCE().get(0);
		VOTableDataParser dataParser = new VOTableDataParser(table);
		dataParser.parseData();
		return dataParser.getData();
	}

	public static VOTABLE getVoTable(String query) throws CantGetVOTableException {
		VOTableController voTableCtrl = new VOTableController(Consts.DEFAULT_REGISTRY_URL, query);
		voTableCtrl.readTable();
		return voTableCtrl.getVOTable();
	}

	public static Map<String, Object> getParameters(String ivoid, String parameters)
			throws CantGetVOTableException {
		String query = String.format(Queries.SELECT_TAP_SERVICES_WHERE_IVOID, parameters, ivoid);
		return getVoTableData(query).getRowMap(0);
	}

	public static Map<String, Object> getParameters(String ivoid, List<String> parameters)
			throws CantGetVOTableException {
		return getParameters(ivoid, StringJoiner.join(parameters));
	}

	public static Object getParameter(String ivoid, String parameters)
			throws CantGetVOTableException {
		String query = String.format(Queries.SELECT_TAP_SERVICES_WHERE_IVOID, parameters, ivoid);
		return getVoTableData(query).getCell(0, 0);
	}

	private static String xmlDateToString(XMLGregorianCalendar date) {
		SimpleDateFormat sdf = new SimpleDateFormat(ServiceCtrl.DATE_FORMAT);
		return sdf.format(date.toGregorianCalendar().getTime());
	}
}