Blame view

src/main/java/eu/omp/irap/vespa/epntapclient/granule/GranuleCtrl.java 8.49 KB
cfbb6d07   Nathanael Jourdane   Implement most of...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*
 * 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.granule;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
136293b0   Nathanael Jourdane   When a parsing pr...
24
import java.util.logging.Logger;
cfbb6d07   Nathanael Jourdane   Implement most of...
25

1375d734   Nathanael Jourdane   Create package ep...
26
import eu.omp.irap.vespa.votable.votable.VOTableException.CanNotParseDataException;
cfbb6d07   Nathanael Jourdane   Implement most of...
27
28
29
30
31
32
33
import eu.omp.irap.vespa.votable.votabledata.VOTableData;

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

136293b0   Nathanael Jourdane   When a parsing pr...
34
35
36
	/** The logger for the class GranuleCtrl. */
	private static final Logger LOGGER = Logger.getLogger(GranuleCtrl.class.getName());

30e4599b   Nathanael Jourdane   Add Javadoc
37
	/** The data to parse */
cfbb6d07   Nathanael Jourdane   Implement most of...
38
39
	private VOTableData data;

cfbb6d07   Nathanael Jourdane   Implement most of...
40

30e4599b   Nathanael Jourdane   Add Javadoc
41
42
43
44
45
	/**
	 * Constructor of GranuleCtrl
	 *
	 * @param data The VOTable data to parse.
	 */
cfbb6d07   Nathanael Jourdane   Implement most of...
46
47
48
49
	public GranuleCtrl(VOTableData data) {
		this.data = data;
	}

30e4599b   Nathanael Jourdane   Add Javadoc
50
	/**
30e4599b   Nathanael Jourdane   Add Javadoc
51
52
53
54
	 * Get a Granule object from a VOTable data row.
	 *
	 * @param rowId the row identified
	 * @return the granule at the position rowId in the VOTable data.
1f971475   Nathanael Jourdane   Granule parsing: ...
55
	 * @throws CanNotParseDataException The column name was not found in the list.
30e4599b   Nathanael Jourdane   Add Javadoc
56
	 */
