Spotless

WebApp/junit/uk/ac/exeter/QuinCe/data/Dataset/DatasetSensorValuesTest/QCCascade/AbstractDiagnosticFlagTest.java

@@ -39,7 +39,7 @@ public abstract class AbstractDiagnosticFlagTest extends TestSetTest {
   /**
    * Extract multiple QC comments (separated by {@code ;}) specified in a
    * {@link TestSetLine} into a {@link List} of comments.
-   * 
+   *
    * @param line
    *          The {@link TestSetLine}.
    * @param col
@@ -58,7 +58,7 @@ protected List<String> expectedCommentList(TestSetLine line, int col) {
    * <li>The Display QC comment should contain the specified comments. If the
    * specified comment is empty, the User QC comment should also be empty.</li>
    * </ul>
-   * 
+   *
    * <p>
    * This method does not return a result; it performs a JUnit assertion.
    * </p>
@@ -75,7 +75,7 @@ protected List<String> expectedCommentList(TestSetLine line, int col) {
    *          The complete set of Sensor Values for the DataSet being processed.
    * @throws Exception
    *           If any errors are thrown during checking.
-   * 
+   *
    * @see #checkQC(String, Flag, int, String, Collection)
    */
   protected void checkQC(String valueName, SensorValue sensorValue,
@@ -89,13 +89,13 @@ protected void checkQC(String valueName, SensorValue sensorValue,
 
   /**
    * Check that the QC for a {@link DataReductionRecord} is as expected.
-   * 
+   *
    * <ul>
    * <li>The QC flag should match the specified flag</li>
    * <li>The QC comment should contain the specified comments. If the specified
    * comment is empty, the User QC comment should also be empty.</li>
    * </ul>
-   * 
+   *
    * <p>
    * This method does not return a result; it performs a JUnit assertion.
    * </p>
@@ -106,7 +106,7 @@ protected void checkQC(String valueName, SensorValue sensorValue,
    *          The expected QC flag.
    * @param expectedComment
    *          The expected QC comments.
-   * 
+   *
    * @see #checkQC(String, Flag, int, String, Collection)
    */
   protected void checkQC(DataReductionRecord record, int expectedFlag,
@@ -120,11 +120,11 @@ protected void checkQC(DataReductionRecord record, int expectedFlag,
 
   /**
    * Check that a set of QC information matches the expected information.
-   * 
+   *
    * <p>
    * This method does not return a result: it performs a JUnit assertion.
    * </p>
-   * 
+   *
    * @param name
    *          A recognisable name for the value being checked.
    * @param valueFlag
@@ -173,7 +173,7 @@ protected void checkQC(String name, Flag valueFlag, int expectedFlag,
 
   /**
    * Set the QC flag on a {@link SensorValue} using a numeric value.
-   * 
+   *
    * @param sensorValue
    *          The {@link SensorValue} whose QC flag is to be set.
    * @param flagValue
@@ -208,19 +208,19 @@ protected RunTypePeriods makeRunTypePeriods(SensorValue source)
 
   /**
    * Run the data reduction for a {@link DataSet}.
-   * 
+   *
    * <p>
    * This performs all the standard tasks of the {@link LocateMeasurementsJob}
    * and {@link DataReductionJob}, storing the results in the test database.
    * </p>
-   * 
+   *
    * <p>
    * Although the data reduction is run for the complete {@link DataSet}, only
    * the first {@link DataReductionRecord} is returned. We assume that the
    * calling test is set up such that the values of interest will be in the
    * first {@link Measurement}.
    * </p>
-   * 
+   *
    * @param conn
    *          A database connection.
    * @param instrument
@@ -281,11 +281,11 @@ protected DataReductionRecord runDataReduction(Connection conn,
   /**
    * Check that a {@link SensorValue} has the expected numeric Display QC Flag
    * value.
-   * 
+   *
    * <p>
    * This method does not return a result; it performs a JUnit assertion.
    * </p>
-   * 
+   *
    * @param valueName
    *          A recognisable name for the value being checked.
    * @param sensorValue

WebApp/src/uk/ac/exeter/QuinCe/data/Dataset/DataReduction/DataReducer.java

@@ -72,7 +72,7 @@ public DataReducer(Variable variable, Map<String, Properties> properties) {
    * flags on its source {@link SensorValue}s by applying the {@link Variable}'s
    * flag cascade rules.
    * </p>
-   * 
+   *
    * @param instrument
    *          The {@link Instrument} that took the measurement.
    * @param measurement

WebApp/src/uk/ac/exeter/QuinCe/data/Dataset/QC/Routine.java

@@ -5,13 +5,13 @@
 /**
  * This interface specifies the minimum set of methods required for a any type
  * of QC routine in QuinCe.
- * 
+ *
  * <p>
  * Each {@code Routine} consists of a human-readable name, and messages that are
  * applied to QC flags when they are set to anything that isn't considered Good
  * (see {@link Flag#isGood()}).
  * </p>
- * 
+ *
  * <p>
  * The messages are not necessarily stored in a QC result. For example,
  * {@link AutoQCJob}s will simply store the {@link Flag} and which
@@ -24,20 +24,20 @@ public interface Routine {
 
   /**
    * The name of the routine.
-   * 
+   *
    * @return The routine name.
    */
   public String getName();
 
   /**
    * Returns short version of the QC message reported by this {@code Routine}.
-   * 
+   *
    * <p>
    * This is a simple message that describes the type of check the routine
    * performed, without any details of the specific value(s) that caused a
    * {@link RoutineFlag} to be set.
    * </p>
-   * 
+   *
    * @return The short QC message for the {@code Routine}.
    */
   public String getShortMessage();
@@ -46,13 +46,13 @@ public interface Routine {
    * Returns the fully detailed version of the QC message reported by this
    * {@code
    * Routine}.
-   * 
+   *
    * <p>
    * This will include specific details of why a {@link RoutineFlag} was raised
    * by the {@code Routine}, such as the expected value(s) versus the value(s)
    * in the data.
    * </p>
-   * 
+   *
    * @param flag
    *          The QC flag raised by the {@code Routine}, containing detailed
    *          information of the cause.

WebApp/src/uk/ac/exeter/QuinCe/data/Dataset/QC/SensorValues/AutoQCResult.java

@@ -74,7 +74,7 @@ private static Gson getGson() {
 
   /**
    * Return the overall flag that results from a set of flags from QC routines.
-   * 
+   *
    * <p>
    * This is the most significant flag of the set, according to the order used
    * by {@link Flag#moreSignificantThan(Flag)}.

WebApp/src/uk/ac/exeter/QuinCe/data/Dataset/QC/SensorValues/AutoQCRoutine.java

@@ -96,22 +96,22 @@ public void qc(List<SensorValue> values, RunTypePeriods runTypePeriods)
   /**
    * Convert the specified {@link List} of {@link SensorValue}s into a
    * {@link Map} indexed by Run Type.
-   * 
+   *
    * <p>
    * Each {@link SensorValue}'s timestamp is looked up in the specified
    * {@link RunTypePeriods} object, which tells us which Run Type is in effect
    * for that {@link SensorValue}.
    * </p>
-   * 
+   *
    * <p>
    * The return value is a {@link Map} of {@code Run Type -> SensorValues}
    * </p>
-   * 
+   *
    * <p>
    * The {@link SensorValue}s in both the input and output are assumed to be
    * ordered by ascending time, but this is not enforced.
    * </p>
-   * 
+   *
    * @param values
    *          The {@link SensorValue}s to be organised.
    * @param runTypePeriods

WebApp/src/uk/ac/exeter/QuinCe/jobs/InvalidJobConstructorException.java

@@ -3,7 +3,7 @@
 /**
  * Exception to indicate that the specified job class does not require a
  * constructor of the correct type.
- * 
+ *
  * @see Job#Job(uk.ac.exeter.QuinCe.web.system.ResourceManager,
  *      java.util.Properties, long, uk.ac.exeter.QuinCe.User.User,
  *      java.util.Properties)

WebApp/src/uk/ac/exeter/QuinCe/jobs/JobManager.java

@@ -175,14 +175,14 @@ public class JobManager {
 
   /**
    * Adds a job to the database.
-   * 
+   *
    * <p>
    * If the job is linked to a {@link DataSet} (implied by the presence of
    * {@link DataSetJob#ID_PARAM} in the job's properties), its status is
    * automatically set to {@link DataSet#STATUS_WAITING}. It is the job's
    * responsibility to set the appropriate status when processing starts.
    * </p>
-   * 
+   *
    * @param dataSource
    *          A data source
    * @param owner

WebApp/src/uk/ac/exeter/QuinCe/web/BaseManagedBean.java

@@ -33,7 +33,7 @@
 /**
  * Several Managed Beans are used in the QuinCe application. This abstract class
  * provides a set of useful methods for use by inheriting concrete bean classes.
- * 
+ *
  * <p>
  * <b>WARNING: Performing a "Find Usages" search for some of these methods will
  * not return any results. This <i>DOES NOT</i> mean that the methods are not
@@ -161,7 +161,7 @@ public String internalError(Throwable error) {
 
   /**
    * Retrieve a parameter from the current request.
-   * 
+   *
    * <p>
    * This is a shortcut to looking up values in
    * {@link ExternalContext#getRequestParameterMap}.
@@ -223,7 +223,7 @@ public User getUser() {
 
   /**
    * Get the user's preferences for the currently logged in {@link User}.
-   * 
+   *
    * @return The user's preferences.
    */
   public UserPreferences getUserPrefs() {
@@ -239,7 +239,7 @@ public UserPreferences getUserPrefs() {
   /**
    * Accessing components requires the name of the form that they are in as well
    * as their own name.
-   * 
+   *
    * <p>
    * Most beans will only have one form, so this method will provide the name of
    * that form. Beans with multiple forms will need to employ a different
@@ -335,7 +335,7 @@ public void initialiseInstruments() {
 
   /**
    * Get the {@link Instrument}s owned by the current {@link User}.
-   * 
+   *
    * <p>
    * If the current user has administration permissions, the returned list will
    * contain all the {@link Instrument}s registered for all users.
@@ -354,12 +354,12 @@ public List<Instrument> getInstruments() {
 
   /**
    * Get the {@link Instrument} object with the specified database ID.
-   * 
+   *
    * <p>
    * The {@link Instrument} must be present in the list produced by
    * {@link #getInstruments()}; otherwise {@code null} will be returned.
    * </p>
-   * 
+   *
    * @param instrumentId
    *          The {@link Instrument}'s database ID.
    * @return The {@link Instrument} object.
@@ -372,20 +372,20 @@ public Instrument getInstrument(long instrumentId) {
   /**
    * Retrieve the {@link Instrument} object for the instrument that is currently
    * being manipulated by the user.
-   * 
+   *
    * <p>
    * The "current instrument" is set whenever the user selects an instrument on
    * the DataSets or Data Files page, or calibrations are edited for an
    * instrument. When the user creates a new instrument, it is automatically set
    * as the current instrument.
    * </p>
-   * 
+   *
    * <p>
    * The current instrument persists until an action is taken that causes a new
    * instrument to be set as the current instrument. This will also persist
    * across user sessions.
    * </p>
-   * 
+   *
    * @return The current {@link Instrument}.
    * @see #setCurrentInstrumentId(long)
    */
@@ -480,7 +480,7 @@ public void setCurrentInstrumentId(long currentInstrumentId) {
 
   /**
    * Get the long form format for displaying timestamps.
-   * 
+   *
    * @return The long date format.
    */
   public String getLongDateFormat() {
@@ -530,7 +530,7 @@ public List<RunTypeCategory> getRunTypeCategories() throws ResourceException {
   /**
    * Remove from a list of Run Type Categories any category that is not related
    * to the {@link Variable}s assigned to the current {@link Instrument}.
-   * 
+   *
    * @param categories
    *          The Run Type Categories to be filtered.
    * @return The filtered Run Type Categories.
@@ -628,13 +628,13 @@ public void noop() {
 
   /**
    * Get the navigation result to take the user to the DataSets list page.
-   * 
+   *
    * <p>
    * The exact navigation string required depends on the current state of the
    * application, so this method calculates what it should be in any given
    * situation.
    * </p>
-   * 
+   *
    * @return The navigation string.
    */
   public String getDatasetListNavigation() {
@@ -649,7 +649,7 @@ public String getDatasetListNavigation() {
 
   /**
    * Set the last used date session attribute for later use.
-   * 
+   *
    * <p>
    * This is used when the user is performing actions that require a timestamp
    * to be entered (e.g. editing calibrations). The timestamp is stored so that