From ea38350cf00158a493afc571123069fcaaef480d Mon Sep 17 00:00:00 2001 From: masterflorin Date: Sun, 23 Oct 2016 19:25:24 +0300 Subject: [PATCH 1/2] Update and improve method and class specs, javadocs. --- README.md | 2 +- UserGuide.md | 4 +- .../org/istsos/client/DatabaseConnection.java | 54 ++- src/main/java/org/istsos/client/IstSOS.java | 74 +++- .../java/org/istsos/client/Observation.java | 2 +- .../java/org/istsos/client/Procedure.java | 2 +- .../java/org/istsos/client/SamplingTime.java | 9 +- src/main/java/org/istsos/client/Server.java | 73 +++- src/main/java/org/istsos/client/Service.java | 347 +++++++----------- 9 files changed, 311 insertions(+), 256 deletions(-) diff --git a/README.md b/README.md index 79e99a7..a4535bc 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Mentors from istSOS: Mirko Cardoso, Milan Antonovic. ## Release history -* Last updated: 22.08.2016 +* Last updated: 23.10.2016 * Version: 0.1 ## Useful links diff --git a/UserGuide.md b/UserGuide.md index a388cbb..543b167 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -51,8 +51,8 @@ More details about istSOS itself check -> [documentation](http://istsos.org/en/l Important to keep in mind that istSOS Java Core makes use of event listeners, therefore whenever you use a method whether on a e.g. `Service` or `Server` instance you have to use a `IstSOSListener` as a parameter for all methods. -Whenever you develop keep in mind that first the object's configuration must be loaded, thus you can see the use of `IstSOSListener`, -in order to keep the reference of the object. +Whenever you develop keep in mind that first the object's configuration must be loaded, thus you can see the use of `IstSOSListener`, in order to keep the reference of the object. What you need to realize is that istSOS provides `JSON` objects which are turned into `Java` objects thanks to this library. + ## Short note about the structure diff --git a/src/main/java/org/istsos/client/DatabaseConnection.java b/src/main/java/org/istsos/client/DatabaseConnection.java index fc5d4ae..8cd1359 100644 --- a/src/main/java/org/istsos/client/DatabaseConnection.java +++ b/src/main/java/org/istsos/client/DatabaseConnection.java @@ -7,8 +7,8 @@ /** - * Used for creating a connection to a database. Can hold data related - * to dbname, host, user, password, port. + * Used for creating a connection to a database. + * Can hold data related to dbname, host, user, password, port. * Supports conversion to/from JSON. * */ @@ -29,43 +29,73 @@ public class DatabaseConnection implements IstSOSObject{ @SerializedName ("port") private String port; - + /** + * + * @return dbname as String + */ public String getDbname() { return dbname; } - + /** + * + * @param dbname as String + */ public void setDbname(String dbname) { this.dbname = dbname; } - + /** + * + * @return host as String + */ public String getHost() { return host; } - + /** + * + * @param host as String + */ public void setHost(String host) { this.host = host; } - + /** + * + * @return username as String + */ public String getUser() { return user; } - + /** + * + * @param user as String + */ public void setUser(String user) { this.user = user; } - + /** + * + * @return password as String + */ public String getPassword() { return password; } - + /** + * + * @param password as String + */ public void setPassword(String password) { this.password = password; } - + /** + * + * @return port as String + */ public String getPort() { return port; } - + /** + * + * @param port as String + */ public void setPort(String port) { this.port = port; } diff --git a/src/main/java/org/istsos/client/IstSOS.java b/src/main/java/org/istsos/client/IstSOS.java index 8d41e31..a1d958e 100644 --- a/src/main/java/org/istsos/client/IstSOS.java +++ b/src/main/java/org/istsos/client/IstSOS.java @@ -14,7 +14,7 @@ /** * Main class for initializing IstSOS configuration and Server initialization. - * Implements HTTP asynchronous requests to IstSOS environment. + * Contains implementation of HTTP asynchronous requests to IstSOS environment. * */ public class IstSOS{ @@ -26,7 +26,10 @@ public class IstSOS{ private static AsyncHttpClient asyncHttpClient = new DefaultAsyncHttpClient(); private IstSOS() { } - + /** + * Retrieve IstSOS instance + * @return instance as IstSOS object + */ public static IstSOS getInstance() { if (instance == null ) { synchronized (IstSOS.class) { @@ -37,30 +40,59 @@ public static IstSOS getInstance() { } return instance; } - + /** + * Add server object to the collection of servers + * @param name as String + * @param server as Server instance + * @return server added to the collection + */ public Server addServer(String name, Server server) { this.servers.put(name, server); return server; } - + /** + * Initialize a Server with name and url. + * @param name as String + * @param url as String + * @return initialized Server instance + */ public Server initServer(String name, String url) { return this.addServer(name, new Server(name, url)); } - + /** + * Initialize a Server with all parameters. + * @param name as String + * @param url as String + * @param user as String + * @param password as String + * @return initialized Server instance + */ public Server initServer(String name, String url, String user, String password) { return this.addServer(name, new Server(name, url, user, password)); } - + /** + * Retrieve Server from the server collection + * @param name as String + * @return Server instance + */ public Server getServer(String name){ return this.servers.get(name); } - + /** + * Retrieve the collection of servers + * @return Server collection + */ public Collection getServers(){ return this.servers.values(); } - + /** + * Execute GET request to the istSOS platform. + * @param url as String + * @param callback as IstSOSListener + * @param realm as ArrayList + */ protected static void executeGet(String url, final IstSOSListener callback, ArrayList realm){ BoundRequestBuilder builder = asyncHttpClient.prepareGet(url); @@ -103,8 +135,13 @@ public void onThrowable(Throwable t){ }); } - - //post request + /** + * Execute POST request to the istSOS platform. + * @param url as String + * @param data as String + * @param callback as IstSOSListener + * @param realm as ArrayList + */ protected static void executePost(String url, String data, final IstSOSListener callback, ArrayList realm) { BoundRequestBuilder builder = asyncHttpClient.preparePost(url).setBody(data); @@ -149,8 +186,13 @@ public void onThrowable(Throwable t){ } - - //put request + /** + * Execute PUT request to the istSOS platform. + * @param url as String + * @param data as String + * @param callback as IstSOSListener + * @param realm as ArrayList + */ protected static void executePut(String url, String data, final IstSOSListener callback, ArrayList realm) { BoundRequestBuilder builder = asyncHttpClient.preparePut(url).setBody(data); @@ -195,7 +237,13 @@ public void onThrowable(Throwable t){ } - + /** + * Execute DELETE request to istSOS platform. + * @param url as String + * @param data as String + * @param callback as IstSOSListener + * @param realm as ArrayList + */ protected static void executeDelete(String url, String data, final IstSOSListener callback, ArrayList realm){ BoundRequestBuilder builder = asyncHttpClient.prepareDelete(url).setBody(data); diff --git a/src/main/java/org/istsos/client/Observation.java b/src/main/java/org/istsos/client/Observation.java index 81751e9..28b0551 100644 --- a/src/main/java/org/istsos/client/Observation.java +++ b/src/main/java/org/istsos/client/Observation.java @@ -9,7 +9,7 @@ /** * Class for storing observation information such as samplingTime, name, - * procedure, result. Capable of both converting to/from JSON. + * procedure, result. * */ public class Observation implements IstSOSObject{ diff --git a/src/main/java/org/istsos/client/Procedure.java b/src/main/java/org/istsos/client/Procedure.java index d2b026d..3a97b73 100644 --- a/src/main/java/org/istsos/client/Procedure.java +++ b/src/main/java/org/istsos/client/Procedure.java @@ -15,7 +15,7 @@ import org.istsos.client.procedure.Location; /** - * Procedure class. Supports conversion to/from JSON. + * Procedure class. * */ public class Procedure implements IstSOSObject { diff --git a/src/main/java/org/istsos/client/SamplingTime.java b/src/main/java/org/istsos/client/SamplingTime.java index bd29421..8fa3935 100644 --- a/src/main/java/org/istsos/client/SamplingTime.java +++ b/src/main/java/org/istsos/client/SamplingTime.java @@ -8,13 +8,8 @@ import com.google.gson.annotations.SerializedName; /** - * SamplingTime class. - *

