Added comments for design patterns

src/main/java/org/wahlzeit/model/AbstractCoordinate.java

@@ -5,6 +5,8 @@
 
 package org.wahlzeit.model;
 
+import org.wahlzeit.utils.DesignPattern;
+
 public abstract class AbstractCoordinate implements Coordinate {
 
     /**
@@ -95,6 +97,10 @@ private boolean isWithinDistance(Coordinate c, double epsilon) {
      * @param c Coordinate Object to convert
      * @return SphericCoordinate representation of c Coordinate
      */
+    @DesignPattern(
+        name = "Flyweight",
+        participants = { "Client" }
+    )
     protected static SphericCoordinate fromCartesian(CartesianCoordinate c) {
         if (c == null) {
             throw new IllegalArgumentException("Can't convert null coordinate");
@@ -122,6 +128,10 @@ protected static SphericCoordinate fromCartesian(CartesianCoordinate c) {
      * @param c Coordinate Object to convert
      * @return CartesianCoordinate representation of c Coordinate
      */
+    @DesignPattern(
+        name = "Flyweight",
+        participants = { "Client" }
+    )
     protected static CartesianCoordinate fromSpheric(SphericCoordinate c) {
         if (c == null) {
             throw new IllegalArgumentException("Can't convert null coordinate");

src/main/java/org/wahlzeit/model/CartesianCoordinate.java

@@ -6,12 +6,18 @@
 package org.wahlzeit.model;
 
 
+import org.wahlzeit.utils.DesignPattern;
+
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 /*
  * Local plain class to store 3D Cartesian Coordinate values.
  */
+@DesignPattern(
+    name = "Flyweight",
+    participants = { "Flyweight" }
+)
 public class CartesianCoordinate extends AbstractCoordinate {
 
     private final double x, y, z;
@@ -67,29 +73,34 @@ public double getZ() {
         return z;
     }
 
-    private static Map<Integer, CartesianCoordinate> coordinateInstances = new ConcurrentHashMap<>();
+
     /**
      * Part of the Value Type implementation (week8)
      * @param x
      * @param y
      * @param z
      * @param location a location object to link the new coordinate to or null
      * @return a new cartesianCoordinate with coordinate @param x y z and location attribute values,
-     *         or the stored object if one with the same attribute values already has been created.
+     *         or the stored object in @value coordinateInstances if one with the same attribute values already has been saved.
      */
+    private static Map<Integer, CartesianCoordinate> coordinateInstances = new ConcurrentHashMap<>();
+    @DesignPattern(
+            name = "Flyweight",
+            participants = { "FlyweightFactory" }
+    )
     public static CartesianCoordinate getCoordinate(double x, double y, double z, Location location) {
         if (!assertNotNaN(x) || !assertNotNaN(y) || !assertNotNaN(z)) {
             throw new IllegalArgumentException("getCoordinate must receive exactly 3 non NaN doubles");
         }
 
         // look up if object exists already
-        Integer coordianteHashCode = calcHashCode(x, y, z, location);
+        Integer coordinateHashCode = calcHashCode(x, y, z, location);
 
-        if (coordinateInstances.containsKey(coordianteHashCode)) {
-            return coordinateInstances.get(coordianteHashCode);
+        if (coordinateInstances.containsKey(coordinateHashCode)) {
+            return coordinateInstances.get(coordinateHashCode);
         }
 
-        // if immutable shared Coordiante object has not been created yet, create a new one and store it
+        // if immutable shared Coordinate object has not been created yet, create a new one and store it
         CartesianCoordinate coordinate;
 
         if (location == null) {
@@ -98,7 +109,7 @@ public static CartesianCoordinate getCoordinate(double x, double y, double z, Lo
             coordinate = new CartesianCoordinate(x, y, z, location);
         }
 
-        coordinateInstances.put(coordianteHashCode, coordinate);
+        coordinateInstances.put(coordinateHashCode, coordinate);
 
         return coordinate;
     }

src/main/java/org/wahlzeit/model/CubePhoto.java

@@ -5,8 +5,14 @@
 
 package org.wahlzeit.model;
 
+import org.wahlzeit.utils.DesignPattern;
+
 import java.sql.*;
 
+@DesignPattern(
+    name = "AbstractFactory",
+    participants = { "Product" }
+)
 public class CubePhoto extends Photo {
 
     public CubePhoto() {

src/main/java/org/wahlzeit/model/CubePhotoFactory.java

@@ -6,9 +6,14 @@
 package org.wahlzeit.model;
 
 import org.wahlzeit.services.SysLog;
+import org.wahlzeit.utils.DesignPattern;
 
 import java.sql.*;
 
+@DesignPattern(
+    name = "AbstractFactory",
+    participants = { "Factory" }
+)
 public class CubePhotoFactory extends PhotoFactory {
 
     private static CubePhotoFactory instance = null;

src/main/java/org/wahlzeit/model/CubePhotoManager.java

@@ -5,8 +5,14 @@
 
 package org.wahlzeit.model;
 
+import org.wahlzeit.utils.DesignPattern;
+
 import java.sql.*;
 
+@DesignPattern(
+        name = "Singleton",
+        participants = { "Singleton" }
+)
 public class CubePhotoManager extends PhotoManager {
 
     protected CubePhoto createObject(ResultSet rset) throws SQLException {

src/main/java/org/wahlzeit/model/Photo.java

@@ -14,6 +14,10 @@
 /**
  * A photo represents a user-provided (uploaded) photo.
  */
+@DesignPattern (
+	name = "AbstractFactory",
+	participants = { "Product" }
+)
 public class Photo extends DataObject {
 
 	/**
@@ -130,10 +134,11 @@ public Photo(ResultSet rset) throws SQLException {
 	public String getIdAsString() {
 		return String.valueOf(id.asInt());
 	}
-
-	/**
-	 * 
-	 */
+
+	@DesignPattern(
+		name = "Flyweight",
+		participants = { "Client" }
+	)
 	public void readFrom(ResultSet rset) throws SQLException {
 		id = PhotoId.getIdFromInt(rset.getInt("id"));
 

src/main/java/org/wahlzeit/model/PhotoCaseManager.java

@@ -9,10 +9,15 @@
 import java.util.*;
 
 import org.wahlzeit.services.*;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * The photo case manager provides access to and manages persistent photo cases.
  */
+@DesignPattern(
+	name = "Singleton",
+	participants = { "Singleton" }
+)
 public class PhotoCaseManager extends ObjectManager {
 
 	/**

src/main/java/org/wahlzeit/model/PhotoFactory.java

@@ -8,10 +8,15 @@
 import java.sql.*;
 
 import org.wahlzeit.services.*;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
- * An Abstract Factory for creating photos and related objects.
+ * Implementation of an Abstract Factory for creating photos and related objects.
  */
+@DesignPattern (
+	name = "AbstractFactory",
+	participants = { "Factory" }
+)
 public class PhotoFactory {
 
 	/**

src/main/java/org/wahlzeit/model/PhotoManager.java

@@ -11,10 +11,15 @@
 
 import org.wahlzeit.main.*;
 import org.wahlzeit.services.*;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * A photo manager provides access to and manages photos.
  */
+@DesignPattern(
+	name = "Singleton",
+	participants = { "Singleton" }
+)
 public class PhotoManager extends ObjectManager {
 
 	/**

src/main/java/org/wahlzeit/model/SphericCoordinate.java

@@ -5,9 +5,15 @@
 
 package org.wahlzeit.model;
 
+import org.wahlzeit.utils.DesignPattern;
+
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
+@DesignPattern(
+    name = "Flyweight",
+    participants = { "Flyweight" }
+)
 public class SphericCoordinate extends AbstractCoordinate {
 
     private final double phi, theta, radius;
@@ -63,29 +69,34 @@ public double getRadius() {
         return radius;
     }
 
-    private static Map<Integer, SphericCoordinate> coordinateInstances = new ConcurrentHashMap<>();
+
     /**
      * Part of the Value Type implementation (week8)
      * @param phi
      * @param theta
      * @param radius
      * @param location a location object to link the new coordinate to or null
      * @return a new sphericCoordinate with coordinate @param radius, theta, phi and location attribute values,
-     *         or the stored object if one with the same attribute values already has been created.
+     *         or the stored object in @value coordinateInstances if one with the same attribute values already has been saved.
      */
+    private static Map<Integer, SphericCoordinate> coordinateInstances = new ConcurrentHashMap<>();
+    @DesignPattern(
+            name = "Flyweight",
+            participants = { "FlyweightFactory" }
+    )
     public static SphericCoordinate getCoordinate(double radius, double theta, double phi, Location location) {
         if (!assertNotNaN(phi) || !assertNotNaN(theta) || !assertNotNaN(radius)) {
             throw new IllegalArgumentException("getCoordinate must receive exactly 3 non NaN doubles");
         }
 
         // look up if object exists already
-        Integer coordianteHashCode = calcHashCode(phi, theta, radius, location);
+        Integer coordinateHashCode = calcHashCode(phi, theta, radius, location);
 
-        if (coordinateInstances.containsKey(coordianteHashCode)) {
-            return coordinateInstances.get(coordianteHashCode);
+        if (coordinateInstances.containsKey(coordinateHashCode)) {
+            return coordinateInstances.get(coordinateHashCode);
         }
 
-        // if immutable shared Coordiante object has not been created yet, create a new one and store it
+        // if immutable shared Coordinate object has not been created yet, create a new one and store it
         SphericCoordinate coordinate;
 
         if (location == null) {
@@ -94,7 +105,7 @@ public static SphericCoordinate getCoordinate(double radius, double theta, doubl
             coordinate = new SphericCoordinate(phi, theta, radius, location);
         }
 
-        coordinateInstances.put(coordianteHashCode, coordinate);
+        coordinateInstances.put(coordinateHashCode, coordinate);
 
         return coordinate;
     }

src/main/java/org/wahlzeit/model/UserManager.java

@@ -10,10 +10,15 @@
 
 import org.wahlzeit.services.*;
 import org.wahlzeit.services.mailing.*;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * The UserManager provides access to and manages Users (including Moderators and Administrators).
  */
+@DesignPattern(
+	name = "Singleton",
+	participants = { "Singleton" }
+)
 public class UserManager extends ObjectManager {
 
 	/**

src/main/java/org/wahlzeit/services/mailing/EmailService.java

@@ -6,11 +6,16 @@
 package org.wahlzeit.services.mailing;
 
 import org.wahlzeit.services.EmailAddress;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * An EmailServer can send emails. Various implementations exist.
  *
  */
+@DesignPattern(
+	name = "Decorator",
+	participants = { "Component" }
+)
 public interface EmailService {
 
 	/**

src/main/java/org/wahlzeit/services/mailing/EmailServiceManager.java

@@ -6,10 +6,15 @@
 package org.wahlzeit.services.mailing;
 
 import org.wahlzeit.main.ServiceMain;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * 
  */
+@DesignPattern(
+	name = "Singleton",
+	participants = { "Singleton" }
+)
 public class EmailServiceManager {
 
 	/**

src/main/java/org/wahlzeit/services/mailing/LoggingEmailService.java

@@ -7,12 +7,17 @@
 
 import org.wahlzeit.services.EmailAddress;
 import org.wahlzeit.services.SysLog;
+import org.wahlzeit.utils.DesignPattern;
 
 /**
  * A logging mailing service logs email send attempts before sending emails.
  * This is a decorator pattern application.
  * 
  */
+@DesignPattern(
+	name = "Decorator",
+	participants = { "Decorator" }
+)
 public class LoggingEmailService implements EmailService {
 
 	/**

src/main/java/org/wahlzeit/utils/DesignPattern.java

@@ -0,0 +1,6 @@
+package org.wahlzeit.utils;
+
+public @interface DesignPattern {
+    String name();
+    String[] participants();
+}