SITools2

 /*******************************************************************************

 * Copyright 2010-2013 CNES - CENTRE NATIONAL d'ETUDES SPATIALES

 *

 * This file is part of SITools2.

 *

 * SITools2 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.

 *

 * SITools2 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 SITools2.  If not, see <http://www.gnu.org/licenses/>.

 ******************************************************************************/

package fr.ias.sitools.vo.ssa;

import fr.cnes.sitools.astro.representation.DatabaseRequestModel;

import fr.cnes.sitools.common.SitoolsSettings;

import fr.cnes.sitools.common.application.ContextAttributes;

import fr.cnes.sitools.common.exception.SitoolsException;

import fr.cnes.sitools.dataset.DataSetApplication;

import fr.cnes.sitools.dataset.converter.business.ConverterChained;

import fr.cnes.sitools.dataset.database.DatabaseRequest;

import fr.cnes.sitools.dataset.database.DatabaseRequestFactory;

import fr.cnes.sitools.dataset.database.DatabaseRequestParameters;

import fr.cnes.sitools.dataset.database.common.DataSetExplorerUtil;

import fr.cnes.sitools.dataset.dto.ColumnConceptMappingDTO;

import fr.cnes.sitools.dataset.dto.DictionaryMappingDTO;

import fr.cnes.sitools.dataset.model.Predicat;

import fr.cnes.sitools.dictionary.model.Concept;

import fr.cnes.sitools.plugins.resources.model.ResourceModel;

import fr.cnes.sitools.util.Util;

import freemarker.template.TemplateSequenceModel;

import java.math.BigInteger;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.logging.Level;

import java.util.logging.Logger;

import net.ivoa.xml.votable.v1.AnyTEXT;

import net.ivoa.xml.votable.v1.DataType;

import net.ivoa.xml.votable.v1.Field;

import net.ivoa.xml.votable.v1.Info;

import net.ivoa.xml.votable.v1.Param;

/**

 * Votable response for cone search.

 *

 * @author Jean-Christophe Malapert <jean-christophe.malapert@cnes.fr>

 */

public class SimpleSpectralAccessResponse implements SimpleSpectralAccessDataModelInterface {

  /**

   * Logger.

   */

  private static final Logger LOG = Logger.getLogger(SimpleSpectralAccessResponse.class.getName());

  /**

   * Data model.

   */

  private final transient Map dataModel = new HashMap();

  /**

   * Sitools Settings

   */

  private SitoolsSettings sitoolsSettings = null;

  /**

   * Right Ascenscion.

   */

  private final double ra;

  /**

   * Declination.

   */

  private final double dec;

  /**

   * Time 

   */

  private final String[] time;

  /**

   * Band 

   */

  private final double[] band;

  /**

   * Constructor.

   *

   * @param inputParameters input parameters

   * @param model data model

   */

  public SimpleSpectralAccessResponse(final SimpleSpectralAccessInputParameters inputParameters, final ResourceModel model) {

      this.sitoolsSettings = (SitoolsSettings) inputParameters.getContext().getAttributes().get(ContextAttributes.SETTINGS);

      this.ra = inputParameters.getRa();

      this.dec = inputParameters.getDec();

      this.time= inputParameters.getTime();

      this.band = inputParameters.getBand();

      createResponse(inputParameters, model);

  }

  /**

   * Creates VOTable response.

   *

   * @param inputParameters Input parameters

   * @param model data model

   */

  private void createResponse(final SimpleSpectralAccessInputParameters inputParameters, final ResourceModel model) {

    // createResponse

    final String dictionaryName = model.getParameterByName(SimpleSpectralAccessProtocolLibrary.DICTIONARY).getValue();

    // Set Votable parameters

    setVotableParametersFromConfiguration(dataModel, model);

    // Set Votable resources

    setVotableResource(inputParameters.getDatasetApplication(), inputParameters, model, dictionaryName);

  }

  /**

   * Sets VOTable parameters coming from administration configuration.

   *

   * @param dataModel data model to set

   * @param model parameters from administration

   */

