commit 444c53d90218828c5be7455a0ab736c45ed9d2fe Author: marc nicolas Date: Fri May 22 14:45:08 2015 +0200 adding vo protocol (SIA and Cone Search) dev diff --git a/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/conesearch/ConeSearchInputParameters.java b/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/conesearch/ConeSearchInputParameters.java new file mode 100644 index 0000000..6ed5128 --- /dev/null +++ b/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/conesearch/ConeSearchInputParameters.java @@ -0,0 +1,241 @@ + /******************************************************************************* + * 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 . + ******************************************************************************/ +package fr.cnes.sitools.astro.vo.conesearch; + +import fr.cnes.sitools.dataset.DataSetApplication; +import fr.cnes.sitools.extensions.common.InputsValidation; +import fr.cnes.sitools.extensions.common.NotNullAndNotEmptyValidation; +import fr.cnes.sitools.extensions.common.RangeValidation; +import fr.cnes.sitools.extensions.common.StatusValidation; +import fr.cnes.sitools.extensions.common.Validation; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; +import java.util.logging.Level; +import java.util.logging.Logger; +import net.ivoa.xml.votable.v1.Info; +import org.restlet.Context; +import org.restlet.Request; + +/** + * This object provides methods to handle input parameters for the cone search protocol. + * + * @author Jean-Christophe Malapert + */ +public class ConeSearchInputParameters implements ConeSearchDataModelInterface { + + /** + * Logger. + */ + private static final Logger LOG = Logger.getLogger(ConeSearchInputParameters.class.getName()); + /** + * Default verbosity mode. + */ + private static final int DEFAULT_VERBOSITY_MODE = 0; + /** + * Verbosity mode. + */ + private transient int verb = DEFAULT_VERBOSITY_MODE; + /** + * Data model. + */ + private final transient Map dataModel = new HashMap(); + /** + * User request. + */ + private final transient Request request; + /** + * Application context. + */ + private final transient Context context; + /** + * Application. + */ + private final transient DataSetApplication datasetApp; + /** + * Right ascension of the cone center. + */ + private transient double rightAscension; + /** + * Declination of the cone center. + */ + private transient double declination; + /** + * Radius of the cone. + */ + private transient double radius; + + /** + * Constructor. + * + * @param datasetAppVal dataset application + * @param requestVal Request + * @param contextVal Context + * @param maxSr maxSr for the cone search + * @param verbosity verbosity + * @param verbVal verbosity level + */ + public ConeSearchInputParameters(final DataSetApplication datasetAppVal, final Request requestVal, final Context contextVal, + final double maxSr, final boolean verbosity, final int verbVal) { + this.datasetApp = datasetAppVal; + this.context = contextVal; + this.request = requestVal; + final String raInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(ConeSearchProtocolLibrary.RA); + final String decInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(ConeSearchProtocolLibrary.DEC); + final String srInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(ConeSearchProtocolLibrary.SR); + final String verbInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(ConeSearchProtocolLibrary.VERB); + if(raInput == null && decInput == null && srInput == null){ + Info info = new Info(); + info.setName("QUERY_STATUS"); + info.setValueAttribute("ERROR"); + info.setValue("RA, DEC and SR must be not null"); + final List listInfos = new ArrayList(); + listInfos.add(info); + this.dataModel.put("infos", listInfos); + }else{ + checkInputParameters(raInput, decInput, srInput, maxSr, verbInput, verbosity, verbVal); + } + } + + /** + * Check input parameters. + * + * @param raInput Ra + * @param decInput Dec + * @param srInput Sr + * @param maxSr maxSr + * @param verbosity verbosity + * @param verbInput user inpur verb + * @param verbVal verbosity from admin + */ + private void checkInputParameters(final String raInput, final String decInput, final String srInput, final double maxSr, + final String verbInput, final boolean verbosity, final int verbVal) { + final List infos = new ArrayList(); + final Map validationMap = new HashMap(); + validationMap.put(ConeSearchProtocolLibrary.RA, raInput); + validationMap.put(ConeSearchProtocolLibrary.DEC, decInput); + validationMap.put(ConeSearchProtocolLibrary.SR, srInput); + validationMap.put(ConeSearchProtocolLibrary.VERB, verbInput); + validationMap.put(ConeSearchProtocolLibrary.VERBOSITY, String.valueOf(verbosity)); + Validation validation = new InputsValidation(validationMap); + validation = new RangeValidation(validation, ConeSearchProtocolLibrary.RA, ConeSearchProtocolLibrary.RA_MIN, ConeSearchProtocolLibrary.RA_MAX); + validation = new RangeValidation(validation, ConeSearchProtocolLibrary.DEC, ConeSearchProtocolLibrary.DEC_MIN, ConeSearchProtocolLibrary.DEC_MAX); + validation = new RangeValidation(validation, ConeSearchProtocolLibrary.SR, 0, maxSr); + validation = new NotNullAndNotEmptyValidation(validation, ConeSearchProtocolLibrary.VERBOSITY); + validation = new NotNullAndNotEmptyValidation(validation, ConeSearchProtocolLibrary.VERB, String.valueOf(verbVal)); + final StatusValidation status = validation.validate(); + if (status.isValid()) { + final Map input = validation.getMap(); + this.rightAscension = Double.valueOf(input.get(ConeSearchProtocolLibrary.RA)); + this.declination = Double.valueOf(input.get(ConeSearchProtocolLibrary.DEC)); + this.radius = Double.valueOf(input.get(ConeSearchProtocolLibrary.SR)); + this.verb = Integer.valueOf(input.get(ConeSearchProtocolLibrary.VERB)); + } else { + Info infoError = new Info(); + infoError.setName("QUERY_STATUS"); + infoError.setValueAttribute("ERROR"); + infos.add(infoError); + final Map errors = status.getMessages(); + final Set> entries = errors.entrySet(); + for (Entry entry : entries) { + final Info info = new Info(); + info.setID(entry.getKey()); + info.setName("Error in " + entry.getKey()); + info.setValueAttribute("Error in input " + entry.getKey() + ": " + entry.getValue()); + infos.add(info); + LOG.log(Level.FINEST, "{0}: {1}", new Object[]{entry.getKey(), entry.getValue()}); + } + } + if (!infos.isEmpty()) { + this.dataModel.put("infos", infos); + } + } + + /** + * Get Ra. + * + * @return Ra + */ + public final double getRa() { + return this.rightAscension; + } + + /** + * Get Dec. + * + * @return Dec + */ + public final double getDec() { + return this.declination; + } + + /** + * Get Sr. + * + * @return Sr + */ + public final double getSr() { + return this.radius; + } + + /** + * Get verbosity level. + * + * @return verbosity level + */ + public final int getVerb() { + return this.verb; + } + + @Override + public final Map getDataModel() { + return Collections.unmodifiableMap(this.dataModel); + } + + /** + * Returns the request. + * + * @return Request + */ + public final Request getRequest() { + return this.request; + } + + /** + * Returns the context. + * + * @return Context + */ + public final Context getContext() { + return this.context; + } + + /** + * Get DatasetApplication. + * + * @return Dataset application + */ + public final DataSetApplication getDatasetApplication() { + return this.datasetApp; + } +} \ No newline at end of file diff --git a/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/sia/SimpleImageAccessInputParameters.java b/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/sia/SimpleImageAccessInputParameters.java new file mode 100644 index 0000000..a4c1f7e --- /dev/null +++ b/hesiod/astronmy-extension/src/fr/cnes/sitools/astro/vo/sia/SimpleImageAccessInputParameters.java @@ -0,0 +1,474 @@ + /******************************************************************************* + * 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 . + ******************************************************************************/ +package fr.cnes.sitools.astro.vo.sia; + +import fr.cnes.sitools.dataset.DataSetApplication; +import fr.cnes.sitools.dataset.dto.ColumnConceptMappingDTO; +import fr.cnes.sitools.dictionary.model.Concept; +import fr.cnes.sitools.extensions.common.InputsValidation; +import fr.cnes.sitools.extensions.common.NotNullAndNotEmptyValidation; +import fr.cnes.sitools.extensions.common.NumberArrayValidation; +import fr.cnes.sitools.extensions.common.SpatialGeoValidation; +import fr.cnes.sitools.extensions.common.StatusValidation; +import fr.cnes.sitools.extensions.common.Validation; +import fr.cnes.sitools.plugins.resources.model.ResourceModel; +import fr.cnes.sitools.util.Util; +import java.math.BigInteger; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +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.Option; +import net.ivoa.xml.votable.v1.Param; +import net.ivoa.xml.votable.v1.Values; +import org.restlet.Context; +import org.restlet.Request; + + +/** + * Input parameters for SIA. + * + * @author Jean-Crhistophe Malapert + */ +import fr.cnes.sitools.common.exception.SitoolsException; +import fr.cnes.sitools.dataset.dto.DictionaryMappingDTO; +public class SimpleImageAccessInputParameters implements DataModelInterface { + /** + * Logger. + */ + private static final Logger LOG = Logger.getLogger(SimpleImageAccessInputParameters.class.getName()); + /** + * Init value for right ascension parameter of the user input. + */ + private transient double ra = 0.0; + /** + * Init value for declination parameter of the user input. + */ + private transient double dec = 0.0; + /** + * Array that stores the size parameter of the user input. + */ + private transient double[] size; + /** + * Default value for the verb parameter of the user input. + */ + private transient int verb = 0; + /** + * Data model that stores the metadata response of the service. + */ + private final transient Map dataModel = new HashMap(); + /** + * Request. + */ + private final transient Request request; + /** + * Context. + */ + private final transient Context context; + /** + * Application where this resources is linked. + */ + private final transient DataSetApplication datasetApp; + /** + * Configuration parameters of this resource. + */ + private final transient ResourceModel resourceModel; + + /** + * Constructs the objet that returns the metadata of the service. + * @param datasetAppVal application + * @param requestVal request + * @param contextVal context + * @param resourceModelVal configuration parameters + */ + public SimpleImageAccessInputParameters(final DataSetApplication datasetAppVal, final Request requestVal, final Context contextVal, final ResourceModel resourceModelVal) { + this.datasetApp = datasetAppVal; + this.context = contextVal; + this.request = requestVal; + this.resourceModel = resourceModelVal; + final String posInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(SimpleImageAccessProtocolLibrary.POS); + final String sizeInput = this.request.getResourceRef().getQueryAsForm().getFirstValue(SimpleImageAccessProtocolLibrary.SIZE); + final String format = this.request.getResourceRef().getQueryAsForm().getFirstValue(SimpleImageAccessProtocolLibrary.FORMAT); + final String intersect = this.request.getResourceRef().getQueryAsForm().getFirstValue(SimpleImageAccessProtocolLibrary.INTERSECT); + final String verbosity = this.request.getResourceRef().getQueryAsForm().getFirstValue(SimpleImageAccessProtocolLibrary.VERB); + //TODO check the differentParameters + if(posInput == null && sizeInput == null){ + Info info = new Info(); + info.setName("QUERY_STATUS"); + info.setValueAttribute("ERROR"); + final List listInfos = new ArrayList(); + listInfos.add(info); + this.dataModel.put("infos", listInfos); + if(format.equalsIgnoreCase("METADATA")){ + fillMetadataFormat(); + } + }else{ + if (Util.isSet(format) && format.equals(SimpleImageAccessProtocolLibrary.ParamStandardFormat.METADATA.name())) { + fillMetadataFormat(); + } else { + checkInputParameters(posInput, sizeInput); + } + } + } + + /** + * Fills metadata response. + */ + private void fillMetadataFormat() { + + this.dataModel.put("description", this.resourceModel.getParameterByName(SimpleImageAccessProtocolLibrary.DESCRIPTION).getValue()); + + final Info info = new Info(); + info.setName("QUERY_STATUS"); + info.setValueAttribute("OK"); + final List listInfos = new ArrayList(); + listInfos.add(info); + this.dataModel.put("infos", listInfos); + + final List listParam = new ArrayList(); + Param param = new Param(); + param.setName("INPUT:POS"); + param.setValue("0,0"); + param.setDatatype(DataType.DOUBLE); + AnyTEXT anyText = new AnyTEXT(); + anyText.getContent().add("Search Position in the form ra,dec where ra and dec are given in decimal degrees in the ICRS coordinate system."); + param.setDESCRIPTION(anyText); + listParam.add(param); + + param = new Param(); + param.setName("INPUT:SIZE"); + param.setValue("0.05"); + param.setDatatype(DataType.DOUBLE); + anyText = new AnyTEXT(); + anyText.getContent().add("Size of search region in the RA and Dec directions."); + param.setDESCRIPTION(anyText); + listParam.add(param); + + param = new Param(); + param.setName("INPUT:FORMAT"); + param.setValue(SimpleImageAccessProtocolLibrary.ParamStandardFormat.ALL.name()); + param.setDatatype(DataType.CHAR); + param.setArraysize("*"); + anyText = new AnyTEXT(); + anyText.getContent().add("Requested format of images."); + param.setDESCRIPTION(anyText); + final List formatList = SimpleImageAccessProtocolLibrary.ParamStandardFormat.getCtes(); + final Values values = new Values(); + for (String formatIter : formatList) { + final Option option = new Option(); + option.setValue(formatIter); + values.getOPTION().add(option); + } + param.setVALUES(values); + //TODO : le faire pour chaque format + listParam.add(param); + + param = new Param(); + param.setName("INPUT:INTERSECT"); + param.setValue(this.resourceModel.getParameterByName(SimpleImageAccessProtocolLibrary.INTERSECT).getValue()); + param.setDatatype(DataType.CHAR); + anyText = new AnyTEXT(); + anyText.getContent().add("Choice of overlap with requested region."); + param.setDESCRIPTION(anyText); + listParam.add(param); + + param = new Param(); + param.setName("INPUT:VERB"); + param.setValue(this.resourceModel.getParameterByName(SimpleImageAccessProtocolLibrary.VERB).getValue()); + param.setDatatype(DataType.INT); + anyText = new AnyTEXT(); + anyText.getContent().add("Verbosity level, controlling the number of columns returned."); + param.setDESCRIPTION(anyText); + listParam.add(param); + + dataModel.put("params", listParam); + //****************************************************************************************************************** + //****************************************************************************************************************** + //****************************************************************************************************************** + String dictionaryName = resourceModel.getParameterByName(SimpleImageAccessProtocolLibrary.DICTIONARY).getValue(); + final List columnList = new ArrayList(); + List fieldList = new ArrayList(); + try { + List mappingList = getDicoFromConfiguration(datasetApp, dictionaryName); + setFields(fieldList, columnList, mappingList); + }catch (SitoolsException ex) { + + } + + } + + /** + * Checks input parameters. + * @param posInput input parameter for POS + * @param sizeInput input parameter for SIZE + */ + private void checkInputParameters(final String posInput, final String sizeInput) { + final List infos = new ArrayList(); + final Map validationMap = new HashMap(); + validationMap.put(SimpleImageAccessProtocolLibrary.POS, posInput); + validationMap.put(SimpleImageAccessProtocolLibrary.SIZE, sizeInput); + Validation validation = new InputsValidation(validationMap); + validation = new NotNullAndNotEmptyValidation(validation, SimpleImageAccessProtocolLibrary.POS); + validation = new NotNullAndNotEmptyValidation(validation, SimpleImageAccessProtocolLibrary.SIZE); + if(validation.validate().isValid()){ + validation = new SpatialGeoValidation(validation, SimpleImageAccessProtocolLibrary.POS, 0, 1, new double[]{0.0, 360.0}, new double[]{-90.0, 90.0}); + // LA LIGNE SUIVANTE A ETE AJOUTEE POUR VERIFIER QUE LA SIZE EST BIEN UN ARRAY DE NOMBRE + validation = new NumberArrayValidation(validation, SimpleImageAccessProtocolLibrary.SIZE, ",", 1, 2); + //----------------------------------------------------------------------------------------------- + } + StatusValidation status = validation.validate(); + if (status.isValid()) { + final String pos = validation.getMap().get(SimpleImageAccessProtocolLibrary.POS); + final String[] arrayPos = pos.split(","); + this.ra = Double.valueOf(arrayPos[0]); + this.dec = Double.valueOf(arrayPos[1]); + final String size = validation.getMap().get(SimpleImageAccessProtocolLibrary.SIZE); + final String[] arraySize = size.split(","); + if(arraySize.length == 1) { + this.size = new double[1]; + this.size[0] = Double.valueOf(arraySize[0]); + } else { + this.size = new double[2]; + this.size[0] = Double.valueOf(arraySize[0]); + this.size[1] = Double.valueOf(arraySize[1]); + } + + } else { + Info info = new Info(); + info.setName("QUERY_STATUS"); + info.setValueAttribute("ERROR"); + infos.add(info); + final Map errors = status.getMessages(); + final Set> entries = errors.entrySet(); + for (Map.Entry entry : entries) { + info = new Info(); + info.setID(entry.getKey()); + info.setName("Error in " + entry.getKey()); + info.setValueAttribute("Error in input " + entry.getKey() + ": " + entry.getValue()); + infos.add(info); + LOG.log(Level.FINEST, "{0}: {1}", new Object[]{entry.getKey(), entry.getValue()}); + } + + } + + if (!infos.isEmpty()) { + this.dataModel.put("infos", infos); + } + } + + @Override + public final Map getDataModel() { + return Collections.unmodifiableMap(this.dataModel); + } + + /** + * Get Ra. + * + * @return Ra + */ + public final double getRa() { + return this.ra; + } + + /** + * Get Dec. + * + * @return Dec + */ + public final double getDec() { + return this.dec; + } + + /** + * Get Sr. + * + * @return Sr + */ + public final double[] getSize() { + final double[] copySize = new double[this.size.length]; + System.arraycopy(this.size, 0, copySize, 0, this.size.length); + return copySize; + } + + /** + * Get the request. + * + * @return Request + */ + public final Request getRequest() { + return this.request; + } + + /** + * Get the context. + * + * @return Context + */ + public final Context getContext() { + return this.context; + } + + /** + * Get DatasetApplication. + * + * @return Dataset application + */ + public final DataSetApplication getDatasetApplication() { + return this.datasetApp; + } + + /** + * Get verb. + * @return verb + */ + public final int getVerb() { + return this.verb; + } + + //---------------------------------------------------------------------------- + //---------------------------------------------------------------------------- + //---------------------------------------------------------------------------- + /** + * 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 fieldList, final List columnList, final List 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); + } + dataModel.put("fields", fieldList); + } + + /** + * 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 + */ + protected List getDicoFromConfiguration(final DataSetApplication datasetApp, + final String dicoToFind) throws SitoolsException { + List colConceptMappingDTOList = null; + + // Get the list of dictionnaries related to the datasetApplication + final List 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; + } + + + +}