fd1d4872   Nathanael Jourdane   Immplement unit t...
57
	public Granule getGranuleFromVOTableRow(int rowId) throws CanNotParseDataException {
6a2d3842   Nathanael Jourdane   Use getters and s...
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
		//@noformat
		Granule g = new Granule(parseString(rowId, GranuleEnum.GRANULE_UID));
		g.setGranuleGid(parseString(rowId, GranuleEnum.GRANULE_GID));
		g.setObsId(parseString(rowId, GranuleEnum.OBS_ID));
		g.setDataproductType(parseString(rowId, GranuleEnum.DATAPRODUCT_TYPE));
		g.setTargetName(parseString(rowId, GranuleEnum.TARGET_NAME));
		g.setTargetClass(parseString(rowId, GranuleEnum.TARGET_CLASS));
		g.setTimeMin(parseDouble(rowId, GranuleEnum.TIME_MIN));
		g.setTimeMax(parseDouble(rowId, GranuleEnum.TIME_MAX));
		g.setTimeSamplingStepMin(parseDouble(rowId, GranuleEnum.TIME_SAMPLING_STEP_MIN));
		g.setTimeSamplingStepMax(parseDouble(rowId, GranuleEnum.TIME_SAMPLING_STEP_MAX));
		g.setTimeExpMin(parseDouble(rowId, GranuleEnum.TIME_EXP_MIN));
		g.setTimeExpMax(parseDouble(rowId, GranuleEnum.TIME_EXP_MAX));
		g.setSpectralRangeMin(parseDouble(rowId, GranuleEnum.SPECTRAL_RANGE_MIN));
		g.setSpectralRangeMax(parseDouble(rowId, GranuleEnum.SPECTRAL_RANGE_MAX));
		g.setTimeSamplingStepMin(parseDouble(rowId, GranuleEnum.TIME_SAMPLING_STEP_MIN));
		g.setTimeSamplingStepMax(parseDouble(rowId, GranuleEnum.TIME_SAMPLING_STEP_MAX));
		g.setSpectralResolutionMin(parseDouble(rowId, GranuleEnum.SPECTRAL_RESOLUTION_MIN));
		g.setSpectralResolutionMax(parseDouble(rowId, GranuleEnum.SPECTRAL_RESOLUTION_MAX));
		g.setC1Min(parseDouble(rowId, GranuleEnum.C1MIN));
		g.setC1Max(parseDouble(rowId, GranuleEnum.C1MAX));
		g.setC2Min(parseDouble(rowId, GranuleEnum.C2MIN));
		g.setC2Max(parseDouble(rowId, GranuleEnum.C2MAX));
		g.setC3Min(parseDouble(rowId, GranuleEnum.C3MIN));
		g.setC3Max(parseDouble(rowId, GranuleEnum.C3MAX));
fd1d4872   Nathanael Jourdane   Immplement unit t...
83
		g.setSRegion(parseString(rowId, GranuleEnum.S_REGION));
6a2d3842   Nathanael Jourdane   Use getters and s...
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
		g.setC1ResolMin(parseDouble(rowId, GranuleEnum.C1_RESOL_MIN));
		g.setC1ResolMax(parseDouble(rowId, GranuleEnum.C1_RESOL_MAX));
		g.setC2ResolMin(parseDouble(rowId, GranuleEnum.C2_RESOL_MIN));
		g.setC2ResolMax(parseDouble(rowId, GranuleEnum.C2_RESOL_MAX));
		g.setC3ResolMin(parseDouble(rowId, GranuleEnum.C3_RESOL_MIN));
		g.setC3ResolMax(parseDouble(rowId, GranuleEnum.C3_RESOL_MAX));
		g.setSpatialFrameType(parseString(rowId, GranuleEnum.SPATIAL_FRAME_TYPE));
		g.setIncidenceMin(parseDouble(rowId, GranuleEnum.INCIDENCE_MIN));
		g.setIncidenceMax(parseDouble(rowId, GranuleEnum.INCIDENCE_MAX));
		g.setEmergenceMin(parseDouble(rowId, GranuleEnum.EMERGENCE_MIN));
		g.setEmergenceMax(parseDouble(rowId, GranuleEnum.EMERGENCE_MAX));
		g.setPhaseMin(parseDouble(rowId, GranuleEnum.PHASE_MIN));
		g.setPhaseMax(parseDouble(rowId, GranuleEnum.PHASE_MAX));
		g.setInstrumentHostName(parseString(rowId, GranuleEnum.INSTRUMENT_HOST_NAME));
		g.setInstrumentName(parseString(rowId, GranuleEnum.INSTRUMENT_NAME));
		g.setMeasurementType(parseString(rowId, GranuleEnum.MEASUREMENT_TYPE));
30e4599b   Nathanael Jourdane   Add Javadoc
100
		g.setProcessingLevel(parseInteger(rowId, GranuleEnum.PROCESSING_LEVEL));
6a2d3842   Nathanael Jourdane   Use getters and s...
101
102
103
104
		g.setCreationDate(parseDate(rowId, GranuleEnum.CREATION_DATE));
		g.setModificationDate(parseDate(rowId, GranuleEnum.MODIFICATION_DATE) );
		g.setReleaseDate(parseDate(rowId, GranuleEnum.RELEASE_DATE) );
		g.setServiceTitle(parseString(rowId, GranuleEnum.SERVICE_TITLE));
136293b0   Nathanael Jourdane   When a parsing pr...
105
106
107
108
109
        g.setAccessUrl(parseString(rowId, GranuleEnum.ACCESS_URL));
        g.setAccessFormat(parseString(rowId, GranuleEnum.ACCESS_FORMAT));
        g.setThumbnailUrl(parseString(rowId, GranuleEnum.THUMBNAIL_URL));
        g.setAccessEstsize(parseInteger(rowId, GranuleEnum.ACCESS_ESTSIZE));
        //@format
6a2d3842   Nathanael Jourdane   Use getters and s...
110
111
112
113
114
115
116

		if (!g.isValid()) {
			throw new IllegalArgumentException("One or more EPN parameter is null.");
		}
		return g;
	}

30e4599b   Nathanael Jourdane   Add Javadoc
117
	/**
30e4599b   Nathanael Jourdane   Add Javadoc
118
	 * @return A list of Granules from a VOTable, where each Granule is a row of the VOTable data.
fd1d4872   Nathanael Jourdane   Immplement unit t...
119
120
	 * @throws CanNotParseDataException If the granule can not be parsed or the column name was not
	 *             found in the list.
30e4599b   Nathanael Jourdane   Add Javadoc
121
	 */