  private void setVotableParametersFromConfiguration(final Map dataModel, final ResourceModel model) {

    final List<Param> params = new ArrayList<Param>();

    //setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.COVERAGE, DataType.CHAR);

    //setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.TEMPORAL, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.INSTRUMENT, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.MAX_FILE_SIZE, DataType.LONG);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.RESPONSIBLE_PARTY, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.SERVICE_NAME, DataType.CHAR);

    //setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.WAVEBAND, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.MAX_RECORDS, DataType.INT);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.MAX_QUERY_SIZE, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.MAX_IMAGE_SIZE, DataType.CHAR);

    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.VERB, DataType.INT);

/* POURQUOI BOOLEAN ?? Alors qu'il peut prendre 0,1,2 ou 3 comme valeurs    setVotableParam(params, model, SimpleSpectralAccessProtocolLibrary.VERB, DataType.BOOLEAN);*/

    if (Util.isSet(params)) {

      dataModel.put("params", params);

    }

  }

  /**

   * Sets Votable Param.

   *

   * @param params List of params

   * @param model data model

   * @param parameterName parameter name

   * @param datatype datatype

   */

  private void setVotableParam(final List<Param> params, final ResourceModel model, final String parameterName,

          final DataType datatype) {

    final String parameterValue = model.getParameterByName(parameterName).getValue();

    if (Util.isNotEmpty(parameterValue)) {

      final Param param = new Param();

      param.setName(parameterName);

      param.setValue(parameterValue);

      param.setDatatype(datatype);

      params.add(param);

    }

  }

  /**

   * Creates the response based on Table.

   *

   * @param datasetApp Dataset application

   * @param inputParameters Input Parameters

   * @param model data model

   * @param dictionaryName Cone search dictionary

   */

  private void setVotableResource(final DataSetApplication datasetApp, final SimpleSpectralAccessInputParameters inputParameters,

          final ResourceModel model, final String dictionaryName) {

    final List<Field> fieldList = new ArrayList<Field>();

    final List<String> columnList = new ArrayList<String>();

    DatabaseRequest databaseRequest = null;

    try {

      // Get the concepts from the dictionary

      List<ColumnConceptMappingDTO> mappingList = getDicoFromConfiguration(datasetApp, dictionaryName);

      mappingList = checkRequiredMapping(mappingList, inputParameters.getVerb());

      // Get query parameters

      final DatabaseRequestParameters dbParams = setQueryParameters(datasetApp, model, inputParameters, mappingList);

      databaseRequest = DatabaseRequestFactory.getDatabaseRequest(dbParams);

      // Execute query

      databaseRequest.createRequest();

      LOG.log(Level.FINEST, "DB request: {0}", databaseRequest.getRequestAsString());

      //Fill the template with query status and param

      fillInfosParamAboutQuery(model);

      // complete data model with fields

      setFields(fieldList, columnList, mappingList);

      dataModel.put("fields", fieldList);

      dataModel.put("sqlColAlias", columnList);

      Map conceptColAlias = new HashMap();

       for (ColumnConceptMappingDTO map:mappingList) {

          conceptColAlias.put(map.getColumnAlias(), map.getConcept().getPropertyFromName("ucd").getValue());

      }

      dataModel.put("mappingColAliasConceptSql", conceptColAlias);

      // Complete data model with data

      final int count = (databaseRequest.getCount() > dbParams.getPaginationExtend()) ? dbParams.getPaginationExtend() : databaseRequest.getCount();

      dataModel.put("nrows", count);

      final ConverterChained converterChained = datasetApp.getConverterChained();

      final TemplateSequenceModel rows = new DatabaseRequestModel(databaseRequest, converterChained);

      ((DatabaseRequestModel) rows).setSize(count);

      dataModel.put("rows", rows);

    } catch (SitoolsException ex) {

      try {

        if (Util.isSet(databaseRequest)) {

          databaseRequest.close();

        }

      } catch (SitoolsException ex1) {

          LOG.log(Level.FINER, null, ex1);

      } finally {

        final List<Info> infos = new ArrayList<Info>();

        LOG.log(Level.FINEST, "ERROR: {0}", ex.getMessage());

        setVotableError(infos, "Query", "Error in query", "Error in input query: " + ex.getMessage());

        if (!infos.isEmpty()) {

          this.dataModel.put("infos", infos);

        }

      }

    }

  }

  /**

   * Set Query parameters to the database.

   *

   * @param datasetApp Dataset Application

   * @param model Data model

   * @param inputParameters Input Parameters

   * @return DatabaseRequestParamerters object

   */

  @SuppressWarnings("empty-statement")

  private DatabaseRequestParameters setQueryParameters(final DataSetApplication datasetApp, final ResourceModel model,

          final SimpleSpectralAccessInputParameters inputParameters, List<ColumnConceptMappingDTO> mappingList) {

    // Get the dataset

    final DataSetExplorerUtil dsExplorerUtil = new DataSetExplorerUtil(datasetApp, inputParameters.getRequest(),

            inputParameters.getContext());

    // Get query parameters

    final DatabaseRequestParameters dbParams = dsExplorerUtil.getDatabaseParams();

    // Get dataset records

    final int nbRecordsInDataSet = datasetApp.getDataSet().getNbRecords();

    // Get max records that is defined by admin

    int nbMaxRecords = Integer.valueOf(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.MAX_RECORDS).getValue());

    nbMaxRecords = (nbMaxRecords > nbRecordsInDataSet || nbMaxRecords == -1) ? nbRecordsInDataSet : nbMaxRecords;

    // Set max records

    dbParams.setPaginationExtend(nbMaxRecords);

    // Create predicat definition   

    String raColTarget = null;

    String decColTarget = null;

    String timeColTarget = null;

    String bandColTarget = null;

    for (ColumnConceptMappingDTO mapIter : mappingList) {

      final String ucd = mapIter.getConcept().getPropertyFromName("ucd").getValue();

      if (ucd.equals(SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.get(1))) {

        raColTarget = mapIter.getColumnAlias();

      }

      if (ucd.equals(SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.get(2))) {

        decColTarget = mapIter.getColumnAlias();

      }

      if (ucd.equals(SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.get(4))) {

        timeColTarget = mapIter.getColumnAlias();

      }

      if (ucd.equals(SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.get(5))) {

        bandColTarget = mapIter.getColumnAlias();

      }

    }

    final AbstractSqlGeometryConstraint sql = SqlGeometryFactory.create(String.valueOf(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.INTERSECT).getValue()));

    sql.setInputParameters(inputParameters);

    String[] geo = null;

    if(!Util.isNotEmpty(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.GEO_ATTRIBUT).getValue())){

        geo = new String[]{raColTarget, decColTarget,timeColTarget,bandColTarget};

    }

    final Object geometry = (Util.isNotEmpty(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.GEO_ATTRIBUT).getValue()))

                      ? model.getParameterByName(SimpleSpectralAccessProtocolLibrary.GEO_ATTRIBUT).getValue()

                      : geo;//Arrays.asList(raColTarget, decColTarget,timeColTarget,bandColTarget);

    //final Object geometry = 

    sql.setGeometry(geometry);

    if (sql.getSqlPredicat() != null) {

      final Predicat predicat = new Predicat();

      predicat.setStringDefinition(sql.getSqlPredicat());

      final List<Predicat> predicatList = dbParams.getPredicats();

      predicatList.add(predicat);

      dbParams.setPredicats(predicatList);

    }

    return dbParams;

  }

  /**

   * Set the votable error.

   *

   * @param infos infos

   * @param id id 

   * @param name name

   * @param value value

   */

  private void setVotableError(final List<Info> infos, final String id, final String name, final String value) {

    if (Util.isNotEmpty(name)) {

      final Info info = new Info();

      info.setID(id);

      info.setName(name);

      info.setValueAttribute(value);

      infos.add(info);

    }

  }

  /**

   * Returns the data model.

   * @return the data model

   */

  @Override

  public final Map getDataModel() {

    return Collections.unmodifiableMap(this.dataModel);

  }

  /**

   * Provide the mapping between SQL column/concept for a given dictionary.

   *

   * @param datasetApp Application where this service is attached

   * @param dicoToFind Dictionary name to find

   * @return Returns a mapping SQL column/Concept

   * @throws SitoolsException No mapping has been done or cannot find the dico

   */

  private List<ColumnConceptMappingDTO> getDicoFromConfiguration(final DataSetApplication datasetApp,

          final String dicoToFind) throws SitoolsException {

    List<ColumnConceptMappingDTO> colConceptMappingDTOList = null;

    // Get the list of dictionnaries related to the datasetApplication

    final List<DictionaryMappingDTO> dicoMappingList = datasetApp.getDictionaryMappings();

    if (!Util.isSet(dicoMappingList) || dicoMappingList.isEmpty()) {

      throw new SitoolsException("No mapping with VO concepts has been done. please contact the administrator");

    }

    // For each dictionary, find the interesting one and return the mapping SQLcolumn/concept

    for (DictionaryMappingDTO dicoMappingIter : dicoMappingList) {

      final String dicoName = dicoMappingIter.getDictionaryName();

      if (dicoToFind.equals(dicoName)) {

        colConceptMappingDTOList = dicoMappingIter.getMapping();

        break;

      }

    }

    return colConceptMappingDTOList;

  }

  /**

   * Set Fields and columnSqlAliasList.

   *

   * @param fieldList List of fields to display on the VOTable

   * @param columnList List of SQL column

   * @param mappingList List of SQL column/concept

   */

  private void setFields(final List<Field> fieldList, final List<String> columnList, final List<ColumnConceptMappingDTO> mappingList) {

    for (ColumnConceptMappingDTO mappingIter : mappingList) {

      String id = null;

      String name = null;

      String ucd = null;

      String utype = null;

      String ref = null;

      String datatype = null;

      String width = null;

      String precision = null;

      String unit = null;

      String type = null;

      String xtype = null;

      String arraysize = null;

      String descriptionValue = null;

      columnList.add(mappingIter.getColumnAlias());

      final Concept concept = mappingIter.getConcept();

      if (concept.getName() != null) {

        name = concept.getName();

      }

      if (concept.getPropertyFromName("ID").getValue() != null) {

        id = concept.getPropertyFromName("ID").getValue();

      }

      if (concept.getPropertyFromName("ucd").getValue() != null) {

        ucd = concept.getPropertyFromName("ucd").getValue();

      }

      if (concept.getPropertyFromName("utype").getValue() != null) {

        utype = concept.getPropertyFromName("utype").getValue();

      }

      if (concept.getPropertyFromName("ref").getValue() != null) {

        ref = concept.getPropertyFromName("ref").getValue();

      }

      if (concept.getPropertyFromName("datatype").getValue() != null) {

        datatype = concept.getPropertyFromName("datatype").getValue();

      }

      if (concept.getPropertyFromName("width").getValue() != null) {

        width = concept.getPropertyFromName("width").getValue();

      }

      if (concept.getPropertyFromName("precision").getValue() != null) {

        precision = concept.getPropertyFromName("precision").getValue();

      }

      if (concept.getPropertyFromName("unit").getValue() != null) {

        unit = concept.getPropertyFromName("unit").getValue();

      }

      if (concept.getPropertyFromName("type").getValue() != null) {

        type = concept.getPropertyFromName("type").getValue();

      }

      if (concept.getPropertyFromName("xtype").getValue() != null) {

        xtype = concept.getPropertyFromName("xtype").getValue();

      }

      if (concept.getPropertyFromName("arraysize").getValue() != null) {

        arraysize = concept.getPropertyFromName("arraysize").getValue();

      }

      if (concept.getDescription() != null) {

        descriptionValue = concept.getDescription();

      }

      final Field field = new Field();

      field.setID(id);

      field.setName(name);

      field.setUcd(ucd);

      field.setUtype(utype);

      field.setRef(ref);

      field.setDatatype(DataType.fromValue(datatype));

      if (width != null) {

        field.setWidth(BigInteger.valueOf(Long.valueOf(width)));

      }

      field.setPrecision(precision);

      field.setUnit(unit);

      field.setType(type);

      field.setXtype(xtype);

      field.setArraysize(arraysize);

      final AnyTEXT anyText = new AnyTEXT();

      anyText.getContent().add(descriptionValue);

      field.setDESCRIPTION(anyText);

      fieldList.add(field);

    }

  }

  /**

   * Checks required mapping and filter columns to map according to VERB.

   *

   * @param mappingList list of mapping defined by the administrator

   * @param verb VERB of Cone search protocol

   * @return Returns the new mapping according to VERB

   * @throws SitoolsException columns with UCD ID_MAIN, POS_EQ_RA_MAIN, POS_EQ_DEC_MAIN must be mapped

   */

  private List<ColumnConceptMappingDTO> checkRequiredMapping(final List<ColumnConceptMappingDTO> mappingList, final int verb)

          throws SitoolsException {

    final int nbConceptToMap = SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.size();

    int nbConcept = 0;

    final List<ColumnConceptMappingDTO> conceptToMap = new ArrayList<ColumnConceptMappingDTO>(mappingList);

    for (ColumnConceptMappingDTO mappingIter : mappingList) {

      final Concept concept = mappingIter.getConcept();

      final String ucdValue = concept.getPropertyFromName("ucd").getValue();

      if (Util.isNotEmpty(ucdValue) && SimpleSpectralAccessProtocolLibrary.REQUIRED_UCD_CONCEPTS.contains(ucdValue)) {

        nbConcept++;

      } else if (verb == 1) {

        conceptToMap.remove(mappingIter);

      }

    }

    if (nbConceptToMap != nbConcept) {

      final StringBuilder buffer = new StringBuilder("columns with ");

      for (ColumnConceptMappingDTO mappingIter : mappingList) {

        buffer.append(mappingIter.getConcept().getName()).append(" ");

      }

      buffer.append("must be mapped");

      throw new SitoolsException(buffer.toString());

    }

    return conceptToMap;

  }

  private void fillInfosParamAboutQuery(final ResourceModel model){

    final List<Info> listQueryInfos = new ArrayList<Info>();

    final Info info = new Info();

    info.setName("QUERY_STATUS");

    info.setValueAttribute("OK");

    listQueryInfos.add(info);

    this.dataModel.put("queryInfos", listQueryInfos);

    final List<Param> listQueryParam = new ArrayList<Param>();

    Param param = new Param();

    param.setName("POS");

    param.setValue(this.ra+","+this.dec);

    param.setUnit("deg");

    param.setDatatype(DataType.DOUBLE);

    listQueryParam.add(param);

//-------------------------- AJOUT POUR LE PROTOCOLE SSA --------------------------------------------

    /*

    param = new Param();

    param.setName("TIME");

    param.setValue(this.time.toString());

    //param.setUnit("");

    param.setDatatype(DataType.CHAR);

    listQueryParam.add(param);

    param = new Param();

    param.setName("BAND");

    param.setValue(this.band.toString());

    param.setUnit("m");

    param.setDatatype(DataType.DOUBLE);

    listQueryParam.add(param);

    */

    addTimeBandAndSize(listQueryParam);

//**************************** FIN DU RAJOUT *********************************

    param = new Param();

    param.setName("FORMAT");

    param.setValue(SimpleSpectralAccessProtocolLibrary.ParamStandardFormat.ALL.name().toLowerCase());

    param.setDatatype(DataType.CHAR);

    param.setArraysize("*");

    listQueryParam.add(param);

    param = new Param();

    param.setName("INTERSECT");

    param.setValue(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.INTERSECT).getValue());

    param.setDatatype(DataType.CHAR);

    listQueryParam.add(param);

    param = new Param();

    param.setName("VERB");

    param.setValue(model.getParameterByName(SimpleSpectralAccessProtocolLibrary.VERB).getValue());

    param.setDatatype(DataType.INT);

    listQueryParam.add(param);

     dataModel.put("queryParams", listQueryParam);

  }

  private List<Param> addTimeBandAndSize(List<Param> listOfParams){

      // ADD TIME

      if(this.time.length == 2){

        Param param = new Param();

        param.setName("TIME");

        param.setValue("From : "+this.time[0]+" to "+this.time[1]);

        param.setDatatype(DataType.CHAR);

        listOfParams.add(param);

      }else{

        Param param = new Param();

        param.setName("TIME");

        param.setValue(this.time[0]);

        param.setDatatype(DataType.CHAR);

        listOfParams.add(param);

      }

      // ADD BAND

      if(this.band.length == 2){

          Double bandMin = this.band[0];

          Double bandMax = this.band[1];

          Param param = new Param();

          param.setName("BAND");

          param.setValue(bandMin.toString()+" , "+bandMax);

          param.setUnit("m");

          param.setDatatype(DataType.DOUBLE);

          listOfParams.add(param);

      }else{

          Double bandValue =  this.band[0];

          Param param = new Param();

          param.setName("BAND");

          param.setValue(bandValue.toString());

          param.setUnit("m");

          param.setDatatype(DataType.DOUBLE);

        listOfParams.add(param);

      }

      // ADD SIZE 

      /*

      if(this.time.length == 2){

        Param param = new Param();

        param.setName("TIME");

        param.setValue("From : "+this.time[0]+" to "+this.time[1]);

        param.setDatatype(DataType.CHAR);

        listOfParams.add(param);

      }else{

        Param param = new Param();

        param.setName("TIME");

        param.setValue(this.time[0]);

        param.setDatatype(DataType.CHAR);

        listOfParams.add(param);

      }*/

      return listOfParams;

  }

}