- * Handles begin and end positions for time interval in observations. - * Begin and End positions are created as Java Date type object - * of the following format: yyyy-MM-dd'T'HH:mm:ssXX. - *

- * Supports conversion to/from JSON. + * Handles time interval for {@link Observation} using {@link Date} class + * with the following format: yyyy-MM-dd'T'HH:mm:ssXX. * */ @SuppressWarnings("rawtypes") diff --git a/src/main/java/org/istsos/client/Server.java b/src/main/java/org/istsos/client/Server.java index 4a6caa3..ac52a69 100644 --- a/src/main/java/org/istsos/client/Server.java +++ b/src/main/java/org/istsos/client/Server.java @@ -7,10 +7,8 @@ import com.google.gson.JsonObject; /** - * Server class. - *

- * Enables services for IstSOS environment. - * + * Allows storage and retrieval of services. + * Can hold data related to name, url, user, password. */ public class Server{ @@ -23,12 +21,24 @@ public class Server{ private List services = new ArrayList<>(); - + /** + * Initialize a Server instance with name and url. + * @param name as String + * @param url as String + */ public Server(String name, String url) { this.name = name; this.url = url; } + /** + * Initialize a Server instance with all parameters. + * Authentication will be set to true. + * @param serverName as String + * @param url as String + * @param user as String + * @param password as String + */ public Server(String serverName, String url, String user, String password) { this.name = serverName; this.url = url; @@ -37,7 +47,11 @@ public Server(String serverName, String url, String user, String password) { autheticationRequired = true; } - + /** + * Retrieve a service from the list based on its name + * @param serviceName as String + * @return Service object where found, else returns null + */ public Service getService(String serviceName){ for(Service service : this.services){ @@ -48,35 +62,64 @@ public Service getService(String serviceName){ return null; } - + /** + * Retrieve server name + * @return name as String + */ public String getServerName(){ return this.name; } - + /** + * Retrieve server url + * @return url as String + */ public String getServerUrl(){ return this.url; } - + /** + * Retrieve username + * @return username as String + */ public String getUser() { return user; } - + /** + * Retrieve password + * @return password as String + */ public String getPassword() { return password; } - + /** + * Set new username + * @param user as String + */ public void setUser(String user) { this.user = user; } - + /** + * Set new password + * @param password as String + */ public void setPassword(String password) { this.password = password; } - + + /** + * Loads all available services from the server + */ public void loadServices(){ this.loadServices(null); } + /** + * Loads all available services from the server. + * Note: The IstSOSListener callback modifier is set to final. + * Every usage of this method will result in a new request to retrieve + * services from istSOS. + * + * @param callback + */ public void loadServices(final IstSOSListener callback){ services.clear(); @@ -121,6 +164,10 @@ public void onError(EventObject event) { }, this.getRealm()); } + /** + * Retrieve list of services + * @return List of Service objects + */ public List getServices() { return this.services; } diff --git a/src/main/java/org/istsos/client/Service.java b/src/main/java/org/istsos/client/Service.java index c27c7ee..bb9de39 100644 --- a/src/main/java/org/istsos/client/Service.java +++ b/src/main/java/org/istsos/client/Service.java @@ -11,8 +11,8 @@ * Handles all requests for IstSOS data instances. *

* Enables capabilities for working with offerings, procedures, virtual procedures, - * observed properties, units of measure, data qualities, and observations. - * + * observed properties, unit of measure, data qualities, and observations. Holds + * data classes in lists. */ public class Service implements IstSOSObject{ @@ -32,7 +32,10 @@ public class Service implements IstSOSObject{ private ArrayList observations = new ArrayList<>(); public Service() {}; - + /** + * Initialize Service on the given Server. + * @param server {@link Server} + */ public Service(Server server) { this.server = server; } @@ -40,7 +43,7 @@ public Service(Server server) { public String getName() { return name; } - + public void setName(String name) { this.name = name; } @@ -48,19 +51,24 @@ public void setName(String name) { public String getConfigPath() { return configPath; } - + /** + * Set new configuration path + * @param configPath as String + */ public void setConfigPath(String configPath) { this.configPath = configPath; } - + /** + * + * @param {@link Server} server + */ public void setServer(Server server){ this.server = server; } - /** - * - * @param procedureName - * @return Procedure + * Retrieve a procedure based on its name. + * @param procedureName as String + * @return {@link Procedure} instance if found, else returns null. */ public Procedure getProcedure(String procedureName){ @@ -73,11 +81,10 @@ public Procedure getProcedure(String procedureName){ return null; } - /** - * - * @param offeringName - * @return Offering + * Retrieve an offering based on its name. + * @param offeringName as String + * @return {@link Offering} instance if found, else returns null. */ public Offering getOffering(String offeringName){ @@ -90,11 +97,10 @@ public Offering getOffering(String offeringName){ return null; } - /** - * - * @param defUrn - * @return ObservedProperty + * Retrieve an observedProperty based on its definition URN. + * @param defUrn as String + * @return {@link ObservedProperty} instance if found, else returns null. */ public ObservedProperty getObservedProperty(String defUrn){ @@ -108,11 +114,10 @@ public ObservedProperty getObservedProperty(String defUrn){ return null; } - /** - * - * @param code - * @return DataQuality + * Retrieve a data quality based on its code. + * @param code as int + * @return {@link DataQuality} instance if found, else returns null. */ public DataQuality getDataQuality(int code){ @@ -124,11 +129,10 @@ public DataQuality getDataQuality(int code){ return null; } - /** - * - * @param procedureName - * @return VirtualProcedure + * Retrieve a virtual procedure based on its name. + * @param procedureName as String + * @return {@link VirtualProcedure} instance if found, else returns null. */ public VirtualProcedure getVirtualProcedure(String procedureName){ @@ -140,11 +144,10 @@ public VirtualProcedure getVirtualProcedure(String procedureName){ return null; } - /** - * - * @param uomName - * @return UnitOfMeasure + * Retrieve unit of measure based on its name. + * @param uomName as String + * @return {@link UnitOfMeasure} instance if found, else returns null. */ public UnitOfMeasure getUom(String uomName){ @@ -166,7 +169,7 @@ public void loadDatabase(){ } /** - * Load connection to Database + * Opens new connection to the Database. * @param callback */ public void loadDatabase(final IstSOSListener callback){ @@ -209,19 +212,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for testing database connection - * @param databaseConnection + * @param database as {@link DatabaseConnection} */ public void validateDatabase(DatabaseConnection databaseConnection) { this.validateDatabase(databaseConnection, null); } - /** - * Test database connection - * @param database - * @param callback + * Validate the database connection. + * @param database as {@link DatabaseConnection} + * @param callback as IstSOSListener */ public void validateDatabase(DatabaseConnection database, final IstSOSListener callback){ @@ -267,18 +268,16 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - - /** * Default method for loading service provider */ public void loadProvider(){ this.loadProvider(null); } - /** - * Load service provider - * @param callback + * Retrieve service provider from the Service. + * + * @param callback as IstSOSListener */ public void loadProvider(final IstSOSListener callback){ @@ -320,7 +319,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for updating service provider * @param provider @@ -328,11 +326,10 @@ public void onError(EventObject event) { public void updateProvider(Provider provider){ this.updateProvider(provider, null); } - /** - * Update service provider - * @param provider - * @param callback + * Update service provider based on a Provider instance. + * @param provider as {@link Provider} + * @param callback as IstSOSListener */ public void updateProvider(Provider provider, final IstSOSListener callback){ @@ -379,32 +376,30 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - - /** - * Default method for retrieving an observation object by specifying a single procedure and observed property - * as well ass the interval of time by specifying the begin and end positions. - * @param offering - * @param procedure - * @param defUrn - * @param beginPosition - * @param endPosition + * Default method for retrieving an observation object by specifying an offering, a single procedure, a observed property, as well + * as the time interval. + * @param offering as {@link Offering} + * @param procedure as {@link Procedure} + * @param defUrn as {@link ObservedProperty} + * @param beginPosition as {@link Date} + * @param endPosition as {@link Date} */ public void getObservation(Offering offering, Procedure procedure, ObservedProperty defUrn, Date beginPosition, Date endPosition){ this.getObervation(offering, procedure, defUrn, beginPosition, endPosition, null); } - /** - * Retrieve an observation object by specifying a single procedure and an observed property, as well - * as the interval of time by specifying the begin and end positions. - * - * @param offering - * @param procedure - * @param defUrn - * @param beginPosition - * @param endPosition - * @param callback + * Retrieve an observation object by specifying an offering, a single procedure, a observed property, as well + * as the time interval. + *

+ * Note: Date objects will be formatted according to the specs used by istSOS, "yyyy-MM-dd'T'HH:mm:ssXX". + * @param offering as {@link Offering} + * @param procedure as {@link Procedure} + * @param defUrn as {@link ObservedProperty} + * @param beginPosition as {@link Date} + * @param endPosition as {@link Date} + * @param callback as {@link IstSOSListener} */ public void getObervation(Offering offering, Procedure procedure, ObservedProperty defUrn, Date beginPosition, Date endPosition, final IstSOSListener callback){ @@ -452,32 +447,30 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** - * Default method for loading Observation based by specifying multiple procedures and - * observed properties - * as well as the interval of time by specifying the begin and end positions. - * - * @param offering - * @param procedure - * @param defUrn - * @param beginPosition - * @param endPosition + * Default method for loading Observation based by specifying multiple procedures, + * multiple observed properties, an offering, as well as the interval of time. + * Note: Date objects will be formatted according to the specs used by istSOS, "yyyy-MM-dd'T'HH:mm:ssXX". + * @param offering as {@link Offering} + * @param procedure as {@link List}<{@link Procedure}> + * @param defUrn as {@link List}<{@link ObservedProperty}> + * @param beginPosition as {@link Date} + * @param endPosition as {@link Date} */ public void getObservation(Offering offering, List procedure, List defUrn, Date beginPosition, Date endPosition){ this.getObervation(offering, procedure, defUrn, beginPosition, endPosition, null); } - /** - * Loads Observations by doing a request based on multiple procedures and observed properties - * - * @param offering - * @param procedure - * @param defUrn - * @param beginPosition - * @param endPosition - * @param callback + * Loads Observations by doing a request based on multiple procedures and observed properties. + *

+ * Note: Date objects will be formatted according to the specs used by istSOS, "yyyy-MM-dd'T'HH:mm:ssXX". + * @param offering as {@link Offering} + * @param procedure as {@link List}<{@link Procedure}> + * @param defUrn as {@link List}<{@link ObservedProperty}> + * @param beginPosition as {@link Date} + * @param endPosition as {@link Date} + * @param callback as {@link IstSOSListener} */ public void getObervation(Offering offering, List procedure, List defUrn, Date beginPosition, Date endPosition, final IstSOSListener callback){ @@ -541,31 +534,25 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** - * Retrieve a list of Observations as Java object - * @return An ArrayList with Observation instances + * Retrieve a list of Observations + * @return List of Observations */ public ArrayList getObservations() { return observations; } - - /** * Default method for describing sensor properties based on procedure name - * @param procedureName + * @param procedureName as String */ public void describeSensor(String procedureName){ this.describeSensor(procedureName, null); } - - /** - * Describe sensor properties by specifying procedure name, it returns a - * procedure object from service. + * Describe sensor properties by specifying procedure name. * - * @param procedureName - * @param callback + * @param procedureName as String + * @param callback as IstSOSListener */ public void describeSensor(String procedureName, final IstSOSListener callback){ @@ -600,7 +587,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for registering a sensor * @param procedure @@ -608,11 +594,10 @@ public void onError(EventObject event) { public void registerSensor(Procedure procedure) { this.registerSensor(procedure, null); } - /** - * Registers new sensor by executing a POST request to service. - * @param procedure - * @param callback + * Registers new sensor on the service. + * @param procedure as Procedure + * @param callback as IstSOSListener */ public void registerSensor(Procedure procedure, final IstSOSListener callback){ @@ -651,24 +636,19 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** * Default method for inserting observation. - * Handles insert observation, executes a POST request using an - * observation and procedure. - * @param procedure - * @param observation + * @param procedure {@link Procedure} + * @param observation {@link Observation} */ public void insertObservation(Procedure procedure, Observation observation){ this.insertObservation(procedure, observation, null); } - /** - * Handles insert observation, executes a POST request using an - * observation and procedure. - * @param procedure - * @param observation - * @param callback + * Insert Observation to service. + * @param procedure {@link Procedure} + * @param observation {@link Observation} + * @param callback {@link IstSOSListener} */ public void insertObservation(Procedure procedure, Observation observation, final IstSOSListener callback){ @@ -706,18 +686,15 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - - /** * Default method for loading Status */ public void loadStatus() { this.loadStatus(null); } - /** - * Load Status - * @param callback + * Load status of the service. + * @param callback IstSOSListener */ public void loadStatus(final IstSOSListener callback){ @@ -761,22 +738,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - - /** - * Load existing data qualities from service. Executes a get request - * in order to retrieve a list of available data qualities. + * Load existing data qualities from service. * Default method used without parameter. */ public void loadDataQualities(){ this.loadDataQualities(null); } - /** - * Load existing data qualities from service. Executes a get request - * in order to retrieve a list of available data qualities. + * Load existing data qualities from service. * - * @param callback + * @param callback IstSOSListener */ public void loadDataQualities(final IstSOSListener callback){ @@ -818,15 +790,13 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** * Retrieve data qualities - * @return a an ArrayList of data qualities with data quality object + * @return List of data qualities */ public ArrayList getDataQualities() { return dataQualities; } - /** * Default method for registering a data quality to selected service. * @param dataQuality @@ -834,11 +804,10 @@ public ArrayList getDataQualities() { public void registerDataQuality(DataQuality dataQuality){ this.registerDataQuality(dataQuality, null); } - /** - * Register data quality object to list of data qualities on service. - * @param dataQuality - * @param callback + * Register new data quality to the service. + * @param dataQuality {@link DataQuality} + * @param callback {@link IstSOSListener} */ public void registerDataQuality(DataQuality dataQuality, final IstSOSListener callback){ @@ -879,7 +848,6 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** * Default method for updating data quality characteristics. * @param dataQuality @@ -887,11 +855,10 @@ public void onError(EventObject event) { public void updateDataQuality(DataQuality dataQuality){ this.updateDataQuality(dataQuality, null); } - /** - * Update the selected data quality's characteristics (code, name, description). - * @param dataQuality - * @param callback + * Update a data quality's characteristics (code, name, description). + * @param dataQuality {@link DataQuality} + * @param callback {@link IstSOSListener} */ public void updateDataQuality(DataQuality dataQuality, final IstSOSListener callback){ @@ -937,19 +904,17 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** - * Default method for removing data quality from server + * Default method for removing data quality from service. * @param dataQuality */ public void removeDataQuality(DataQuality dataQuality){ this.removeDataQuality(dataQuality, null); } - /** - * Remove data quality from service - * @param dataQuality - * @param callback + * Remove data quality from service. + * @param dataQuality {@link DataQuality} + * @param callback {@link IstSOSListener} */ public void removeDataQuality(DataQuality dataQuality, final IstSOSListener callback){ @@ -992,19 +957,15 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - - - /** * Default method for loading observed properties from selected service. */ public void loadObservedProperties(){ this.loadObservedProperties(); } - /** * Load observed properties from selected service. - * @param callback + * @param callback as {@link IstSOSListener} */ public void loadObservedProperties(final IstSOSListener callback){ @@ -1046,29 +1007,24 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - - /** - * Retrieve observed properties - * @return an ArrayList of observed properties objects + * Retrieve observed properties. + * @return List of observed properties */ public ArrayList getObservedProperties() { return observedProperties; } - /** * Default method for registering observed property to service. - * @param obs + * @param obs - {@link ObservedProperty} */ public void registerObservedProperty(ObservedProperty obs){ this.registerObservedProperty(obs, null); } - - /** - * Register observed property to service. - * @param - * @param callback + * Register new observed property to service. + * @param observedProperty - {@link ObservedProperty} + * @param callback - {@link IstSOSListener} */ public void registerObservedProperty(ObservedProperty observedProperty, final IstSOSListener callback){ @@ -1108,21 +1064,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for updating selected Observed Property - * @param observedProperty + * Default method for updating selected Observed Property. + * @param observedProperty - {@link ObservedProperty} */ public void updateObservedProperty(ObservedProperty observedProperty){ this.updateObservedProperty(observedProperty, null); } - - /** - * Update Observed Property - * - * @param observedProperty - * @param callback + * Update observed property characteristics. + * @param observedProperty - {@link ObservedProperty} + * @param callback - {@link IstSOSListener} */ public void updateObservedProperty(ObservedProperty observedProperty, final IstSOSListener callback){ @@ -1169,20 +1121,17 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** * Default method for removing observed property. - * @param observedProperty + * @param observedProperty - {@link ObservedProperty} */ public void removeObservedProperty(ObservedProperty observedProperty){ this.removeObservedProperty(observedProperty, null); } - - /** * Remove observed property from service. - * @param observedProperty - * @param callback + * @param observedProperty - {@link ObservedProperty} + * @param callback - {@link IstSOSListener} */ public void removeObservedProperty(ObservedProperty observedProperty, final IstSOSListener callback){ @@ -1223,18 +1172,15 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - - /** * Default method for loading units of measure from service. */ public void loadUnitsOfMeasure(){ this.loadUnitsOfMeasure(null); } - /** * Load units of measure from service. - * @param callback + * @param callback - {@link IstSOSListener} */ public void loadUnitsOfMeasure(final IstSOSListener callback){ @@ -1276,27 +1222,24 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** - * Retrieve units of measure as a HashMap - * @return an ArrayList of units of measure + * Retrieve units of measure of list from service. + * @return List with units of measure */ public ArrayList getUnitsOfMeasure() { return uoms; } - /** * Default method for registering unit of measure to service - * @param uom + * @param uom - {@link UnitOfMeasure} */ public void registerUnitOfMeasure(UnitOfMeasure uom){ this.registerUnitOfMeasure(uom, null); } - /** - * Register unit of measure to service - * @param uom - * @param callback + * Register unit of measure to service. + * @param uom - {@link UnitOfMeasure} + * @param callback - {@link IstSOSListener} */ public void registerUnitOfMeasure(UnitOfMeasure uom, final IstSOSListener callback){ @@ -1336,19 +1279,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for updating selected unit of measure - * @param uom + * Default method for updating selected unit of measure. + * @param uom - {@link IstSOSListener} */ public void updateUnitOfMeasure(UnitOfMeasure uom){ this.updateUnitOfMeasure(uom, null); } - /** - * Update selected unit of measure - * @param uom - * @param callback + * Update selected unit of measure. + * @param uom - {@link UnitOfMeasure} + * @param callback - {@link IstSOSListener} */ public void updateUnitOfMeasure(UnitOfMeasure uom, final IstSOSListener callback){ @@ -1395,7 +1336,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for removing unit of measure * @param uom @@ -1403,11 +1343,10 @@ public void onError(EventObject event) { public void removeUnitOfMeasure(UnitOfMeasure uom){ this.removeUnitOfMeasure(uom, null); } - /** * Remove unit of measure from service. - * @param uom - * @param callback + * @param uom - {@link UnitOfMeasure} + * @param callback - {@link IstSOSListener} */ public void removeUnitOfMeasure(UnitOfMeasure uom, final IstSOSListener callback){ @@ -1449,18 +1388,15 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - - /** * Default method for loading procedures from service */ public void loadProcedures(){ this.loadProcedures(null); } - /** - * Load procedures from service - * @param callback + * Load procedures from service. + * @param callback - {@link IstSOSListener} */ public void loadProcedures(final IstSOSListener callback){ @@ -1504,12 +1440,11 @@ public void onError(EventObject event) { /** * Retrieve a list of procedures - * @return an ArrayList with procedure instances + * @return List of procedures. */ public ArrayList getProcedures() { return this.procedures; } - /** * Default method for registering procedure * @param procedure From 00014292889498e80fc51b93937b824dd8fd011f Mon Sep 17 00:00:00 2001 From: masterflorin Date: Mon, 24 Oct 2016 10:30:21 +0300 Subject: [PATCH 2/2] Update javadocs for classes and methods. --- .../java/org/istsos/client/DataQuality.java | 2 +- .../java/org/istsos/client/Observation.java | 51 ++++-- .../org/istsos/client/ObservedProperty.java | 49 ++++- src/main/java/org/istsos/client/Offering.java | 68 +++++-- .../java/org/istsos/client/Procedure.java | 7 +- .../java/org/istsos/client/SamplingTime.java | 46 +++-- src/main/java/org/istsos/client/Service.java | 167 ++++++++---------- .../java/org/istsos/client/UnitOfMeasure.java | 2 - .../istsos/client/observation/DataArray.java | 12 +- .../org/istsos/client/observation/Result.java | 12 +- 10 files changed, 255 insertions(+), 161 deletions(-) diff --git a/src/main/java/org/istsos/client/DataQuality.java b/src/main/java/org/istsos/client/DataQuality.java index 3c0a3cf..cacebf7 100644 --- a/src/main/java/org/istsos/client/DataQuality.java +++ b/src/main/java/org/istsos/client/DataQuality.java @@ -6,7 +6,7 @@ import com.google.gson.annotations.SerializedName; /** - * DataQuality class. Supports conversion both to/from JSON. + * DataQuality class. * */ public class DataQuality implements IstSOSObject { diff --git a/src/main/java/org/istsos/client/Observation.java b/src/main/java/org/istsos/client/Observation.java index 28b0551..e0fc8d7 100644 --- a/src/main/java/org/istsos/client/Observation.java +++ b/src/main/java/org/istsos/client/Observation.java @@ -8,8 +8,7 @@ import org.istsos.client.observation.Result; /** - * Class for storing observation information such as samplingTime, name, - * procedure, result. + * The Observation class represents data such as result, sampling time, procedure. * */ public class Observation implements IstSOSObject{ @@ -23,43 +22,59 @@ public class Observation implements IstSOSObject{ @SerializedName ("result") private Result result; - + /** + * + * @return sampling time - {@link SamplingTime} + */ public SamplingTime getSamplingTime() { return samplingTime; } - - + /** + * + * @param samplingTime - {@link SamplingTime} + */ public void setSamplingTime(SamplingTime samplingTime) { this.samplingTime = samplingTime; } - - + /** + * + * @return a string + */ public String getName() { return name; } - - + /** + * + * @param name - String + */ public void setName(String name) { this.name = name; } - - + /** + * + * @return name of procedure as String + */ public String getProcedure() { return procedure; } - - + /** + * + * @param procedure - String + */ public void setProcedure(String procedure) { this.procedure = procedure; } - - - + /** + * + * @return observation {@link Result} + */ public Result getResult() { return result; } - - + /** + * + * @param result - {@link Result} + */ public void setResult(Result result) { this.result = result; } diff --git a/src/main/java/org/istsos/client/ObservedProperty.java b/src/main/java/org/istsos/client/ObservedProperty.java index 5c77acf..1dc029f 100644 --- a/src/main/java/org/istsos/client/ObservedProperty.java +++ b/src/main/java/org/istsos/client/ObservedProperty.java @@ -10,10 +10,8 @@ import com.google.gson.reflect.TypeToken; /** - * ObservedProperty class. Holds information such as defUrn, name, - * description, uom, procedures. - * Supports conversion to/from JSON. - * + * ObservedProperty class represents information such as definition URN, name, + * description, unit of measure, and procedure names. */ @SuppressWarnings("rawtypes") public class ObservedProperty implements IstSOSObject { @@ -29,36 +27,73 @@ public class ObservedProperty implements IstSOSObject { @SerializedName("uom") private String uom; - + /** + * + * @return definition URN as String + */ public String getDefinition() { return definition; } + /** + * + * @param definition - String + */ public void setDefinition(String definition) { this.definition = definition; } + /** + * + * @return list of procedure names + */ public ArrayList getProcedures() { return procedures; } + /** + * + * @param procedures - List of string + */ public void setProcedures(ArrayList procedures) { this.procedures = procedures; } + /** + * + * @return name + */ public String getName() { return name; } + /** + * + * @param name - String + */ public void setName(String name) { this.name = name; } + /** + * + * @return description + */ public String getDescription() { return description; } + /** + * + * @param description - String + */ public void setDescription(String description) { this.description = description; } - + /** + * + * @return unit of measure as String + */ public String getUom() { return uom; } - + /** + * + * @param uom - String + */ public void setUom(String uom) { this.uom = uom; } diff --git a/src/main/java/org/istsos/client/Offering.java b/src/main/java/org/istsos/client/Offering.java index f15f1af..963c51e 100644 --- a/src/main/java/org/istsos/client/Offering.java +++ b/src/main/java/org/istsos/client/Offering.java @@ -6,15 +6,13 @@ import com.google.gson.annotations.SerializedName; /** - * Offering class. Holds information such as name, description, visibility status, - * expiration date, id, procedures count. - * Supports conversion to/from JSON. + * The Offering class represents information such as name, description, visibility status, + * expiration date, id, and number of procedures * */ @SuppressWarnings("rawtypes") public class Offering implements IstSOSObject{ - @SerializedName ("name") private String name; @@ -33,58 +31,92 @@ public class Offering implements IstSOSObject{ @SerializedName ("procedures") private int procedures; - + /** + * + * @return String with name + */ public String getName() { return name; } - + /** + * + * @param name - String + */ public void setName(String name) { this.name = name; } - + /** + * + * @return String with description + */ public String getDescription() { return description; } - + /** + * + * @param description - String + */ public void setDescription(String description) { this.description = description; } - + /** + * + * @return boolean value + */ public boolean isStatus() { return status; } - + /** + * + * @param status - boolean + */ public void setStatus(boolean status) { this.status = status; } - + /** + * + * @return String with expiration date + */ public String getExpiration() { return expiration; } - + /** + * + * @param expiration - String + */ public void setExpiration(String expiration) { this.expiration = expiration; } - + /** + * + * @return String with id + */ public String getId() { return id; } - + /** + * + * @param id - String + */ public void setId(String id) { this.id = id; } - + /** + * + * @return int + */ public int getProcedures() { return procedures; } - + /** + * + * @param procedures - int + */ public void setProcedures(int procedures) { this.procedures = procedures; } - - public JsonObject toJson() { // TODO Auto-generated method stub JsonObject json = new JsonObject(); diff --git a/src/main/java/org/istsos/client/Procedure.java b/src/main/java/org/istsos/client/Procedure.java index 3a97b73..8ca4124 100644 --- a/src/main/java/org/istsos/client/Procedure.java +++ b/src/main/java/org/istsos/client/Procedure.java @@ -15,7 +15,7 @@ import org.istsos.client.procedure.Location; /** - * Procedure class. + * Procedure class represents all features of a procedure. * */ public class Procedure implements IstSOSObject { @@ -204,13 +204,12 @@ public JsonObject toJson() { return gson.toJsonTree(this,Procedure.class).getAsJsonObject(); } - /** * * Generate a Procedure from json objerct * - * @param json - * @return Procedure + * @param json - {@link JsonObject} + * @return a procedure */ static Procedure fromJson(JsonObject json){ diff --git a/src/main/java/org/istsos/client/SamplingTime.java b/src/main/java/org/istsos/client/SamplingTime.java index 8fa3935..9d68f67 100644 --- a/src/main/java/org/istsos/client/SamplingTime.java +++ b/src/main/java/org/istsos/client/SamplingTime.java @@ -8,9 +8,12 @@ import com.google.gson.annotations.SerializedName; /** - * Handles time interval for {@link Observation} using {@link Date} class - * with the following format: yyyy-MM-dd'T'HH:mm:ssXX. - * + * The Sampling Time class represents time interval for {@link Observation} using + * {@link Date} type with the following format: + * 

+ * 		yyyy-MM-dd'T'HH:mm:ssXX.
+ *
+ * */ @SuppressWarnings("rawtypes") public class SamplingTime implements IstSOSObject{ @@ -20,7 +23,12 @@ public class SamplingTime implements IstSOSObject{ private Date beginPosition; @SerializedName("endposition") private Date endPosition; - + /** + * + * @param duration - String + * @param beginPosition - {@link Date} + * @param endPosition - {@link Date} + */ public SamplingTime(String duration, Date beginPosition, Date endPosition) { this.duration = duration; this.beginPosition = beginPosition; @@ -29,27 +37,45 @@ public SamplingTime(String duration, Date beginPosition, Date endPosition) { public SamplingTime() { } - + /** + * + * @return string with the duration + */ public String getDuration() { return duration; } - + /** + * + * @param duration - String + */ public void setDuration(String duration) { this.duration = duration; } - + /** + * + * @return beginning date of the interval + */ public Date getBeginPosition() { return beginPosition; } - + /** + * + * @param beginPosition - {@link Date} + */ public void setBeginPosition(Date beginPosition) { this.beginPosition = beginPosition; } - + /** + * + * @return ending date of the interval + */ public Date getEndPosition() { return endPosition; } - + /** + * + * @param endPosition + */ public void setEndPosition(Date endPosition) { this.endPosition = endPosition; } diff --git a/src/main/java/org/istsos/client/Service.java b/src/main/java/org/istsos/client/Service.java index bb9de39..c898429 100644 --- a/src/main/java/org/istsos/client/Service.java +++ b/src/main/java/org/istsos/client/Service.java @@ -1230,14 +1230,14 @@ public ArrayList getUnitsOfMeasure() { return uoms; } /** - * Default method for registering unit of measure to service + * Default method for registering a unit of measure to service * @param uom - {@link UnitOfMeasure} */ public void registerUnitOfMeasure(UnitOfMeasure uom){ this.registerUnitOfMeasure(uom, null); } /** - * Register unit of measure to service. + * Register a unit of measure to service. * @param uom - {@link UnitOfMeasure} * @param callback - {@link IstSOSListener} */ @@ -1280,14 +1280,14 @@ public void onError(EventObject event) { }, this.server.getRealm()); } /** - * Default method for updating selected unit of measure. + * Default method for updating a selected unit of measure. * @param uom - {@link IstSOSListener} */ public void updateUnitOfMeasure(UnitOfMeasure uom){ this.updateUnitOfMeasure(uom, null); } /** - * Update selected unit of measure. + * Update a selected unit of measure. * @param uom - {@link UnitOfMeasure} * @param callback - {@link IstSOSListener} */ @@ -1389,13 +1389,13 @@ public void onError(EventObject event) { } /** - * Default method for loading procedures from service + * Default method for retrieve all existing procedures from service. */ public void loadProcedures(){ this.loadProcedures(null); } /** - * Load procedures from service. + * Retrieve all existing procedures from service. * @param callback - {@link IstSOSListener} */ public void loadProcedures(final IstSOSListener callback){ @@ -1437,7 +1437,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Retrieve a list of procedures * @return List of procedures. @@ -1446,17 +1445,15 @@ public ArrayList getProcedures() { return this.procedures; } /** - * Default method for registering procedure + * Default method for registering a procedure * @param procedure */ public void registerProcedure(Procedure procedure){ this.registerProcedure(procedure, null); } - - /** - * Retrieve procedure based by name from service - * @param procedureName + * Retrieve a procedure from service based on its name. + * @param procedureName - String */ public void getProcedure(String procedureName, final IstSOSListener callback){ @@ -1497,11 +1494,10 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Register procedure to selected service - * @param procedure - * @param callback + * @param procedure - {@link Procedure} + * @param callback - {@link IstSOSListener} */ public void registerProcedure(Procedure procedure, final IstSOSListener callback){ @@ -1541,19 +1537,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for updating procedure. - * @param procedure + * @param procedure - {@link Procedure} */ public void updateProcedure(Procedure procedure){ this.updateProcedure(procedure, null); } - /** * Update selected procedure - * @param procedure - * @param callback + * @param procedure - {@link Procedure} + * @param callback - {@link IstSOSListener} */ public void updateProcedure(Procedure procedure, final IstSOSListener callback){ @@ -1596,17 +1590,15 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for loading virtual procedures from service + * Default method for loading virtual procedures from service. */ public void loadVirtualProcedures(){ this.loadVirtualProcedures(null); } - /** - * Load virtual procedures from service - * @param callback + * Retrieve all existing virtual procedures from service. + * @param callback - {@link IstSOSListener} */ public void loadVirtualProcedures(final IstSOSListener callback){ @@ -1647,23 +1639,24 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - + /** + * Retrieve a list of virtual procedures. + * @return List + */ public ArrayList getVirtualProcedures() { return virtualProcedures; } - /** * Default method for loading virtual procedure code - * @param virtualProcedure + * @param virtualProcedure - {@link VirtualProcedure} */ public void loadVirtualProcedureCode(VirtualProcedure virtualProcedure){ this.loadVirtualProcedureCode(virtualProcedure, null); } - /** - * Load virtual procedure code - * @param virtualProcedure - * @param callback + * Load virtual procedure code from service. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void loadVirtualProcedureCode(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -1704,19 +1697,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for registering virtual procedure code - * @param virtualProcedure + * Default method for registering virtual procedure code. + * @param virtualProcedure - {@link VirtualProcedure} */ public void registerVirtualProcedureCode(VirtualProcedure virtualProcedure){ this.registerVirtualProcedureCode(virtualProcedure, null); } - /** - * Register virtual procedure code - * @param virtualProcedure - * @param callback + * Register virtual procedure code. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void registerVirtualProcedureCode(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -1757,19 +1748,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for updating virtual procedure code - * @param virtualProcedure + * Default method for updating an existing virtual procedure code in the service. + * @param virtualProcedure - {@link VirtualProcedure} */ public void updateVirtualProcedureCode(VirtualProcedure virtualProcedure){ this.updateVirtualProcedureCode(virtualProcedure, null); } - /** - * Update virtual procedure code - * @param virtualProcedure - * @param callback + * Update an existing virtual procedure code in the service. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void updateVirtualProcedureCode(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -1815,19 +1804,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for removing virtual procedure code - * @param virtualProcedure + * Default method for removing virtual procedure code from service. + * @param virtualProcedure - {@link VirtualProcedure} */ public void removeVirtualProcedureCode(VirtualProcedure virtualProcedure){ this.removeVirtualProcedureCode(virtualProcedure, null); } - /** - * Remove virtual procedure code - * @param virtualProcedure - * @param callback + * Remove virtual procedure code from service. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void removeVirtualProcedureCode(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -1870,7 +1857,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** * Default method for loading virtual procedure rating curve * @param virtualProcedure @@ -1878,7 +1864,11 @@ public void onError(EventObject event) { public void loadVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure){ this.loadVirtualProcedureRatingCurve(virtualProcedure, null); } - + /** + * Retrieve rating curve from the selected virtual procedure from the service. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} + */ public void loadVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure, final IstSOSListener callback){ Map urlKeyMap = new HashMap(); @@ -1917,19 +1907,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for registering rating curve - * @param virtualProcedure + * Default method for registering rating curve for the input virtual procedure. + * @param virtualProcedure - {@link VirtualProcedure} */ public void registerVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure){ this.registerVirtualProcedureRatingCurve(virtualProcedure, null); } - /** - * Register rating curve for virtual procedure - * @param virtualProcedure - * @param callback + * Register rating curve for the input virtual procedure. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void registerVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -1970,20 +1958,18 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for removing rating curve + * Default method for removing rating curve from the selected virtual procedure. * - * @param virtualProcedure + * @param virtualProcedure - {@link VirtualProcedure} */ public void removeVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure){ this.removeVirtualProcedureCode(virtualProcedure, null); } - /** - * Remove rating curve from virtual procedure - * @param virtualProcedure - * @param callback + * Remove rating curve from the selected virtual procedure. + * @param virtualProcedure - {@link VirtualProcedure} + * @param callback - {@link IstSOSListener} */ public void removeVirtualProcedureRatingCurve(VirtualProcedure virtualProcedure, final IstSOSListener callback){ @@ -2026,8 +2012,6 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - - /** * Default method for loading offerings */ @@ -2037,7 +2021,7 @@ public void loadOfferings(){ /** * Load offerings from service. - * @param callback + * @param callback - {@link IstSOSListener} */ public void loadOfferings(final IstSOSListener callback){ @@ -2082,27 +2066,24 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Retrieve a list of offerings - * @return an ArrayList of offerings, with offering name as key and offering object as value + * Retrieve a list of offerings. + * @return List of {@link Offering} */ public ArrayList getOfferings() { return this.offerings; } - /** * Default method for registering offering to service. - * @param offering + * @param offering - {@link Offering} */ public void registerOffering(Offering offering){ this.registerOffering(offering, null); } - /** - * Register offering to service - * @param offering - * @param callback + * Register offering to service. + * @param offering - {@link Offering} + * @param callback - {@link IstSOSListener} */ public void registerOffering(Offering offering, final IstSOSListener callback){ @@ -2143,19 +2124,17 @@ public void onError(EventObject event) { }, this.server.getRealm()); } - /** - * Default method for updating offering - * @param offering + * Default method for updating a selected offering. + * @param offering - {@link Offering} */ public void updateOffering(Offering offering){ this.updateOffering(offering, null); } - /** - * Update selected offering - * @param offering - * @param callback + * Update the selected offering. + * @param offering - {@link Offering} + * @param callback - {@link IstSOSListener} */ public void updateOffering(Offering offering, final IstSOSListener callback){ @@ -2199,19 +2178,17 @@ public void onError(EventObject event) { } }, this.server.getRealm()); } - /** - * Default method for removing offering - * @param offering + * Default method to remove an existing offering from service. + * @param offering - {@link Offering} */ public void removeOffering(Offering offering){ this.removeOffering(offering, null); } - /** - * Remove offering from service - * @param offering - * @param callback + * Remove an existing offering from service. + * @param offering - {@link Offering} + * @param callback - {@link IstSOSListener} */ public void removeOffering(Offering offering, final IstSOSListener callback){ diff --git a/src/main/java/org/istsos/client/UnitOfMeasure.java b/src/main/java/org/istsos/client/UnitOfMeasure.java index f0247ab..e6da171 100644 --- a/src/main/java/org/istsos/client/UnitOfMeasure.java +++ b/src/main/java/org/istsos/client/UnitOfMeasure.java @@ -12,8 +12,6 @@ /** * UnitOfMeasure class. Holds data such as name, description, and list of procedures to which it is * registered. - *

- * Supports conversion to/from JSON. * */ @SuppressWarnings("rawtypes") diff --git a/src/main/java/org/istsos/client/observation/DataArray.java b/src/main/java/org/istsos/client/observation/DataArray.java index 6809311..4983f66 100644 --- a/src/main/java/org/istsos/client/observation/DataArray.java +++ b/src/main/java/org/istsos/client/observation/DataArray.java @@ -8,7 +8,7 @@ import com.google.gson.annotations.SerializedName; /** - * Handles observation values. + * The DataArray represents the values of the observation. * */ public class DataArray { @@ -16,11 +16,17 @@ public class DataArray { @SerializedName ("values") private ArrayList values = new ArrayList(); - + /** + * + * @return list of String array + */ public ArrayList getValues() { return values; } - + /** + * + * @param values - {@link ArrayList} + */ public void setValues(ArrayList values) { this.values = values; } diff --git a/src/main/java/org/istsos/client/observation/Result.java b/src/main/java/org/istsos/client/observation/Result.java index 58dfbe2..fdefbe6 100644 --- a/src/main/java/org/istsos/client/observation/Result.java +++ b/src/main/java/org/istsos/client/observation/Result.java @@ -6,18 +6,24 @@ import com.google.gson.annotations.SerializedName; /** - * Handles result element of an observation. + * The Result class represents the DataArray of the Observation. * */ public class Result { @SerializedName ("DataArray") private DataArray dataArray; - + /** + * + * @return {@link DataArray} object + */ public DataArray getDataArray() { return dataArray; } - + /** + * + * @param dataArray - {@link DataArray} + */ public void setDataArray(DataArray dataArray) { this.dataArray = dataArray; }