Changeset 1178

Timestamp:

10/26/11 23:08:01 (19 months ago)

Author:

philsmart

Message:

 

Location:

raptor-information-model/trunk/src/main/java/uk/ac/cardiff

Files:

• model/event/AuthenticationFailureEvent.java (deleted)
• model/event/Event.java (modified) (2 diffs)
• model/report/AggregatorGraphModel.java (modified) (7 diffs)
• model/wsmodel/EventPushMessage.java (modified) (1 diff)
• model/wsmodel/LogFileUpload.java (modified) (2 diffs)
• model/wsmodel/LogFileUploadResult.java (modified) (1 diff)
• model/wsmodel/StatisticParameters.java (modified) (15 diffs)
• model/wsmodel/SuggestionValues.java (modified) (8 diffs)
• utility/EqualsUtil.java (modified) (1 diff)
• utility/HashCodeUtil.java (modified) (7 diffs)
• utility/StringUtils.java (modified) (1 diff)

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/event/Event.java

@@ -40 +40 @@
     private Long persistantId;
 
-    /** attributes generic to all entries. */
+    /** The date and time the event was generated. */
     private DateTime eventTime;
 
@@ -87 +87 @@
      */
     public Event(Event event) {
-        // this has a defensive getter, so a direct assignment is possible
+        // this has a defensive getter, so direct assignment is possible
         this.eventTime = event.getEventTime();
         this.eventId = event.getEventId();

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/report/AggregatorGraphModel.java

@@ -12 +12 @@
 public class AggregatorGraphModel implements Serializable {
 
-    /** Class logger */
+    /** Class logger. */
     private static final long serialVersionUID = 5372664739350074383L;
 
-    /** The list of <code>String</code> labels for the groups */
+    /** The list of <code>String</code> labels for the groups. */
     private List<String> groupLabels;
 
-    /** The list of <code>String</code> labels for each series */
+    /** The list of <code>String</code> labels for each series. */
     private List<String> seriesLabels;
 
-    /** The list of <code>Double</code> values assigned to each series */
+    /** The list of <code>Double</code> values assigned to each series. */
     private List<List<Double>> chartValues;
 
-    /** A class that holds presentation information for this graph model */
+    /** A class that holds presentation information for this graph model. */
     private Presentation presentation;
 
+    /**
+     * Instantiates a new aggregator graph model.
+     */
     public AggregatorGraphModel() {
         seriesLabels = new ArrayList<String>();
     }
 
+    /**
+     * Gets the group labels.
+     * 
+     * @return the group labels
+     */
     public List<String> getGroupLabels() {
         return groupLabels;
@@ -36 +44 @@
     }
 
+    /**
+     * Adds the group label.
+     * 
+     * @param label
+     *            the label
+     */
     public void addGroupLabel(String label) {
         if (getGroupLabels() == null)
@@ -42 +56 @@
     }
 
+    /**
+     * Adds the series label.
+     * 
+     * @param label
+     *            the label
+     */
     public void addSeriesLabel(String label) {
         if (getSeriesLabels() == null)
@@ -48 +68 @@
     }
 
+    /**
+     * Sort group labels alphabetically.
+     */
     public void sortGroupLabelsAlphabetically() {
         Collections.sort(groupLabels);
@@ -53 +76 @@
     }
 
+    /**
+     * Gets the series labels.
+     * 
+     * @return the series labels
+     */
     public List<String> getSeriesLabels() {
         return seriesLabels;
@@ -58 +86 @@
     }
 
+    /**
+     * Adds the group value.
+     * 
+     * @param values
+     *            the values
+     */
     public void addGroupValue(List<Double> values) {
         if (chartValues == null)
@@ -64 +98 @@
     }
 
+    /**
+     * Gets the y values.
+     * 
+     * @return the y values
+     */
     public List<List<Double>> getYValues() {
         return chartValues;
     }
 
+    /**
+     * Sets the y values.
+     * 
+     * @param values
+     *            the new y values
+     */
     public void setYValues(List<List<Double>> values) {
 
     }
 
+    /**
+     * Sets the group labels.
+     * 
+     * @param groupLabels
+     *            the new group labels
+     */
     public void setGroupLabels(List<String> groupLabels) {
         this.groupLabels = groupLabels;
     }
 
+    /**
+     * Sets the series labels.
+     * 
+     * @param seriesLabels
+     *            the new series labels
+     */
     public void setSeriesLabels(List<String> seriesLabels) {
         this.seriesLabels = seriesLabels;
     }
 
+    /**
+     * Sets the chart values.
+     * 
+     * @param chartValues
+     *            the new chart values
+     */
     public void setChartValues(List<List<Double>> chartValues) {
         this.chartValues = chartValues;
     }
 
+    /**
+     * Gets the chart values.
+     * 
+     * @return the chart values
+     */
     public List<List<Double>> getChartValues() {
         return chartValues;
     }
 
+    /**
+     * Sets the presentation.
+     * 
+     * @param presentation
+     *            the new presentation
+     */
     public void setPresentation(Presentation presentation) {
         this.presentation = presentation;
     }
 
+    /**
+     * Gets the presentation.
+     * 
+     * @return the presentation
+     */
     public Presentation getPresentation() {
         return presentation;

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/wsmodel/EventPushMessage.java

@@ -24 +24 @@
     private ServiceMetadata clientMetadata;
 
-    /** The time instant the message was created push. */
+    /** The time instant the message was created. */
     private Date timeOfPush;
 

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/wsmodel/LogFileUpload.java

@@ -11 +11 @@
     private static final long serialVersionUID = -6283086431616419079L;
 
-    /** The Name. */
+    /** The filename of the file that has been uploaded. */
     private String Name;
 
-    /** The mime. */
+    /** The mime type. */
     private String mime;
 
-    /** The length. */
+    /** The length of the file. */
     private long length;
 
@@ -65 +65 @@
     private String processingStatus;
 
-    /** The processed. */
+    /** Whether this file has be proccessed (parsed and stored). */
     private boolean processed;
 

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/wsmodel/LogFileUploadResult.java

@@ -14 +14 @@
     private long id;
 
-    /** The status. */
+    /** The status message from the agent that processed this message. */
     private String status;
 

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/wsmodel/StatisticParameters.java

@@ -9 +9 @@
 import java.util.List;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.joda.time.DateTime;
 import org.joda.time.format.DateTimeFormat;
 import org.joda.time.format.DateTimeFormatter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import uk.ac.cardiff.model.report.Presentation;
@@ -20 +20 @@
 /**
  * @author philsmart
- *
+ * 
  */
-public class StatisticParameters implements Serializable{
-
-    /** generated serial ID  */
+public class StatisticParameters implements Serializable {
+
+    /** generated serial ID */
     private static final long serialVersionUID = 9135524508369102248L;
 
@@ -30 +30 @@
     private final Logger log = LoggerFactory.getLogger(StatisticParameters.class);
 
-    private static final String OUTPUT_DATE_FORMAT ="dd/MM/yyyy HH:mm:ss";;
-
+    /**
+     * a constant date format used to convert start and end times into a formant suitable for human consumption.
+     */
+    private static final String OUTPUT_DATE_FORMAT = "dd/MM/yyyy HH:mm:ss";;
+
+    /**
+     * The name of the statistic unit this {@link uk.ac.cardiff.model.wsmodel.StatisticParameters} is recording information about.
+     */
     private String unitName;
 
-    /** List of parameters passed into the <code>performStatistic</code> method*/
+    /** List of parameters passed into the <code>performStatistic</code> method */
     private List<MethodParameter> methodParameters;
 
@@ -46 +52 @@
     private DateTime endTime;
 
-    /** Its important that these dates (used for display in the view) are kept in sync with the
-     * Joda DateTime classes above*/
+    /**
+     * 
+     * The start date as a Java Date object. Its important that these dates (used for display in the view) are kept in sync with the Joda DateTime classes
+     * above. Used for remoting
+     */
     private Date startTimeJava;
+
+    /**
+     * The end date as a Java Date objects. Its important that these dates (used for display in the view) are kept in sync with the Joda DateTime classes above.
+     * Used for remoting
+     */
     private Date endTimeJava;
 
-    public enum ResourceCategory{
-        /** For resources that are internal to the organisation*/
-        INTERNAL(new int[]{1}),
-        /** For resources that are external to the organisation*/
-        EXTERNAL(new int[]{2}),
+    public enum ResourceCategory {
+        /** For resources that are internal to the organisation */
+        INTERNAL(new int[] { 1 }),
+        /** For resources that are external to the organisation */
+        EXTERNAL(new int[] { 2 }),
         /** For all resource categories */
-        ALL(new int[]{1,2});
+        ALL(new int[] { 1, 2 });
 
         private int[] resourceIdCategory;
 
-        ResourceCategory(int[] resourceIdCategory){
+        ResourceCategory(int[] resourceIdCategory) {
             this.resourceIdCategory = resourceIdCategory;
         }
@@ -73 +87 @@
 
         /**
-         * Returns a <code>String</code> value that represents
-         * an IN SQL operator which specifies the resourceIdCategory(s)
-         * for this <code>ResourceCategory</code> for use in SQL WHERE clauses
-         *
+         * Returns a <code>String</code> value that represents an IN SQL operator which specifies the resourceIdCategory(s) for this
+         * <code>ResourceCategory</code> for use in SQL WHERE clauses
+         * 
          * @return an SQL IN clause
          */
@@ -82 +95 @@
             StringBuilder sb = new StringBuilder();
             sb.append("in (");
-            for (int i=0; i < resourceIdCategory.length; i++){
+            for (int i = 0; i < resourceIdCategory.length; i++) {
                 sb.append(resourceIdCategory[i]);
-                if (i < resourceIdCategory.length-1){
+                if (i < resourceIdCategory.length - 1) {
                     sb.append(",");
                 }
@@ -97 +110 @@
     /** either system or user types */
     public enum StatisticType {
-        /**
-         * A statistic for use by the USER. Possibly removed in the future, in favour of individual
-         * user based statistics
-         */
-         USER,
-         /**
-          * A statistic for use by the system level processes, e.g. to generate dashboard
-          * statistics
-          */
-         SYSTEM};
+        /**
+         * A statistic for use by the USER. Possibly removed in the future, in favour of individual user based statistics
+         */
+        USER,
+        /**
+         * A statistic for use by the system level processes, e.g. to generate dashboard statistics
+         */
+        SYSTEM
+    };
 
     /** The type of statistic */
     private StatisticType type;
 
-    //TODO should be constructed in XML
-    /** The type of event from the information model this statistic should be performed over*/
-    public enum EventType{
-        /** A Shibboleth Authentication Event Type*/
-        SHIBBOLETH_AUTHENTICATION("ShibbolethIdpAuthenticationEvent", new String[]{"uk.ac.cardiff.model.event.ShibbolethIdpAuthenticationEvent","uk.ac.cardiff.model.event.AuthenticationEvent","uk.ac.cardiff.model.event.Event"}),
+    // TODO should be constructed in XML
+    /** The type of event from the information model this statistic should be performed over */
+    public enum EventType {
+        /** A Shibboleth Authentication Event Type */
+        SHIBBOLETH_AUTHENTICATION("ShibbolethIdpAuthenticationEvent", new String[] { "uk.ac.cardiff.model.event.ShibbolethIdpAuthenticationEvent", "uk.ac.cardiff.model.event.AuthenticationEvent",
+                "uk.ac.cardiff.model.event.Event" }),
         /** An Ezproxy Authentication Event Type */
-        EZPROXY_AUTHENTICATION("EzproxyAuthenticationEvent", new String[]{"uk.ac.cardiff.model.event.EzproxyAuthenticationEvent","uk.ac.cardiff.model.event.AuthenticationEvent","uk.ac.cardiff.model.event.Event"});
+        EZPROXY_AUTHENTICATION("EzproxyAuthenticationEvent", new String[] { "uk.ac.cardiff.model.event.EzproxyAuthenticationEvent", "uk.ac.cardiff.model.event.AuthenticationEvent",
+                "uk.ac.cardiff.model.event.Event" });
 
         private String hibernateSimpleClassName;
@@ -123 +137 @@
         private String[] classHierarchy;
 
-        private EventType(String hibernateSimpleClassName, String[] classHierarchy){
+        private EventType(String hibernateSimpleClassName, String[] classHierarchy) {
             this.hibernateSimpleClassName = hibernateSimpleClassName;
             this.classHierarchy = classHierarchy;
         }
 
-        public String getHibernateSimpleClassName(){
+        public String getHibernateSimpleClassName() {
             return hibernateSimpleClassName;
         }
 
-        public String[] getClassHierarchy(){
+        public String[] getClassHierarchy() {
             return classHierarchy;
         }
@@ -140 +154 @@
     private EventType eventType;
 
-
-    /* Configures the parameters used to view a graphical representation*/
+    /** Configures the parameters used to view a graphical representation */
     private Presentation presentation;
 
-    /* A series to plot on the graph*/
-     private List<Series> series;
-
-     /** Default constructor. */
-     public StatisticParameters(){
-         presentation = new Presentation();
-         presentation.setGraphTitle("");
-         presentation.setxAxisLabel("");
-         presentation.setyAxisLabel("");
-         setSeries(new ArrayList<Series>());
-         resourceCategory = ResourceCategory.ALL;
-     }
+    /** A series to plot on the graph */
+    private List<Series> series;
+
+    /** Default constructor. */
+    public StatisticParameters() {
+        presentation = new Presentation();
+        presentation.setGraphTitle("");
+        presentation.setxAxisLabel("");
+        presentation.setyAxisLabel("");
+        setSeries(new ArrayList<Series>());
+        resourceCategory = ResourceCategory.ALL;
+    }
 
     public void setUnitName(String unitName) {
-        this.unitName = unitName;
+        this.unitName = unitName;
     }
 
     public String getUnitName() {
-        return unitName;
-    }
-
+        return unitName;
+    }
 
     public void setMethodParams(List<MethodParameter> methodParams) {
-        this.methodParameters = methodParams;
+        this.methodParameters = methodParams;
     }
 
     public List<MethodParameter> getMethodParams() {
-        return methodParameters;
-    }
-
-    /**
-     * This method should be used as the primary method for setting the startTime on
-     * this class
+        return methodParameters;
+    }
+
+    /**
+     * This method should be used as the primary method for setting the startTime on this class
+     * 
      * @param startTime
      */
     public void setStartTime(DateTime startTime) {
-        this.startTime = startTime;
-        this.startTimeJava = new Date (this.startTime.getMillis());
+        this.startTime = startTime;
+        this.startTimeJava = new Date(this.startTime.getMillis());
     }
 
     public DateTime getStartTimeAsDate() {
-        return startTime;
-    }
-
-    /**
-     * This method should be used as the primary method for setting the endTime on
-     * this class
+        return startTime;
+    }
+
+    /**
+     * This method should be used as the primary method for setting the endTime on this class
+     * 
      * @param endTime
      */
     public void setEndTime(DateTime endTime) {
-        this.endTime = endTime;
+        this.endTime = endTime;
     }
 
     public DateTime getEndTimeAsDate() {
-        return endTime;
+        return endTime;
     }
 
     public void setStartTime(String startTime) {
-        this.startTime = formatDate(startTime, false);
-        this.startTimeJava = new Date (this.startTime.getMillis());
+        this.startTime = formatDate(startTime, false);
+        this.startTimeJava = new Date(this.startTime.getMillis());
 
     }
 
     public String getStartTime() {
-        if (startTime!=null)return startTime.toString(OUTPUT_DATE_FORMAT);
-        return null;
+        if (startTime != null)
+            return startTime.toString(OUTPUT_DATE_FORMAT);
+        return null;
     }
 
     public void setEndTime(String endTime) {
-        this.endTime = formatDate(endTime, true);
-        this.endTimeJava = new Date (this.endTime.getMillis());
+        this.endTime = formatDate(endTime, true);
+        this.endTimeJava = new Date(this.endTime.getMillis());
     }
 
     public String getEndTime() {
-        if (endTime!=null)return endTime.toString(OUTPUT_DATE_FORMAT);
-        return null;
-    }
-
+        if (endTime != null)
+            return endTime.toString(OUTPUT_DATE_FORMAT);
+        return null;
+    }
 
     /**
      * for output on the web page (just a date that can be rendered by trinidad)
+     * 
      * @return
      */
-    public Date getEndTimeAsJavaDate(){
-        return endTimeJava;
+    public Date getEndTimeAsJavaDate() {
+        return endTimeJava;
 
     }
@@ -234 +248 @@
     /**
      * for output on the web page
+     * 
      * @param date
      */
-    public Date getStartTimeAsJavaDate(){
-        return startTimeJava;
-    }
-
-
-    public void setEndTimeAsJavaDate(Date date){
-        this.endTimeJava = date;
-        this.endTime = new DateTime(date);
-    }
-
-    public void setStartTimeAsJavaDate(Date date){
-        this.startTimeJava = date;
-        this.startTime = new DateTime(date);
-    }
-
-    /* human consumable outputs */
+    public Date getStartTimeAsJavaDate() {
+        return startTimeJava;
+    }
+
+    public void setEndTimeAsJavaDate(Date date) {
+        this.endTimeJava = date;
+        this.endTime = new DateTime(date);
+    }
+
+    public void setStartTimeAsJavaDate(Date date) {
+        this.startTimeJava = date;
+        this.startTime = new DateTime(date);
+    }
 
     public String getStartTimeAsFormattedString() {
-        DateTimeFormatter dtf = DateTimeFormat.forPattern(OUTPUT_DATE_FORMAT);
-        if (getStartTime() != null)
-            return getStartTimeAsDate().toString(dtf);
-        else
-            return "First Entry";
+        DateTimeFormatter dtf = DateTimeFormat.forPattern(OUTPUT_DATE_FORMAT);
+        if (getStartTime() != null)
+            return getStartTimeAsDate().toString(dtf);
+        else
+            return "First Entry";
     }
 
     public String getEndTimeAsFormattedString() {
-        DateTimeFormatter dtf = DateTimeFormat.forPattern(OUTPUT_DATE_FORMAT);
-        if (getEndTime() != null)
-            return getEndTimeAsDate().toString(dtf);
-        else
-            return "Last Entry";
-    }
-
+        DateTimeFormatter dtf = DateTimeFormat.forPattern(OUTPUT_DATE_FORMAT);
+        if (getEndTime() != null)
+            return getEndTimeAsDate().toString(dtf);
+        else
+            return "Last Entry";
+    }
 
     /**
      * <p>
      * </p>
-     *
+     * 
      * @param date
-     * @param isEndTime- if is endTime and only ddMMyyyy is given, then the endTime should be 23.59 as opposed to 00.00 as this is the end of the day
+     * @param isEndTime
+     *            - if is endTime and only ddMMyyyy is given, then the endTime should be 23.59 as opposed to 00.00 as this is the end of the day
      * @return
      */
     private DateTime formatDate(String date, boolean isEndTime) {
-        /* this is not a nice hack, please tidy */
-        //log.debug("Date format being parsed {} with {} characters",date,date.length());
-        if (date.length() == 8) {
-            // assume ddMMyyy
-            String format = "ddMMyyyy";
-            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
-            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
-            if (isEndTime) {
-                dt = new DateTime(dt.getMillis() + 86340000); // where 86340000 is 23.59 hours
-            }
-         //   log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" + dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
-            return dt;
-        } else if (date.length() == 15) {
-            // assume yyyyMMdd'T'HHmmss
-            String format = "yyyyMMdd'T'HHmmss";
-            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
-            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
-        //    log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" + dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
-            return dt;
-        } else if (date.length()==19){
-            // assume outputDateFormat
-            String format = OUTPUT_DATE_FORMAT;
-            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
-            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
-         //   log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" + dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
-            return dt;
-        }
-        //which is instantiated with the current date and time
-        return new DateTime();
-    }
-
-    /** methods to get and set the minutes seconds and hours of end and start time (for the web interface)*/
-
-    public void setEndTimeHour(int hour){
-        DateTime newTime = new DateTime(endTime.getYear(),endTime.getMonthOfYear(),endTime.getDayOfMonth(),
-                hour, endTime.getMinuteOfHour(), endTime.getSecondOfMinute(), endTime.getMillisOfSecond());
-        endTime = newTime;
-        endTimeJava = new Date(endTime.getMillis());
-    }
-    public void setEndTimeMinute(int minutes){
-        DateTime newTime = new DateTime(endTime.getYear(),endTime.getMonthOfYear(),endTime.getDayOfMonth(),
-                endTime.getHourOfDay(), minutes, endTime.getSecondOfMinute(), endTime.getMillisOfSecond());
-        endTime = newTime;
-        endTimeJava = new Date(endTime.getMillis());
-    }
-    public void setEndTimeSecond(int seconds){
-        DateTime newTime = new DateTime(endTime.getYear(),endTime.getMonthOfYear(),endTime.getDayOfMonth(),
-                endTime.getHourOfDay(), endTime.getMinuteOfHour(), seconds, endTime.getMillisOfSecond());
-        endTime = newTime;
-        endTimeJava = new Date(endTime.getMillis());
-    }
-    public int getEndTimeHour(){
-        if (endTime!=null)
-            return endTime.getHourOfDay();
-        return 0;
-    }
-    public int getEndTimeMinute(){
-        if (endTime!=null)
-            return endTime.getMinuteOfHour();
-        return 0;
-    }
-    public int getEndTimeSecond(){
-        if (endTime!=null)
-            return endTime.getSecondOfMinute();
-        return 0;
-    }
-
-    public void setStartTimeHour(int hour){
-        DateTime newTime = new DateTime(startTime.getYear(),startTime.getMonthOfYear(),startTime.getDayOfMonth(),
-                hour, startTime.getMinuteOfHour(), startTime.getSecondOfMinute(), startTime.getMillisOfSecond());
-        startTime = newTime;
-        startTimeJava = new Date(startTime.getMillis());
-    }
-    public void setStartTimeMinute(int minutes){
-        DateTime newTime = new DateTime(startTime.getYear(),startTime.getMonthOfYear(),startTime.getDayOfMonth(),
-                startTime.getHourOfDay(), minutes, startTime.getSecondOfMinute(), startTime.getMillisOfSecond());
-        startTime = newTime;
-        startTimeJava = new Date(startTime.getMillis());
-    }
-    public void setStartTimeSecond(int seconds){
-        DateTime newTime = new DateTime(startTime.getYear(),startTime.getMonthOfYear(),startTime.getDayOfMonth(),
-                startTime.getHourOfDay(), startTime.getMinuteOfHour(), seconds, startTime.getMillisOfSecond());
-        startTime = newTime;
-        startTimeJava = new Date(startTime.getMillis());
-    }
-    public int getStartTimeHour(){
-        if (startTime!=null)
-            return startTime.getHourOfDay();
-        return 0;
-    }
-    public int getStartTimeMinute(){
-        if (startTime!=null)
-            return startTime.getMinuteOfHour();
-        return 0;
-    }
-    public int getStartTimeSecond(){
-        if (startTime!=null)
-            return startTime.getSecondOfMinute();
-        return 0;
+        // TODO this is not a nice hack, please tidy
+        // log.debug("Date format being parsed {} with {} characters",date,date.length());
+        if (date.length() == 8) {
+            // assume ddMMyyy
+            String format = "ddMMyyyy";
+            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
+            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
+            if (isEndTime) {
+                dt = new DateTime(dt.getMillis() + 86340000); // where 86340000 is 23.59 hours
+            }
+            // log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" +
+            // dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
+            return dt;
+        } else if (date.length() == 15) {
+            // assume yyyyMMdd'T'HHmmss
+            String format = "yyyyMMdd'T'HHmmss";
+            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
+            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
+            // log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" +
+            // dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
+            return dt;
+        } else if (date.length() == 19) {
+            // assume outputDateFormat
+            String format = OUTPUT_DATE_FORMAT;
+            DateTimeFormatter dtf = DateTimeFormat.forPattern(format);
+            DateTime dt = dtf.parseDateTime(date.substring(0, date.length()));
+            // log.debug("time set to " + dt.getDayOfMonth() + "th " + dt.getMonthOfYear() + " " + dt.getYear() + " " + dt.getHourOfDay() + ":" +
+            // dt.getMinuteOfHour() + ":" + dt.getSecondOfMinute() + " for " + getUnitName());
+            return dt;
+        }
+        // which is instantiated with the current date and time
+        return new DateTime();
+    }
+
+    /** methods to get and set the minutes seconds and hours of end and start time (for the web interface) */
+
+    public void setEndTimeHour(int hour) {
+        DateTime newTime = new DateTime(endTime.getYear(), endTime.getMonthOfYear(), endTime.getDayOfMonth(), hour, endTime.getMinuteOfHour(), endTime.getSecondOfMinute(), endTime.getMillisOfSecond());
+        endTime = newTime;
+        endTimeJava = new Date(endTime.getMillis());
+    }
+
+    public void setEndTimeMinute(int minutes) {
+        DateTime newTime = new DateTime(endTime.getYear(), endTime.getMonthOfYear(), endTime.getDayOfMonth(), endTime.getHourOfDay(), minutes, endTime.getSecondOfMinute(), endTime.getMillisOfSecond());
+        endTime = newTime;
+        endTimeJava = new Date(endTime.getMillis());
+    }
+
+    public void setEndTimeSecond(int seconds) {
+        DateTime newTime = new DateTime(endTime.getYear(), endTime.getMonthOfYear(), endTime.getDayOfMonth(), endTime.getHourOfDay(), endTime.getMinuteOfHour(), seconds, endTime.getMillisOfSecond());
+        endTime = newTime;
+        endTimeJava = new Date(endTime.getMillis());
+    }
+
+    public int getEndTimeHour() {
+        if (endTime != null)
+            return endTime.getHourOfDay();
+        return 0;
+    }
+
+    public int getEndTimeMinute() {
+        if (endTime != null)
+            return endTime.getMinuteOfHour();
+        return 0;
+    }
+
+    public int getEndTimeSecond() {
+        if (endTime != null)
+            return endTime.getSecondOfMinute();
+        return 0;
+    }
+
+    public void setStartTimeHour(int hour) {
+        DateTime newTime = new DateTime(startTime.getYear(), startTime.getMonthOfYear(), startTime.getDayOfMonth(), hour, startTime.getMinuteOfHour(), startTime.getSecondOfMinute(),
+                startTime.getMillisOfSecond());
+        startTime = newTime;
+        startTimeJava = new Date(startTime.getMillis());
+    }
+
+    public void setStartTimeMinute(int minutes) {
+        DateTime newTime = new DateTime(startTime.getYear(), startTime.getMonthOfYear(), startTime.getDayOfMonth(), startTime.getHourOfDay(), minutes, startTime.getSecondOfMinute(),
+                startTime.getMillisOfSecond());
+        startTime = newTime;
+        startTimeJava = new Date(startTime.getMillis());
+    }
+
+    public void setStartTimeSecond(int seconds) {
+        DateTime newTime = new DateTime(startTime.getYear(), startTime.getMonthOfYear(), startTime.getDayOfMonth(), startTime.getHourOfDay(), startTime.getMinuteOfHour(), seconds,
+                startTime.getMillisOfSecond());
+        startTime = newTime;
+        startTimeJava = new Date(startTime.getMillis());
+    }
+
+    public int getStartTimeHour() {
+        if (startTime != null)
+            return startTime.getHourOfDay();
+        return 0;
+    }
+
+    public int getStartTimeMinute() {
+        if (startTime != null)
+            return startTime.getMinuteOfHour();
+        return 0;
+    }
+
+    public int getStartTimeSecond() {
+        if (startTime != null)
+            return startTime.getSecondOfMinute();
+        return 0;
     }
 
     public void setStatisticType(String type) {
-        type = type.toUpperCase();
-        for (StatisticType thisType : StatisticType.values()){
-            if (thisType.toString().equals(type)){
-                this.type=thisType;
-                return;
-            }
-        }
-        //set default
-        this.type = StatisticType.USER;
+        type = type.toUpperCase();
+        for (StatisticType thisType : StatisticType.values()) {
+            if (thisType.toString().equals(type)) {
+                this.type = thisType;
+                return;
+            }
+        }
+        // set default
+        this.type = StatisticType.USER;
     }
 
     public void setType(StatisticType type) {
-        this.type = type;
+        this.type = type;
     }
 
     public StatisticType getType() {
-        return type;
+        return type;
     }
 
     public void setPresentation(Presentation presentation) {
-        this.presentation = presentation;
+        this.presentation = presentation;
     }
 
     public Presentation getPresentation() {
-        return presentation;
-    }
-
+        return presentation;
+    }
 
     public void setSeries(List<Series> series) {
-        this.series = series;
+        this.series = series;
     }
 
     public List<Series> getSeries() {
-        return series;
+        return series;
     }
 
@@ -422 +443 @@
 
     public void setEventTypeString(String eventType) {
-        for (EventType type : EventType.values()){
-            if (type.toString().equals(eventType)){
+        for (EventType type : EventType.values()) {
+            if (type.toString().equals(eventType)) {
                 this.eventType = type;
             }
@@ -429 +450 @@
     }
 
-    public String getEventTypeString(){
+    public String getEventTypeString() {
         return eventType.toString();
     }
@@ -438 +459 @@
 
     /**
-     * @param resourceCategory the resourceCategory to set
+     * @param resourceCategory
+     *            the resourceCategory to set
      */
     public void setResourceCategory(ResourceCategory resourceCategory) {
@@ -451 +473 @@
     }
 
-    public void setResourceCategoryString(String resourceCategory){
-        for (ResourceCategory type : ResourceCategory.values()){
-            if (type.toString().equals(resourceCategory)){
+    public void setResourceCategoryString(String resourceCategory) {
+        for (ResourceCategory type : ResourceCategory.values()) {
+            if (type.toString().equals(resourceCategory)) {
                 this.resourceCategory = type;
             }
@@ -459 +481 @@
     }
 
-    public String getResourceCategoryString(){
+    public String getResourceCategoryString() {
         return resourceCategory.toString();
     }
 
-
-
-
 }

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/model/wsmodel/SuggestionValues.java

@@ -8 +8 @@
 import org.slf4j.LoggerFactory;
 
+/**
+ * The Class SuggestionValues.
+ */
 public class SuggestionValues implements Serializable {
 
-    /**
-     * default serial UId
-     */
+    /** default serial UId. */
     private static final long serialVersionUID = 7312337340123235532L;
 
-    /** Class logger */
+    /** Class logger. */
     private final Logger log = LoggerFactory.getLogger(SuggestionValues.class);
 
-    /** The names of all fields from the information model */
+    /** The names of all fields from the information model. */
     private List<Suggestion> possibleFieldNameValues;
 
-    /** The possible values of all known fields from the information model */
+    /** The possible values of all known fields from the information model. */
     private List<Suggestion> possibleFieldValues;
 
+    /** The possible post processors. */
     private List<Suggestion> possiblePostProcessors;
 
+    /**
+     * Sets the possible field name values.
+     * 
+     * @param possibleFieldNameValues
+     *            the new possible field name values
+     */
     public void setPossibleFieldNameValues(List<Suggestion> possibleFieldNameValues) {
         this.possibleFieldNameValues = possibleFieldNameValues;
     }
 
+    /**
+     * Gets the possible field name values.
+     * 
+     * @return the possible field name values
+     */
     public List<Suggestion> getPossibleFieldNameValues() {
         return possibleFieldNameValues;
     }
 
+    /**
+     * Gets the possible field name values list.
+     * 
+     * @return the possible field name values list
+     */
     public List<String> getPossibleFieldNameValuesList() {
         ArrayList<String> fields = new ArrayList<String>();
@@ -44 +62 @@
     }
 
+    /**
+     * Gets the possible field name values list.
+     * 
+     * @param classFilters
+     *            the class filters
+     * @return the possible field name values list
+     */
     public List<String> getPossibleFieldNameValuesList(String[] classFilters) {
         ArrayList<String> fields = new ArrayList<String>();
@@ -58 +83 @@
     }
 
+    /**
+     * Autocomplete.
+     * 
+     * @param fieldName
+     *            the field name
+     * @return the array list
+     */
     public ArrayList<String> autocomplete(String fieldName) {
         log.debug("Suggesting values for selectedfield {}", fieldName);
@@ -71 +103 @@
 
     /**
+     * Sets the possible field values.
+     * 
      * @param possibleFieldValues
      *            the possibleFieldValues to set
@@ -79 +113 @@
 
     /**
+     * Gets the possible field values.
+     * 
      * @return the possibleFieldValues
      */
@@ -86 +122 @@
 
     /**
+     * Sets the possible post processors.
+     * 
      * @param possiblePostProcessors
      *            the possiblePostProcessors to set
@@ -94 +132 @@
 
     /**
+     * Gets the possible post processors.
+     * 
      * @return the possiblePostProcessors
      */
@@ -100 +140 @@
     }
 
+    /**
+     * Gets the possible post processor values list.
+     * 
+     * @return the possible post processor values list
+     */
     public ArrayList<String> getPossiblePostProcessorValuesList() {
         ArrayList<String> fields = new ArrayList<String>();

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/utility/EqualsUtil.java

@@ -4 +4 @@
 package uk.ac.cardiff.utility;
 
-import java.util.Arrays;
 
 /**
-* Collected methods which allow easy implementation of <code>equals</code>.
-* taken from http://www.javapractices.com/
-*
-* Example use case in a class called Car:
-* <pre>
-public boolean equals(Object aThat){
-  if ( this == aThat ) return true;
-  if ( !(aThat instanceof Car) ) return false;
-  Car that = (Car)aThat;
-  return
-    EqualsUtil.areEqual(this.fName, that.fName) &&
-    EqualsUtil.areEqual(this.fNumDoors, that.fNumDoors) &&
-    EqualsUtil.areEqual(this.fGasMileage, that.fGasMileage) &&
-    EqualsUtil.areEqual(this.fColor, that.fColor) &&
-    Arrays.equals(this.fMaintenanceChecks, that.fMaintenanceChecks); //array!
-}
-* </pre>
-*
-* <em>Arrays are not handled by this class</em>.
-* This is because the <code>Arrays.equals</code> methods should be used for
-* array fields.
-*/
+ * Collected methods which allow easy implementation of <code>equals</code>. taken from http://www.javapractices.com/
+ * 
+ * Example use case in a class called Car:
+ * 
+ * <pre>
+ * public boolean equals(Object aThat) {
+ *     if (this == aThat)
+ *         return true;
+ *     if (!(aThat instanceof Car))
+ *         return false;
+ *     Car that = (Car) aThat;
+ *     return EqualsUtil.areEqual(this.fName, that.fName) &amp;&amp; EqualsUtil.areEqual(this.fNumDoors, that.fNumDoors) &amp;&amp; EqualsUtil.areEqual(this.fGasMileage, that.fGasMileage)
+ *             &amp;&amp; EqualsUtil.areEqual(this.fColor, that.fColor) &amp;&amp; Arrays.equals(this.fMaintenanceChecks, that.fMaintenanceChecks); // array!
+ * }
+ * </pre>
+ * 
+ * <em>Arrays are not handled by this class</em>. This is because the <code>Arrays.equals</code> methods should be used for array fields.
+ */
 public final class EqualsUtil {
 
-  static public boolean areEqual(boolean aThis, boolean aThat){
-    //System.out.println("boolean");
-    return aThis == aThat;
-  }
+    static public boolean areEqual(boolean aThis, boolean aThat) {
+        return aThis == aThat;
+    }
 
-  static public boolean areEqual(char aThis, char aThat){
-    //System.out.println("char");
-    return aThis == aThat;
-  }
+    static public boolean areEqual(char aThis, char aThat) {
+        return aThis == aThat;
+    }
 
-  static public boolean areEqual(long aThis, long aThat){
-    /*
-    * Implementation Note
-    * Note that byte, short, and int are handled by this method, through
-    * implicit conversion.
-    */
-    //System.out.println("long");
-    return aThis == aThat;
-  }
+    static public boolean areEqual(long aThis, long aThat) {
+        /*
+         * Implementation Note Note that byte, short, and int are handled by this method, through implicit conversion.
+         */
+        return aThis == aThat;
+    }
 
-  static public boolean areEqual(float aThis, float aThat){
-    //System.out.println("float");
-    return Float.floatToIntBits(aThis) == Float.floatToIntBits(aThat);
-  }
+    static public boolean areEqual(float aThis, float aThat) {
+        return Float.floatToIntBits(aThis) == Float.floatToIntBits(aThat);
+    }
 
-  static public boolean areEqual(double aThis, double aThat){
-    //System.out.println("double");
-    return Double.doubleToLongBits(aThis) == Double.doubleToLongBits(aThat);
-  }
+    static public boolean areEqual(double aThis, double aThat) {
+        return Double.doubleToLongBits(aThis) == Double.doubleToLongBits(aThat);
+    }
 
-  /**
-  * Possibly-null object field.
-  *
-  * Includes type-safe enumerations and collections, but does not include
-  * arrays. See class comment.
-  */
-  static public boolean areEqual(Object aThis, Object aThat){
-    //System.out.println("Object");
-    return aThis == null ? aThat == null : aThis.equals(aThat);
-  }
+    /**
+     * Possibly-null object field.
+     * 
+     * Includes type-safe enumerations and collections, but does not include arrays. See class comment.
+     */
+    static public boolean areEqual(Object aThis, Object aThat) {
+        // System.out.println("Object");
+        return aThis == null ? aThat == null : aThis.equals(aThat);
+    }
 }

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/utility/HashCodeUtil.java

@@ -5 +5 @@
 /**
  * Collected methods which allow easy implementation of <code>hashCode</code>. as taken from http://www.javapractices.com/
- *
+ * 
  * Example use case:
- *
+ * 
  * <pre>
  * public int hashCode() {
  *     int result = HashCodeUtil.SEED;
- *     //collect the contributions of various fields
+ *     // collect the contributions of various fields
  *     result = HashCodeUtil.hash(result, fPrimitive);
  *     result = HashCodeUtil.hash(result, fObject);
@@ -31 +31 @@
      */
     public static int hash(int aSeed, boolean aBoolean) {
-        //System.out.println("boolean...");
-        return firstTerm(aSeed) + (aBoolean ? 1 : 0);
+        return firstTerm(aSeed) + (aBoolean ? 1 : 0);
     }
 
@@ -39 +38 @@
      */
     public static int hash(int aSeed, char aChar) {
-        //System.out.println("char...");
-        return firstTerm(aSeed) + (int) aChar;
+        return firstTerm(aSeed) + (int) aChar;
     }
 
@@ -47 +45 @@
      */
     public static int hash(int aSeed, int aInt) {
-        /*
-         * Implementation Note Note that byte and short are handled by this method, through implicit conversion.
-         */
-        //System.out.println("int...");
-        return firstTerm(aSeed) + aInt;
+        /*
+         * Implementation Note Note that byte and short are handled by this method, through implicit conversion.
+         */
+        return firstTerm(aSeed) + aInt;
     }
 
@@ -58 +55 @@
      */
     public static int hash(int aSeed, long aLong) {
-        //System.out.println("long...");
-        return firstTerm(aSeed) + (int) (aLong ^ (aLong >>> 32));
+        return firstTerm(aSeed) + (int) (aLong ^ (aLong >>> 32));
     }
 
@@ -66 +62 @@
      */
     public static int hash(int aSeed, float aFloat) {
-        return hash(aSeed, Float.floatToIntBits(aFloat));
+        return hash(aSeed, Float.floatToIntBits(aFloat));
     }
 
@@ -73 +69 @@
      */
     public static int hash(int aSeed, double aDouble) {
-        return hash(aSeed, Double.doubleToLongBits(aDouble));
+        return hash(aSeed, Double.doubleToLongBits(aDouble));
     }
-
 
     /**
      * <code>aObject</code> is a possibly-null object field, and possibly an array.
-     *
+     * 
      * If <code>aObject</code> is an array, then each element may be a primitive or a possibly-null object.
      */
     public static int hash(int aSeed, Object aObject) {
-        int result = aSeed;
-        if (aObject == null) {
-            result = hash(result, 0);
-        } else if (!isArray(aObject)) {
-            result = hash(result, aObject.hashCode());
-        } else {
-            int length = Array.getLength(aObject);
-            for (int idx = 0; idx < length; ++idx) {
-                Object item = Array.get(aObject, idx);
-                // recursive call!
-                result = hash(result, item);
-            }
-        }
-        return result;
+        int result = aSeed;
+        if (aObject == null) {
+            result = hash(result, 0);
+        } else if (!isArray(aObject)) {
+            result = hash(result, aObject.hashCode());
+        } else {
+            int length = Array.getLength(aObject);
+            for (int idx = 0; idx < length; ++idx) {
+                Object item = Array.get(aObject, idx);
+                // recursive call!
+                result = hash(result, item);
+            }
+        }
+        return result;
     }
 
-    // / PRIVATE ///
     private static final int fODD_PRIME_NUMBER = 37;
 
     private static int firstTerm(int aSeed) {
-        return fODD_PRIME_NUMBER * aSeed;
+        return fODD_PRIME_NUMBER * aSeed;
     }
 
     private static boolean isArray(Object aObject) {
-        return aObject.getClass().isArray();
+        return aObject.getClass().isArray();
     }
 

raptor-information-model/trunk/src/main/java/uk/ac/cardiff/utility/StringUtils.java

@@ -7 +7 @@
 public class StringUtils {
 
+    /**
+     * Used to construct a string representation of all field value pairs in the object <code>obj</code> passed in as a parameter to the method. It does this
+     * using reflection.
+     * 
+     * @param obj
+     *            the object from which to construct a string representation from.
+     * @return a <code>String</code> representation of this object.
+     */
     public static String buildToString(Object obj) {
         Method[] methods = obj.getClass().getMethods();