OV-GSO-DC / EpnTAPClient

Commit eda63a5c222199880fc0db4a401a19bf1f4824f5

Authored by Nathanael Jourdane
1 parent 330431b5
Exists in master

Add Javadoc.

Showing 8 changed files with 240 additions and 70 deletions   Show diff stats
Inline Side-by-side
src/main/java/eu/omp/irap/vespa/epntapclient/EpnTapConnection.java
  Diff comments   View file @eda63a5
... ... @@ -96,6 +96,7 @@ public class EpnTapConnection implements EpnTapInterface {
96 96 @Override
97 97 public VOTABLE getEPNServices(List<String> keywords, List<String> attributes)
98 98 throws CantGetVOTableException {
  99 + // TODO: move this code to a new class in ServiceCtrl()
99 100 attributes.add("res_subject");
100 101 String select = StringJoiner.join(attributes);
101 102 List<String> whereList = new ArrayList<>();
... ... @@ -104,7 +105,6 @@ public class EpnTapConnection implements EpnTapInterface {
104 105 }
105 106 String where = StringJoiner.join(whereList, " OR ");
106 107 String query = String.format(Queries.SELECT_TAP_SERVICES_WHERE_SUBJECT, select, where);
107   - // TODO: move this code to a new class in ServiceCtrl()
108 108 return ServiceCtrl.getVoTable(query);
109 109 }
110 110  
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/EpnTapController.java
  Diff comments   View file @eda63a5
... ... @@ -26,7 +26,6 @@ import eu.omp.irap.vespa.epntapclient.service.ServiceCore;
26 26 import eu.omp.irap.vespa.votable.Consts;
27 27 import eu.omp.irap.vespa.votable.controller.CantGetVOTableException;
28 28 import eu.omp.irap.vespa.votable.controller.VOTableController;
29   -import eu.omp.irap.vespa.votable.votabledata.VOTableData;
30 29  
31 30 /**
32 31 * The main controller which manage views and controllers.
... ... @@ -57,9 +56,11 @@ public class EpnTapController {
57 56 String query = String.format(Queries.SELECT_ALL_TAP_SERVICES_WHERE_CORE,
58 57 ServiceCore.EPNCORE);
59 58 servicesCtrl = new VOTableController(Consts.DEFAULT_REGISTRY_URL, query);
60   - VOTableData data = servicesCtrl.getVOTableData();
61 59 }
62 60  
  61 + /**
  62 + * Get the services from the XML path or the targetURL / query.
  63 + */
63 64 public void readServices() {
64 65 try {
65 66 servicesCtrl.readTable();
... ... @@ -68,10 +69,26 @@ public class EpnTapController {
68 69 }
69 70 }
70 71  
  72 + /**
  73 + * display an error with the logger.
  74 + *
  75 + * @param message A small error message.
  76 + * @param e The error.
  77 + */
  78 + @SuppressWarnings("static-method")
71 79 public void displayError(String message, Exception e) {
72 80 logger.log(Level.SEVERE, message, e);
73 81 }
74 82  
  83 + /**
  84 + * Send the query to the specified service.
  85 + *
  86 + * @param query An ADQL query to send.
  87 + * @param tableServiceURL the URL of the service.
  88 + * @return The Path of the VOTable containing the result, downloaded in the system temporary
  89 + * path.
  90 + * @throws CantGetVOTableException Can not get the VOTable.
  91 + */
75 92 public String sendQuery(String query, String tableServiceURL)
76 93 throws CantGetVOTableException {
77 94 resultsCtrl = new VOTableController(tableServiceURL, query);
... ... @@ -93,14 +110,30 @@ public class EpnTapController {
93 110 return servicesCtrl;
94 111 }
95 112  
  113 + /**
  114 + * Update a specified parameter
  115 + *
  116 + * @param paramName The name of the parameter.
  117 + * @param paramValue The new value of the parameter
  118 + */
96 119 public void updateParameter(String paramName, Object paramValue) {
97 120 paramValues.put(paramName, paramValue);
98 121 }
99 122  
  123 + /**
  124 + * Remove a specified parameter.
  125 + *
  126 + * @param paramName the name of the parameter.
  127 + */
100 128 public void removeParameter(String paramName) {
101 129 paramValues.remove(paramName);
102 130 }
103 131  
  132 + /**
  133 + * Get the values of all the parameters.
  134 + *
  135 + * @return A map containing all the values, as couples <key, value>.
  136 + */
104 137 public Map<String, Object> getParamValues() {
105 138 return paramValues;
106 139 }
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/EpnTapGet.java
  Diff comments   View file @eda63a5
... ... @@ -18,7 +18,6 @@ package eu.omp.irap.vespa.epntapclient;
18 18  
19 19 import java.util.HashMap;
20 20 import java.util.Map;
21   -import java.util.logging.Logger;
22 21  
23 22 import com.google.gson.JsonArray;
24 23 import com.google.gson.JsonObject;
... ... @@ -31,9 +30,6 @@ import eu.omp.irap.vespa.votable.utils.Network;
31 30 */
32 31 public class EpnTapGet {
33 32  
34   - /** The logger for the class EpnTapGetQueries. */
35   - private static final Logger logger = Logger.getLogger(EpnTapGet.class.getName());
36   -
37 33 /** The URL of the resolver used for the `target name` field. */
38 34 private static final String RESOLVER_URL = "http://voparis-registry.obspm.fr/ssodnet/1/autocomplete";
39 35  
... ... @@ -43,8 +39,7 @@ public class EpnTapGet {
43 39 *
44 40 * @param begining The beginning of the target_name.
45 41 * @return An array of Strings corresponding to the target names got.
46   - * @throws CantSendQueryException
47   - * @throws CantGetXMLException If the resolver do not work.
  42 + * @throws CantSendQueryException Can not send the query to get the target names.
48 43 */
49 44 public static String[] getTargetNames(String begining) throws CantSendQueryException {
50 45 Map<String, String> params = new HashMap<>();
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/EpnTapInterface.java
  Diff comments   View file @eda63a5
... ... @@ -19,6 +19,7 @@ package eu.omp.irap.vespa.epntapclient;
19 19 import java.util.List;
20 20  
21 21 import eu.omp.irap.vespa.epntapclient.granule.Granule;
  22 +import eu.omp.irap.vespa.epntapclient.granule.GranuleEnum;
22 23 import eu.omp.irap.vespa.epntapclient.voresource.VOResourceException;
23 24 import eu.omp.irap.vespa.epntapclient.voresource.model.Resource;
24 25 import eu.omp.irap.vespa.epntapclient.votable.model.VOTABLE;
... ... @@ -31,17 +32,36 @@ public interface EpnTapInterface {
31 32  
32 33 // *** Resource ***
33 34  
34   - /** returns the VOResource element of the service identified by the ivoID. */
  35 + /**
  36 + * Returns the VOResource element of the service identified by the ivoID.
  37 + *
  38 + * @param ivoid the ivoid of the service.
  39 + * @return The Resource of a service corresponding to the ivoid
  40 + * @throws VOResourceException Can not get the VOResource.
  41 + */
35 42 public Resource getEPNVOresource(String ivoid) throws VOResourceException;
36 43  
37 44 // *** Resources ***
38 45  
39   - /** returns a set of VOResource elements (one per EPN-TAP service) */
  46 + /**
  47 + * Returns a set of VOResource elements (one per EPN-TAP service).
  48 + *
  49 + * @return A list containing the VOResources of all EpnTap services.
  50 + * @throws VOResourceException Can not get the VOResource.
  51 + */
40 52 public List<Resource> getEPNVOResources() throws VOResourceException;
41 53  
42 54 /**
43 55 * Returns a set of VOREsource elements (one per EPN-TAP service corresponding to the keywords).
44 56 * The way keywords are defined is still to be defined.
  57 + *
  58 + * @param keywords A list of keywords, which are the content of the *subject* JSON node in the
  59 + * query.
  60 + * @see <a href=
  61 + * "http://voparis-registry.obspm.fr/vo/ivoa/1/voresources/search?keywords=standardid:%22ivo://ivoa.net/std/TAP%22%20subjects:%22Spectroscopy%22&max=100">
  62 + * this example request</a>
  63 + * @return A list containing the selected VOResources.
  64 + * @throws VOResourceException Can not get the VOResource.
45 65 */
46 66 public List<Resource> getEPNVOResources(List<String> keywords)
47 67 throws VOResourceException;
... ... @@ -49,55 +69,58 @@ public interface EpnTapInterface {
49 69 // *** Service ***
50 70  
51 71 /**
52   - * returns a VOTable containing the attributes of the corresponding service (from a predefined
53   - * list)
  72 + * Returns a VOTable containing the attributes of the corresponding service (from a predefined
  73 + * list).
54 74 *
55   - * @throws VOResourceException
56   - * @throws CantGetVOTableException
57   - * @throws IllegalAccessException
58   - * @throws CantGetXMLException
59   - * @throws CantDisplayVOTableException
  75 + * @param ivoid The ivoid of the service to get.
  76 + * @return A VOTable containing the service.
  77 + * @throws CantGetVOTableException Can not get the VOTable.
60 78 */
61   - public VOTABLE getEPNService(String ivoID) throws CantGetVOTableException;
  79 + public VOTABLE getEPNService(String ivoid) throws CantGetVOTableException;
62 80  
63 81 /**
64   - * returns a VOTable containing the attributes of the corresponding service (from the list of
65   - * attributes)
  82 + * Returns a VOTable containing the attributes of the corresponding service (from the list of
  83 + * attributes).
66 84 *
67   - * @throws VOResourceException
68   - * @throws CantGetVOTableException
69   - * @throws CantGetXMLException
70   - * @throws CantDisplayVOTableException
  85 + * @param ivoid The ivoid of the service to get.
  86 + * @param attributes A list of attributes, which are the column names to get.
  87 + * @return A VOTable containing the service.
  88 + * @see GranuleEnum The EpnTapv2 column names.
  89 + * @throws CantGetVOTableException Can not get the VOTable.
71 90 */
72   - public VOTABLE getEPNService(String ivoID, List<String> attributes)
  91 + public VOTABLE getEPNService(String ivoid, List<String> attributes)
73 92 throws CantGetVOTableException;
74 93  
75 94 // *** Services ***
76 95  
77 96 /**
78   - * returns a VOTable containing the list of EPN-TAP services and their attributes (from a
79   - * predefined list)
  97 + * Returns a VOTable containing the list of EPN-TAP services and their attributes (from a
  98 + * predefined list).
80 99 *
81   - * @throws CantGetXMLException
82   - * @throws CantDisplayVOTableException
  100 + * @return A VOTable containing the services.
  101 + * @throws CantGetVOTableException Can not get the VOTable.
83 102 */
84 103 public VOTABLE getEPNServices() throws CantGetVOTableException;
85 104  
86 105 /**
87   - * returns a VOTable containing the list of EPN-TAP services and their attributes (from the list
  106 + * Returns a VOTable containing the list of EPN-TAP services and their attributes (from the list
88 107 * of attributes)
89 108 *
90   - * @throws CantGetXMLException
91   - * @throws CantDisplayVOTableException
  109 + * @param attributes A list of attributes, which are the column names to get.
  110 + * @return A VOTable containing the services.
  111 + * @throws CantGetVOTableException Can not get the VOTable.
92 112 */
93 113 public VOTABLE getEPNServices(List<String> attributes) throws CantGetVOTableException;
94 114  
95 115 /**
96   - * returns a VOTable containing the list of EPN-TAP services corresponding to the keywords and
97   - * their attributes (from the list of attributes)
  116 + * Returns a VOTable containing the list of EPN-TAP services corresponding to the keywords and
  117 + * their attributes (from the list of attributes).
98 118 *
99   - * @throws CantGetXMLException
100   - * @throws CantDisplayVOTableException
  119 + * @param keywords A list of keywords, which are the *res_subject* column content of the table
  120 + * rr.res_subject of a registry.
  121 + * @param attributes A list of attributes, which are the column names to get.
  122 + * @return A VOTable containing the services.
  123 + * @throws CantGetVOTableException Can not get the VOTable.
101 124 */
102 125 public VOTABLE getEPNServices(List<String> keywords, List<String> attributes)
103 126 throws CantGetVOTableException;
... ... @@ -105,38 +128,48 @@ public interface EpnTapInterface {
105 128 // *** Getters ***
106 129  
107 130 /**
108   - * returns the name of the EPNCore Table related to a service.
  131 + * Returns the name of the EPNCore Table related to a service.
109 132 *
110   - * @throws CantGetXMLException
111   - * @throws CantDisplayVOTableException
  133 + * @param ivoid The ivoid of the service.
  134 + * @return The table name of the service, used usually in the 'FROM' keyword in a ADQL query.
  135 + * @throws CantGetVOTableException Can not get the VOTable.
112 136 */
113 137 public String getEPNCoreTableName(String ivoid) throws CantGetVOTableException;
114 138  
115 139 /**
116   - * returns the Access URL of an EPN-TAP Service.
  140 + * Returns the Access URL of an EPN-TAP Service.
117 141 *
118   - * @throws CantGetXMLException
119   - * @throws CantDisplayVOTableException
  142 + * @param ivoid the ivoid of the service.
  143 + * @return The target URL of the service, used usually to process requests on it.
  144 + * @throws CantGetVOTableException Can not get the VOTable.
120 145 */
121 146 public String getTAPURL(String ivoid) throws CantGetVOTableException;
122 147  
123 148 // *** Queries ***
124 149  
125 150 /**
126   - * returns the list of granules which are compliant with the ADQL Query, in VOTable format .
  151 + * Returns the list of granules which are compliant with the ADQL Query, in VOTable format .
127 152 * TAPURL is build from elements taken in VOResource. "ADQLQuery" is created by the Client. It
128 153 * is a full query containing the name of the EPNCore table, taken in VOResource.
129 154 *
130   - * @throws CantGetXMLException
131   - * @throws CantDisplayVOTableException
  155 + * @param tapURL The URL of the service.
  156 + * @param adqlQuery The ADQL query.
  157 + * @return A list of Granules resulting the query.
  158 + * @throws CantGetVOTableException Can not get the VOTable.
132 159 */
133 160 public List<Granule> sendADQLQuery(String tapURL, String adqlQuery)
134 161 throws CantGetVOTableException;
135 162  
136 163 /**
137   - * returns the list of granules which are compliant with the Query, in VOTable format. "Query"
  164 + * Returns the list of granules which are compliant with the Query, in VOTable format. "Query"
138 165 * is not an ADQL query. It is taken from a list of predefined queries. This list must be
139 166 * created.
  167 + *
  168 + * @param tapURL The URL of the service.
  169 + * @param schemaName The name of the service schema.
  170 + * @param query The query, from a list a predefined queries.
  171 + * @return A list of granules resulting the query.
  172 + * @throws CantGetVOTableException Can not get the VOTable.
140 173 */
141 174 public List<Granule> sendQuery(String tapURL, String schemaName, Query query)
142 175 throws CantGetVOTableException;
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/EpnTapMainApp.java
  Diff comments   View file @eda63a5
... ... @@ -23,8 +23,8 @@ import javax.swing.SwingUtilities;
23 23  
24 24 import com.google.gson.Gson;
25 25  
26   -import eu.omp.irap.vespa.epntapclient.gui.mainPanel.MainPanelView;
27 26 import eu.omp.irap.vespa.epntapclient.gui.mainPanel.MainPanelController;
  27 +import eu.omp.irap.vespa.epntapclient.gui.mainPanel.MainPanelView;
28 28  
29 29 /**
30 30 * Simple class to have a main function to launch the EPNTap client.
... ... @@ -36,6 +36,7 @@ public class EpnTapMainApp {
36 36 /** The logger for the class EpnTapMainApp. */
37 37 private static final Logger logger = Logger.getLogger(EpnTapMainApp.class.getName());
38 38  
  39 + /** Error message when the user put a wrong command. */
39 40 private static final String WRONG_COMMAND = "Usage: EpnTapMainApp";
40 41  
41 42  
... ... @@ -60,6 +61,13 @@ public class EpnTapMainApp {
60 61 SwingUtilities.invokeLater(EpnTapMainApp.run(guiCtrl.getView(), "EPN-TAP client"));
61 62 }
62 63  
  64 + /**
  65 + * Creates runnable used to run the application GUI.
  66 + *
  67 + * @param voTableView The VOTable main view, created by the controller.
  68 + * @param title The title of the application window.
  69 + * @return The runnable.
  70 + */
63 71 private static Runnable run(final MainPanelView voTableView, final String title) {
64 72 return new Runnable() {
65 73  
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/granule/Granule.java
  Diff comments   View file @eda63a5
... ... @@ -23,179 +23,280 @@ import java.util.Date;
23 23 */
24 24 public class Granule {
25 25  
  26 + /** Internal table row index. Unique ID in data service, also in v2. Can be alphanum. */
26 27 public String granuleUid;
27 28  
  29 + /**
  30 + * Common to granules of same type (e.g. same map projection, or geometry data products). Can be
  31 + * alphanum.
  32 + */
28 33 public String granuleGid;
29 34  
  35 + /**
  36 + * Associates granules derived from the same data (e.g. various representations / processing
  37 + * levels). Can be alphanum., may be the ID of original observation.
  38 + */
30 39 public String obsId;
31 40  
  41 + /** Organization of the data product, from enumerated list. */
32 42 public String dataproductType;
33 43  
  44 + /** Standard IAU name of target (from a list related to target class), case sensitive. */
34 45 public String targetName;
35 46  
  47 + /** Type of target, from enumerated list. */
36 48 public String targetClass;
37 49  
  50 + /**
  51 + * Acquisition start time (in JD). UTC measured at time_origin location (default is observer's
  52 + * frame)
  53 + */
38 54 public Double timeMin;
39 55  
  56 + /**
  57 + * Acquisition stop time (in JD). UTC measured at time_origin location (default is observer's
  58 + * frame).
  59 + */
40 60 public Double timeMax;
41 61  
  62 + /** Min time sampling step. */
42 63 public Double timeSamplingStepMin;
43 64  
  65 + /** Max time sampling step. */
44 66 public Double timeSamplingStepMax;
45 67  
  68 + /** Min integration time. */
46 69 public Double timeExpMin;
47 70  
  71 + /** Max integration time. */
48 72 public Double timeExpMax;
49 73  
  74 + /** Min spectral range (frequency). */
50 75 public Double spectralRangeMin;
51 76  
  77 + /** Max spectral range (frequency). */
52 78 public Double spectralRangeMax;
53 79  
  80 + /** Min spectral sampling step. */
54 81 public Double spectralSamplingStepMin;
55 82  
  83 + /** Max spectral sampling step. */
56 84 public Double spectralSamplingStepMax;
57 85  
  86 + /** Min spectral resolution. */
58 87 public Double spectralResolutionMin;
59 88  
  89 + /** Max spectral resolution. */
60 90 public Double spectralResolutionMax;
61 91  
  92 + /** Min of first coordinate. */
62 93 public Double c1Min;
63 94  
  95 + /** Max of first coordinate. */
64 96 public Double c1Max;
65 97  
  98 + /** Min of second coordinate. */
66 99 public Double c2Min;
67 100  
  101 + /** Max of second coordinate. */
68 102 public Double c2Max;
69 103  
  104 + /** Min of third coordinate. */
70 105 public Double c3Min;
71 106  
  107 + /** Max of third coordinate. */
72 108 public Double c3Max;
73 109  
  110 + /** ObsCore-like footprint, assume spatial_coordinate_description. */
74 111 public String sRegion;
75 112  
  113 + /** Min resolution in first coordinate. */
76 114 public Double c1ResolMin;
77 115  
  116 + /** Max resolution in first coordinate. */
78 117 public Double c1ResolMax;
79 118  
  119 + /** Min resolution in second coordinate. */
80 120 public Double c2ResolMin;
81 121  
  122 + /** Max resolution in second coordinate. */
82 123 public Double c2ResolMax;
83 124  
  125 + /** Min resolution in third coordinate. */
84 126 public Double c3ResolMin;
85 127  
  128 + /** Max resolution in third coordinate. */
86 129 public Double c3ResolMax;
87 130  
  131 + /** Flavor of coordinate system, defines the nature of coordinates. From enumerated list. */
88 132 public String spatialFrameType;
89 133  
  134 + /** Min incidence angle (solar zenithal angle). */
90 135 public Double incidenceMin;
91 136  
  137 + /** Max incidence angle (solar zenithal angle). */
92 138 public Double incidenceMax;
93 139  
  140 + /** Min emergence angle. */
94 141 public Double emergenceMin;
95 142  
  143 + /** Max emergence angle. */
96 144 public Double emergenceMax;
97 145  
  146 + /** Min phase angle. */
98 147 public Double phaseMin;
99 148  
  149 + /** Max phase angle. */
100 150 public Double phaseMax;
101 151  
  152 + /** Standard name of the observatory or spacecraft. */
102 153 public String instrumentHostName;
103 154  
  155 + /** Standard name of instrument */
104 156 public String instrumentName;
105 157  
  158 + /** UCD(s) defining the data */
106 159 public String measurementType;
107 160  
  161 + /** CODMAC calibration level in v1 */
108 162 public Integer processingLevel;
109 163  
  164 + /** Date of first entry of this granule */
110 165 public Date creationDate;
111 166  
  167 + /** Date of last modification (used to handle mirroring) */
112 168 public Date modificationDate;
113 169  
  170 + /** */
114 171 public Date releaseDate;
115 172  
  173 + /** */
116 174 public String serviceTitle;
117 175  
  176 + /** */
118 177 public String accessUrl;
119 178  
  179 + /** */
120 180 public String accessFormat;
121 181  
122   - public Integer accessEstsize;
  182 + /** Estimate file size in kbyte (with this spelling) */
  183 + public int accessEstsize;
123 184  
  185 + /**
  186 + * If access_format indicates a detached label, this parameter is mandatory and points to the
  187 + * corresponding data file - both will be handled by the client before samping it to tools or
  188 + * downloading
  189 + */
124 190 public String dataAccessUrl;
125 191  
  192 + /** MD5 Hash for the file when available (real file) */
126 193 public String accessMd5;
127 194  
  195 + /** URL of a thumbnail image with predefined size (png ~200 pix, for use in a client only) */
128 196 public String thumbnailUrl;
129 197  
  198 + /** Name of the data file only, case sensitive */
130 199 public String fileName;
131 200  
  201 + /** Identifies a chemical species, case sensitive */
132 202 public String species;
133 203  
  204 + /** Provides alternative target name if more common (e.g. comets) */
134 205 public String altTargetName;
135 206  
  207 + /** */
136 208 public String targetRegion;
137 209  
  210 + /** */
138 211 public String featureName;
139 212  
  213 + /** Bibcode, doi, or other biblio id, URL */
140 214 public String bibReference;
141 215  
142   - public Double ra;
  216 + /** */
  217 + public double ra;
143 218  
144   - public Double dec;
  219 + /** Declination */
  220 + public double dec;
145 221  
146   - public Double solarLongitudeMin;
  222 + /** Min Solar longitude Ls (location on orbit / season) */
  223 + public double solarLongitudeMin;
147 224  
148   - public Double solarLongitudeMax;
  225 + /** Max Solar longitude Ls (location on orbit / season) */
  226 + public double solarLongitudeMax;
149 227  
150   - public Double localTimeMin;
  228 + /** Local time at observed region */
  229 + public double localTimeMin;
151 230  
152   - public Double localTimeMax;
  231 + /** Local time at observed region */
  232 + public double localTimeMax;
153 233  
154   - public Double targetDistanceMin;
  234 + /** Observer-target distance */
  235 + public double targetDistanceMin;
155 236  
156   - public Double targetDistanceMax;
  237 + /** Observer-target distance */
  238 + public double targetDistanceMax;
157 239  
158   - public Double targetTimeMin;
  240 + /** */
  241 + public double targetTimeMin;
159 242  
160   - public Double targetTimeMax;
  243 + /** */
  244 + public double targetTimeMax;
161 245  
  246 + /** */
162 247 public String particleSpectralType;
163 248  
164   - public Double particleSpectralRangeMin;
  249 + /** */
  250 + public double particleSpectralRangeMin;
165 251  
166   - public Double particleSpectralRangeMax;
  252 + /** */
  253 + public double particleSpectralRangeMax;
167 254  
168   - public Double particleSpectralSamplingStepMin;
  255 + /** */
  256 + public double particleSpectralSamplingStepMin;
169 257  
170   - public Double particleSpectralSamplingStepMax;
  258 + /** */
  259 + public double particleSpectralSamplingStepMax;
171 260  
172   - public Double particleSpectralResolutionMin;
  261 + /** */
  262 + public double particleSpectralResolutionMin;
173 263  
174   - public Double particleSpectralResolutionMax;
  264 + /** */
  265 + public double particleSpectralResolutionMax;
175 266  
  267 + /** Resource publisher */
176 268 public String publisher;
177 269  
  270 + /** ID of specific coordinate system and version */
178 271 public String spatialCoordinateDescription;
179 272  
  273 + /** Defines the frame origin */
180 274 public String spatialOrigin;
181 275  
  276 + /** */
182 277 public String timeOrigin;
183 278  
  279 + /** */
184 280 public String timeScale;
185 281  
186 282  
  283 + /** Private constructor to hide the default public one. */
187 284 private Granule() {
188   -
189 285 }
190 286  
  287 + /**
  288 + * Constructor of Granule
  289 + *
  290 + * @param granuleUid The granule identifier.
  291 + */
191 292 public Granule(String granuleUid) {
192 293 this.granuleUid = granuleUid;
193 294 }
194 295  
195 296 /**
196   - * A Granule is valid if all mandatory parameters are filled.
  297 + * A granule is valid if all mandatory parameters are filled.
197 298 *
198   - * @return
  299 + * @return true if the Granule is valid, false otherwise.
199 300 */
200 301 public boolean isValid() {
201 302 boolean valid = granuleUid != null && granuleGid != null && obsId != null;
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/gui/requestpanel/paramfield/FloatField.java
  Diff comments   View file @eda63a5
... ... @@ -41,7 +41,7 @@ public class FloatField extends ParamField implements TextFieldListener {
41 41 /**
42 42 * Method constructor
43 43 *
44   - * @param mainView The main view of the application.
  44 + * @param viewListener The main view listener of the application.
45 45 * @param paramName The name of the parameter.
46 46 */
47 47 public FloatField(ViewListener viewListener, String paramName) {
... ...
src/main/java/eu/omp/irap/vespa/epntapclient/gui/requestpanel/paramfield/FloatRangeField.java
  Diff comments   View file @eda63a5
... ... @@ -44,7 +44,7 @@ public class FloatRangeField extends ParamField implements TextFieldListener {
44 44 /**
45 45 * Method constructor
46 46 *
47   - * @param mainView The main view of the application.
  47 + * @param viewListener The main view listener of the application.
48 48 * @param paramName The name of the parameter.
49 49 */
50 50 public FloatRangeField(ViewListener viewListener, String paramName) {
... ...