Blame view

src/main/java/eu/omp/irap/vespa/epntapclient/granule/GranuleCtrl.java 8.11 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;
cfbb6d07   Nathanael Jourdane   Implement most of...
24

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

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

30e4599b   Nathanael Jourdane   Add Javadoc
33
	/** The data to parse */
cfbb6d07   Nathanael Jourdane   Implement most of...
34
35
	private VOTableData data;

cfbb6d07   Nathanael Jourdane   Implement most of...
36

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

30e4599b   Nathanael Jourdane   Add Javadoc
46
	/**
30e4599b   Nathanael Jourdane   Add Javadoc
47
48
49
50
	 * 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: ...
51
	 * @throws CanNotParseDataException The column name was not found in the list.
30e4599b   Nathanael Jourdane   Add Javadoc
52
	 */
fd1d4872   Nathanael Jourdane   Immplement unit t...
53
	public Granule getGranuleFromVOTableRow(int rowId) throws CanNotParseDataException {
6a2d3842   Nathanael Jourdane   Use getters and s...
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
		//@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...
79
		g.setSRegion(parseString(rowId, GranuleEnum.S_REGION));
6a2d3842   Nathanael Jourdane   Use getters and s...
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
		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
96
		g.setProcessingLevel(parseInteger(rowId, GranuleEnum.PROCESSING_LEVEL));
6a2d3842   Nathanael Jourdane   Use getters and s...
97
98
99
100
101
102
103
104
105
106
107
108
		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));
		//@format

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

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

6a2d3842   Nathanael Jourdane   Use getters and s...
121
		if (data != null) {
b021ed9a   Jean-Michel Glorian   catch the excepti...
122
123
124
			for (int rowId = 0; rowId < data.getNbRows(); rowId++) {
				granules.add(getGranuleFromVOTableRow(rowId));
			}
cfbb6d07   Nathanael Jourdane   Implement most of...
125
126
127
128
		}
		return granules;
	}

45fb4583   Nathanael Jourdane   Sort methods and ...
129
130
131
132
133
134
135
136
137
138
139
140
141
	/**
	 * @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 ...
142
143
	 * @throws CanNotParseDataException The column name was not found in the list.
	 */
fd1d4872   Nathanael Jourdane   Immplement unit t...
144
	private Date parseDate(int rowId, GranuleEnum granule) throws CanNotParseDataException {
45fb4583   Nathanael Jourdane   Sort methods and ...
145
146
147
148
		SimpleDateFormat sdf = new SimpleDateFormat("yyyy-mm-dd");
		Date date = new Date();
		try {
			date = sdf.parse((String) data.getCell(rowId, granule.toString()));
fd1d4872   Nathanael Jourdane   Immplement unit t...
149
150
151
		} catch (ParseException e) {
			throw new CanNotParseDataException("The date " + granule + " in the row " + rowId
					+ " can not be parsed.", e);
45fb4583   Nathanael Jourdane   Sort methods and ...
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
		}

		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...
170
		} else if (lObj instanceof Float) {
45fb4583   Nathanael Jourdane   Sort methods and ...
171
172
			d = new Double((Float) lObj);
		}
45fb4583   Nathanael Jourdane   Sort methods and ...
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
		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.
	 * @throws CanNotParseDataException The column name was not found in the list.
	 */
	private Integer parseInteger(int rowId, GranuleEnum granule) throws CanNotParseDataException {
		return (Integer) data.getCell(rowId, granule.toString());
	}

	/**
	 * 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.
	 * @throws CanNotParseDataException The column name was not found in the list.
	 */
	private String parseString(int rowId, GranuleEnum granule) throws CanNotParseDataException {
fd1d4872   Nathanael Jourdane   Immplement unit t...
197
		return (String) data.getCell(rowId, granule.toString());
45fb4583   Nathanael Jourdane   Sort methods and ...
198
199
	}

cfbb6d07   Nathanael Jourdane   Implement most of...
200
}