fd1d4872   Nathanael Jourdane   Immplement unit t...
122
	public List<Granule> getGranules() throws CanNotParseDataException {
30e4599b   Nathanael Jourdane   Add Javadoc
123
		if (!isV2()) {
fd1d4872   Nathanael Jourdane   Immplement unit t...
124
			throw new CanNotParseDataException(
cfbb6d07   Nathanael Jourdane   Implement most of...
125
126
127
128
					"The EPN-CORE is not v2, which is the only suported version");
		}
		List<Granule> granules = new ArrayList<>();

6a2d3842   Nathanael Jourdane   Use getters and s...
129
		if (data != null) {
b021ed9a   Jean-Michel Glorian   catch the excepti...
130
131
132
			for (int rowId = 0; rowId < data.getNbRows(); rowId++) {
				granules.add(getGranuleFromVOTableRow(rowId));
			}
cfbb6d07   Nathanael Jourdane   Implement most of...
133
134
135
136
		}
		return granules;
	}

45fb4583   Nathanael Jourdane   Sort methods and ...
137
138
139
140
141
142
143
144
145
146
147
148
149
	/**
	 * @return true if the VOTable data implements the EpnCoreV2.
	 */
	public boolean isV2() {
		return !data.isContainingColumnName("index");
	}

	/**
	 * Parse a Date value in the VOTable data at the specified row and column.
	 *
	 * @param rowId The row identifier
	 * @param granule The Granule enumeration, representing the column name.
	 * @return The value as Date.
45fb4583   Nathanael Jourdane   Sort methods and ...
150
151
	 * @throws CanNotParseDataException The column name was not found in the list.
	 */
fd1d4872   Nathanael Jourdane   Immplement unit t...
152
	private Date parseDate(int rowId, GranuleEnum granule) throws CanNotParseDataException {
45fb4583   Nathanael Jourdane   Sort methods and ...
153
154
155
156
		SimpleDateFormat sdf = new SimpleDateFormat("yyyy-mm-dd");
		Date date = new Date();
		try {
			date = sdf.parse((String) data.getCell(rowId, granule.toString()));
136293b0   Nathanael Jourdane   When a parsing pr...
157
158
159
		} catch (ParseException ex) {
			LOGGER.warning(ex.getMessage());
			return new Date();
45fb4583   Nathanael Jourdane   Sort methods and ...
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
		}

		return date;
	}

	/**
	 * Parse a Double value in the VOTable data at the specified row and column.
	 *
	 * @param rowId The row identifier
	 * @param granule The Granule enumeration, representing the column name.
	 * @return The value as Double.
	 * @throws CanNotParseDataException The column name was not found in the list.
	 */
	private Double parseDouble(int rowId, GranuleEnum granule) throws CanNotParseDataException {
		Double d = null;
		Object lObj = data.getCell(rowId, granule.toString());
		if (lObj instanceof Double) {
			d = (Double) lObj;
fd1d4872   Nathanael Jourdane   Immplement unit t...
178
		} else if (lObj instanceof Float) {
45fb4583   Nathanael Jourdane   Sort methods and ...
179
180
			d = new Double((Float) lObj);
		}
45fb4583   Nathanael Jourdane   Sort methods and ...
181
182
183
184
185
186
187
188
189
		return d == null ? Double.NaN : d;
	}

	/**
	 * Parse a Double value in the VOTable data at the specified row and column.
	 *
	 * @param rowId The row identifier
	 * @param granule The Granule enumeration, representing the column name.
	 * @return The value as Double.
45fb4583   Nathanael Jourdane   Sort methods and ...
190
	 */
136293b0   Nathanael Jourdane   When a parsing pr...
191
192
193
194
195
196
197
	private Integer parseInteger(int rowId, GranuleEnum granule) {
		try {
			return (Integer) data.getCell(rowId, granule.toString());
		} catch (CanNotParseDataException ex) {
			LOGGER.warning(ex.getMessage());
			return 0;
		}
45fb4583   Nathanael Jourdane   Sort methods and ...
198
199
200
201
202
203
204
205
	}

	/**
	 * Parse a String value in the VOTable data at the specified row and column.
	 *
	 * @param rowId The row identifier
	 * @param granule The Granule enumeration, representing the column name.
	 * @return The value as String.
45fb4583   Nathanael Jourdane   Sort methods and ...
206
	 */
136293b0   Nathanael Jourdane   When a parsing pr...
207
	private String parseString(int rowId, GranuleEnum granule) {
45fb4583   Nathanael Jourdane   Sort methods and ...
208

136293b0   Nathanael Jourdane   When a parsing pr...
209
210
211
212
213
214
215
		try {
			return (String) data.getCell(rowId, granule.toString());
		} catch (CanNotParseDataException ex) {
			LOGGER.warning(ex.getMessage());
			return null;
		}
	}
cfbb6d07   Nathanael Jourdane   Implement most of...
216
}