Made models serializable & some comparable

widavies · widavies · commit 68ecc26a88ac · 2017-07-08T20:46:14.000-05:00
diff --git a/src/main/java/main/Constants.java b/src/main/java/main/Constants.java
@@ -1,4 +1,4 @@
-package utils;
+package main;
 
 /**
  * @since 1.0.0
diff --git a/src/main/java/main/TBA.java b/src/main/java/main/TBA.java
@@ -13,7 +13,6 @@
 import models.standard.Match;
 import models.standard.Team;
 import requests.*;
-import utils.Constants;
 
 /**
  * This is the main interface for the API, let's talk about that.
diff --git a/src/main/java/models/other/APIStatus.java b/src/main/java/models/other/APIStatus.java
@@ -2,13 +2,15 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  *
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class APIStatus {
+public class APIStatus implements Serializable {
     /**
      * Year of the current FRC season.
      */
diff --git a/src/main/java/models/other/Award.java b/src/main/java/models/other/Award.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class Award {
+public class Award implements Serializable{
     /**
      * The name of the award as provided by FIRST. May vary for the same award type.
      */
diff --git a/src/main/java/models/other/AwardRecipient.java b/src/main/java/models/other/AwardRecipient.java
@@ -2,11 +2,13 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * An Award_Recipient object represents the team and/or person who received an award at an event.
  */
 @Data
-public class AwardRecipient {
+public class AwardRecipient implements Serializable {
     /**
      * The TBA team key for the team that was given the award. May be null.
      */
diff --git a/src/main/java/models/other/District.java b/src/main/java/models/other/District.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class District {
+public class District implements Serializable {
     /**
      * The short identifier for the district.
      */
diff --git a/src/main/java/models/other/DistrictRanking.java b/src/main/java/models/other/DistrictRanking.java
@@ -2,10 +2,12 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * Created by Will Davies on 7/7/2017.
  */
-public class DistrictRanking {
+public class DistrictRanking implements Serializable {
     private String teamKey;
     private long rank;
     private long rookieBonus;
diff --git a/src/main/java/models/other/EliminationAlliance.java b/src/main/java/models/other/EliminationAlliance.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class EliminationAlliance {
+public class EliminationAlliance implements Serializable {
     private String name;
     private Backup[] backups;
     private String[] declines;
diff --git a/src/main/java/models/other/Media.java b/src/main/java/models/other/Media.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class Media {
+public class Media implements Serializable {
     /**
      * TBA identifier for this media.
      */
diff --git a/src/main/java/models/other/Ranking.java b/src/main/java/models/other/Ranking.java
@@ -2,11 +2,13 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * Created by Will Davies on 7/7/2017.
  */
 @Data
-public class Ranking {
+public class Ranking implements Serializable {
     /**
      * Number of times disqualified.
      */
diff --git a/src/main/java/models/other/SortInfo.java b/src/main/java/models/other/SortInfo.java
@@ -6,11 +6,13 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * List of year-specific values provided in the `sort_orders` array for each team.
  */
 @Data
-public class SortInfo {
+public class SortInfo implements Serializable {
     private String name;
     private long precision;
 }
diff --git a/src/main/java/models/other/WLTRecord.java b/src/main/java/models/other/WLTRecord.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class WLTRecord {
+public class WLTRecord implements Serializable {
     /**
      * Number of losses.
      */
diff --git a/src/main/java/models/other/events/EventOPR.java b/src/main/java/models/other/events/EventOPR.java
@@ -2,6 +2,7 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
 import java.util.HashMap;
 
 /**
@@ -10,7 +11,7 @@
  * @author Will Davies
  */
 @Data
-public class EventOPR {
+public class EventOPR implements Serializable {
     /**
      * The team's key
      */
diff --git a/src/main/java/models/other/events/EventRanking.java b/src/main/java/models/other/events/EventRanking.java
@@ -5,12 +5,14 @@
 import models.other.SortInfo;
 import models.other.WLTRecord;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class EventRanking {
+public class EventRanking implements Serializable {
 
     /**
      * List of rankings at the event.
diff --git a/src/main/java/models/other/events/Webcast.java b/src/main/java/models/other/events/Webcast.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class Webcast {
+public class Webcast implements Serializable {
     private String type;
     private String channel;
     private String file;
diff --git a/src/main/java/models/other/matches/MatchAlliance.java b/src/main/java/models/other/matches/MatchAlliance.java
@@ -2,12 +2,14 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class MatchAlliance {
+public class MatchAlliance implements Serializable {
     /**
      * Score for this alliance. Will be null or -1 for an unplayed match.
      */
diff --git a/src/main/java/models/other/teams/Robot.java b/src/main/java/models/other/teams/Robot.java
@@ -2,8 +2,10 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 @Data
-public class Robot {
+public class Robot implements Serializable {
     /**
      * Year this robot competed in.
      */
diff --git a/src/main/java/models/simple/SEvent.java b/src/main/java/models/simple/SEvent.java
@@ -2,6 +2,10 @@
 
 import lombok.Data;
 import models.other.District;
+import models.standard.Event;
+
+import java.io.Serializable;
+import java.util.Calendar;
 
 /**
  * This is the Simple Event Model, as defined by the V3 TBA api.
@@ -10,7 +14,7 @@
  * @author Will Davies
  */
 @Data
-public class SEvent {
+public class SEvent implements Serializable, Comparable<Event> {
     /**
      * TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.
      */
@@ -54,4 +58,19 @@ public class SEvent {
      * Year the event data is for.
      */
     private long year;
+
+    public long getTimeInMillis(String date) {
+        String[] tokens = date.split("-");
+
+        Calendar c = Calendar.getInstance();
+        c.set(Calendar.YEAR, Integer.parseInt(tokens[0]));
+        c.set(Calendar.MONTH, Integer.parseInt(tokens[1]));
+        c.set(Calendar.DAY_OF_MONTH, Integer.parseInt(tokens[2]));
+        return c.getTimeInMillis();
+    }
+
+    @Override
+    public int compareTo(Event o) {
+        return Long.compare(getTimeInMillis(startDate), getTimeInMillis(o.getStartDate()));
+    }
 }
diff --git a/src/main/java/models/simple/SMatch.java b/src/main/java/models/simple/SMatch.java
@@ -2,13 +2,16 @@
 
 import lombok.Data;
 import models.other.matches.MatchAlliance;
+import models.standard.Match;
+
+import java.io.Serializable;
 
 /**
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class SMatch {
+public class SMatch implements Serializable, Comparable<Match> {
     /**
      * TBA event key with the format yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER], where yyyy is the year, and EVENT_CODE is the event code of the event, COMP_LEVEL is (qm, ef, qf, sf, f), and MATCH_NUMBER is the match number in the competition level. A set number may append the competition level if more than one match in required per set.
      *
@@ -54,4 +57,29 @@ public class SMatch {
      * UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time.
      */
     private long actualTime;
+
+    /**
+     * Sorts matches by:
+     * -Quals
+     * -Quarters
+     * -Semis
+     * -Finals
+     */
+
+    @Override
+    public int compareTo(Match o) {
+        long localScore = matchNumber;
+        if(compLevel.equals("qf")) localScore += 1000;
+        else if(compLevel.equals("sf")) localScore += 10000;
+        else if(compLevel.equals("f")) localScore += 100000;
+        localScore += matchNumber;
+
+        long compareScore = o.getMatchNumber();
+        if(o.getCompLevel().equals("qf")) compareScore += 1000;
+        else if(o.getCompLevel().equals("sf")) compareScore += 10000;
+        else if(o.getCompLevel().equals("f")) compareScore += 100000;
+        compareScore += o.getMatchNumber();
+
+        return Long.compare(localScore, compareScore);
+    }
 }
diff --git a/src/main/java/models/simple/STeam.java b/src/main/java/models/simple/STeam.java
@@ -2,14 +2,16 @@
 
 import lombok.Data;
 
+import java.io.Serializable;
+
 /**
  * The simple Team model as defined by the V3 TPA api.
  *
  * @since 1.0.0
  * @author Will Davies
  */
 @Data
-public class STeam {
+public class STeam implements Serializable {
     /**
      * TBA team key with the format frcXXXX with XXXX representing the team number.
      */
diff --git a/src/main/java/requests/OtherRequest.java b/src/main/java/requests/OtherRequest.java
@@ -3,6 +3,7 @@
 import models.other.APIStatus;
 import utils.IO;
 import utils.Parser;
+import utils.exceptions.DataNotFoundException;
 
 /**
  * @since 1.0.0
@@ -15,7 +16,10 @@ public class OtherRequest extends Parser {
      * @return APIStatus representing the state of the TBA API interface
      */
     public APIStatus getStatus() {
-        return parseStatus(IO.doRequest("status"));
+
+        APIStatus status = parseStatus(IO.doRequest("status"));
+        if (status == null) throw new DataNotFoundException("Unable to fetch API status.");
+        return status;
     }
 
     /**
@@ -24,7 +28,9 @@ public APIStatus getStatus() {
      * @return an Object (json formatted), representing the data received from the server
      */
     public Object customCall(String URL) {
-        return IO.doRequest(URL);
+        Object o = IO.doRequest(URL);
+        if(o == null) throw new DataNotFoundException("No response for your custom URL call");
+        return o;
     }
 
 }
diff --git a/src/main/java/utils/IO.java b/src/main/java/utils/IO.java
@@ -1,5 +1,6 @@
 package utils;
 
+import main.Constants;
 import org.json.simple.parser.JSONParser;
 import utils.exceptions.AuthTokenNotFoundException;
 
diff --git a/src/main/java/utils/Test.java b/src/main/java/utils/Test.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package utils;`
	`1`	`+package main;`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* @since 1.0.0`