Merged with develop. Fixed many bugs in Visualiser.

#bugs

src/main/java/seng302/model/stream/parser/MarkRoundingData.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers;
+package seng302.model.stream.parser;
 
 
 /**
@@ -11,7 +11,7 @@ public class MarkRoundingData {
     private int roundingSide;
     private long timeStamp;
 
-    public MarkRoundingData(int boatId, int markId, int roundingSide, long timeStamp) {
+    MarkRoundingData(int boatId, int markId, int roundingSide, long timeStamp) {
         this.boatId = boatId;
         this.markId = markId;
         this.roundingSide = roundingSide;

src/main/java/seng302/model/stream/parser/PositionUpdateData.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers;
+package seng302.model.stream.parser;
 
 public class PositionUpdateData {
 
@@ -14,7 +14,7 @@ public class PositionUpdateData {
     private double heading;
     private double groundSpeed;
 
-    public PositionUpdateData(int deviceId, DeviceType type, double lat, double lon,
+    PositionUpdateData(int deviceId, DeviceType type, double lat, double lon,
         double heading, double groundSpeed) {
         this.deviceId = deviceId;
         this.type = type;

src/main/java/seng302/model/stream/parser/RaceStartData.java

@@ -1,16 +1,16 @@
-package seng302.model.stream.parsers;
+package seng302.model.stream.parser;
 
 /**
  * Class for storing data parsed from race start status packet
  */
 public class RaceStartData {
 
-    long raceId;
-    long raceStartTime;
-    int notificationType;
-    long timeStamp;
+    private long raceId;
+    private long raceStartTime;
+    private int notificationType;
+    private long timeStamp;
 
-    public RaceStartData (long raceId, long raceStartTime, int notificationType, long timeStamp) {
+    RaceStartData (long raceId, long raceStartTime, int notificationType, long timeStamp) {
         this.raceId = raceId;
         this.raceStartTime = raceStartTime;
         this.notificationType = notificationType;

src/main/java/seng302/model/stream/parser/RaceStatusData.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers;
+package seng302.model.stream.parser;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -17,9 +17,9 @@ public class RaceStatusData {
     private boolean raceStarted = false;
     private long currentTime;
     private long expectedStartTime;
-    List<long[]> boatData = new ArrayList<>();
+    private List<long[]> boatData = new ArrayList<>();
 
-    public RaceStatusData(
+    RaceStatusData(
         long windDir, long rawWindSpeed, int raceStatus, long currentTime, long expectedStartTime) {
 
         windDirection = windDir / WIND_DIR_FACTOR;
@@ -29,7 +29,7 @@ public class RaceStatusData {
         this.expectedStartTime = expectedStartTime;
     }
 
-    public void addBoatData (long boatID, long estTimeToNextMark, long estTimeToFinish, int leg) {
+    void addBoatData (long boatID, long estTimeToNextMark, long estTimeToFinish, int leg) {
         boatData.add(new long[] {boatID, estTimeToNextMark, estTimeToFinish, leg});
     }
 

src/main/java/seng302/model/stream/parser/StreamParser.java

@@ -1,6 +1,6 @@
-package seng302.model.stream.parsers;
+package seng302.model.stream.parser;
 
-import seng302.model.stream.parsers.PositionUpdateData.DeviceType;
+import seng302.model.stream.parser.PositionUpdateData.DeviceType;
 import java.io.IOException;
 import java.io.StringReader;
 import java.util.ArrayList;
@@ -14,7 +14,6 @@ import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 import seng302.model.stream.packets.PacketType;
 import seng302.model.stream.packets.StreamPacket;
-import seng302.model.stream.parsers.xml.RegattaXMLData;
 
 /**
  * StreamParser is a utilities class for taking byte data, formatted according to the AC35

src/main/java/seng302/model/stream/xml/generator/Race.java

@@ -0,0 +1,52 @@
+package seng302.model.stream.xml.generator;
+
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import seng302.model.Yacht;
+
+/**
+ * A Race object that can be parsed into XML
+ */
+public class Race {
+    private List<Yacht> yachts;
+    private LocalDateTime startTime;
+
+    public Race(){
+        yachts = new ArrayList<>();
+        startTime = LocalDateTime.now();
+    }
+
+    /**
+     * Add a boat to the race
+     * @param yacht The boat to add
+     */
+    public void addBoat(Yacht yacht){
+        yachts.add(yacht);
+    }
+
+    /**
+     * Get a list of boats in the race
+     * @return A List of boats
+     */
+    public List<Yacht> getBoats(){
+        return Collections.unmodifiableList(yachts);
+    }
+
+    /**
+     * Set the time until the race starts
+     * @param seconds The time in seconds until the race starts
+     */
+    public void setRaceStartDelay(Integer seconds){
+        startTime = startTime.plusMinutes(seconds);
+    }
+
+    /**
+     * Get the time the race starts
+     * @return The time the race starts
+     */
+    public String getRaceStartTime(){
+        return startTime.toString();
+    }
+}

src/main/java/seng302/model/stream/xml/generator/Regatta.java

@@ -0,0 +1,77 @@
+package seng302.model.stream.xml.generator;
+
+/**
+ * A Race regatta that can be parsed into XML
+ */
+public class Regatta {
+  private final Double DEFAULT_ALTITUDE = 0d;
+  private final Integer DEFAULT_REGATTA_ID = 0;
+
+  private Integer id;
+  private String name;
+  private String courseName;
+
+  private Double latitude;
+  private Double longitude;
+  private Double altitude;
+
+  private Integer utcOffset;
+  private Double magneticVariation;
+
+  public Regatta(String name, Double latitude, Double longitude) {
+      this.name = name;
+      this.id = DEFAULT_REGATTA_ID;
+      this.courseName = name;
+
+      this.latitude = latitude;
+      this.longitude = longitude;
+      this.altitude = DEFAULT_ALTITUDE;
+
+      this.utcOffset = 0;
+      this.magneticVariation = 0d;
+  }
+
+  public void setMagneticVariation(Double magneticVariation){
+      this.magneticVariation = magneticVariation;
+  }
+
+  public void setUtcOffset(Integer offset){
+    this.utcOffset = offset;
+  }
+
+  /*
+  NOTE!! The following getters must follow the JavaBean standard (getPropertyName()), and must be public.
+   */
+
+  public String getName(){
+      return name;
+  }
+
+  public String getCourseName(){
+      return courseName;
+  }
+
+  public Integer getRegattaId(){
+      return id;
+  }
+
+  public Double getLatitude() {
+      return latitude;
+  }
+
+  public Double getLongitude() {
+      return longitude;
+  }
+
+  public Double getAltitude() {
+      return altitude;
+  }
+
+  public Integer getUtcOffset(){
+      return utcOffset;
+  }
+
+  public Double getMagneticVariation(){
+      return magneticVariation;
+  }
+}

src/main/java/seng302/model/stream/xml/generator/XMLGenerator.java

@@ -0,0 +1,159 @@
+package seng302.model.stream.xml.generator;
+
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+import freemarker.template.TemplateException;
+import seng302.server.messages.XMLMessageSubType;
+
+import java.io.*;
+
+/**
+ * An XML generator to generate the Race, Boat, and Regatta XML dynamically
+ */
+public class XMLGenerator {
+    private static final String XML_TEMPLATE_DIR = "/server_config/xml_templates";
+    private static final String REGATTA_TEMPLATE_NAME = "regatta.ftlh";
+    private static final String BOATS_TEMPLATE_NAME = "boats.ftlh";
+    private static final String RACE_TEMPLATE_NAME = "race.ftlh";
+    private Configuration configuration;
+    private Regatta regatta;
+    private Race race;
+
+    /**
+     * Set up a configuration instance for Apache Freemake
+     */
+    private void setupConfiguration() {
+        configuration = new Configuration(Configuration.VERSION_2_3_26);
+
+        try {
+            configuration.setClassForTemplateLoading(getClass(), XML_TEMPLATE_DIR);
+        } catch (NullPointerException e){
+            System.out.println("[FATAL] Server could not load XML Template directory, ensure this directory isn't empty");
+        }
+    }
+
+    /**
+     * Create an instance of the XML Generator
+     */
+    public XMLGenerator(){
+        setupConfiguration();
+    }
+
+    /**
+     * Set the race regatta to send to players
+     * Note: This must be set before a regatta message can be generated
+     * @param regatta The race regatta
+     */
+    public void setRegatta(Regatta regatta){
+        this.regatta = regatta;
+    }
+
+    /**
+     * Set the race to send to players
+     * Note: This must be set before a boat or race message can be generated
+     * @param race The race
+     */
+    public void setRace(Race race){
+        this.race = race;
+    }
+
+    /**
+     * Parse an XML template and generate the output as a string
+     * @param templateName The templates file name
+     * @param type The XML message sub type
+     */
+    private String parseToXmlString(String templateName, XMLMessageSubType type) throws IOException, TemplateException {
+        Template template;
+        ByteArrayOutputStream os = new ByteArrayOutputStream();
+        OutputStreamWriter writer = new OutputStreamWriter(os);
+
+        template = configuration.getTemplate(templateName);
+
+        switch (type) {
+            case REGATTA:
+                template.process(regatta, writer);
+                break;
+
+            case BOAT:
+                template.process(race, writer);
+                break;
+
+            case RACE:
+                template.process(race, writer);
+                break;
+
+            default:
+                throw new UnsupportedOperationException();
+        }
+
+        try {
+            return os.toString("UTF-8");
+        } catch (UnsupportedEncodingException e) {
+            System.out.println("[FATAL] UTF-8 Not supported");
+            return null;
+        }
+    }
+
+    /**
+     * Get the race regatta as a string
+     * Note: Regatta must be set before calling this
+     * @return String containing the regatta XML, null if there was an error
+     */
+    public String getRegattaAsXml(){
+        String result = null;
+
+        if (regatta == null) return null;
+
+        try {
+            result = parseToXmlString(REGATTA_TEMPLATE_NAME, XMLMessageSubType.REGATTA);
+        } catch (TemplateException e) {
+            System.out.println("[FATAL] Error parsing regatta");
+        } catch (IOException e) {
+            System.out.println("[FATAL] Error reading regatta");
+        }
+
+        return result;
+    }
+
+    /**
+     * Get the boats XML as a string
+     * Note: Race must be set before calling this
+     * @return String containing the boats XML, null if there was an error
+     */
+    public String getBoatsAsXml() {
+        String result = null;
+
+        if (race == null) return null;
+
+        try {
+            result = parseToXmlString(BOATS_TEMPLATE_NAME, XMLMessageSubType.BOAT);
+        } catch (TemplateException e) {
+            System.out.println("[FATAL] Error parsing boats");
+        } catch (IOException e) {
+            System.out.println("[FATAL] Error reading boats");
+        }
+
+        return result;
+    }
+
+    /**
+     * Get the race XML as a string
+     * Note: Race must be set before calling this
+     * @return String containing the race XML, null if there was an error
+     */
+    public String getRaceAsXml() {
+        String result = null;
+
+        if (race == null) return null;
+
+        try {
+            result = parseToXmlString(RACE_TEMPLATE_NAME, XMLMessageSubType.RACE);
+        } catch (TemplateException e) {
+            System.out.println("[FATAL] Error parsing race");
+        } catch (IOException e) {
+            System.out.println("[FATAL] Error reading race");
+        }
+
+        return result;
+    }
+}

src/main/java/seng302/model/stream/xml/parser/RaceXMLData.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers.xml;
+package seng302.model.stream.xml.parser;
 
 import java.util.HashMap;
 import java.util.List;

src/main/java/seng302/model/stream/xml/parser/RegattaXMLData.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers.xml;
+package seng302.model.stream.xml.parser;
 
 /**
  * Stores data from regatta xml packet.

src/main/java/seng302/model/stream/xml/parser/XMLParser.java

@@ -1,4 +1,4 @@
-package seng302.model.stream.parsers.xml;
+package seng302.model.stream.xml.parser;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -7,7 +7,7 @@ import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
-import seng302.model.Boat;
+import seng302.model.Yacht;
 import seng302.model.Corner;
 import seng302.model.Limit;
 import seng302.model.mark.GateMark;
@@ -124,8 +124,8 @@ public class XMLParser {
      * @param doc XML Document Object
      * @return Mapping of sourceIds to Boats.
      */
-    public static Map<Integer, Boat> parseBoats(Document doc){
-        Map<Integer, Boat> competingBoats = new HashMap<>();
+    public static Map<Integer, Yacht> parseBoats(Document doc){
+        Map<Integer, Yacht> competingBoats = new HashMap<>();
 
         Element docEle = doc.getDocumentElement();
 
@@ -134,14 +134,14 @@ public class XMLParser {
             Node currentBoat = boatsList.item(i);
             if (currentBoat.getNodeName().equals("Boat")) {
 //                    Boat boat = new Boat(currentBoat);
-                Boat boat = new Boat(XMLParser.getNodeAttributeString(currentBoat, "Type"),
+                Yacht yacht = new Yacht(XMLParser.getNodeAttributeString(currentBoat, "Type"),
                     XMLParser.getNodeAttributeInt(currentBoat, "SourceID"),
                     XMLParser.getNodeAttributeString(currentBoat, "HullNum"),
                     XMLParser.getNodeAttributeString(currentBoat, "ShortName"),
                     XMLParser.getNodeAttributeString(currentBoat, "BoatName"),
                     XMLParser.getNodeAttributeString(currentBoat, "Country"));
-                if (boat.getBoatType().equals("Yacht")) {
-                    competingBoats.put(boat.getSourceID(), boat);
+                if (yacht.getBoatType().equals("Yacht")) {
+                    competingBoats.put(yacht.getSourceId(), yacht);
                 }
             }
         }