From 1aa1d715988cbe4b37035414b6ff26de1bda9b9e Mon Sep 17 00:00:00 2001
From: c2038058 <gillj8@cardiff.ac.uk>
Date: Wed, 17 Nov 2021 12:44:13 +0000
Subject: [PATCH] Appropriate JavaDoc added
---
.../data/adminTypes/AdminTypes.java | 4 ++
.../data/adminTypes/AdminTypesRepo.java | 13 +++++++
.../data/converters/TinyIntToBoolean.java | 14 +++++++
.../clientproject/data/rewards/Rewards.java | 4 ++
.../data/rewards/RewardsRepo.java | 18 +++++++++
.../clientproject/data/shops/Shops.java | 13 +++++++
.../clientproject/data/shops/ShopsRepo.java | 38 +++++++++++++++++++
.../data/stampBoards/StampBoards.java | 4 ++
.../data/stampBoards/StampBoardsRepo.java | 13 +++++++
.../example/clientproject/data/tags/Tags.java | 4 ++
.../clientproject/data/tags/TagsRepo.java | 13 +++++++
.../twoFactorMethods/TwoFactorMethods.java | 4 ++
.../TwoFactorMethodsRepo.java | 13 +++++++
.../data/userPermissions/UserPermissions.java | 4 ++
.../userPermissions/UserPermissionsRepo.java | 28 ++++++++++++++
.../data/userStampBoards/UserStampBoards.java | 4 ++
.../userStampBoards/UserStampBoardsRepo.java | 13 +++++++
.../clientproject/data/users/Users.java | 16 +++++++-
.../clientproject/data/users/UsersRepo.java | 18 +++++++++
19 files changed, 237 insertions(+), 1 deletion(-)
diff --git a/src/main/java/com/example/clientproject/data/adminTypes/AdminTypes.java b/src/main/java/com/example/clientproject/data/adminTypes/AdminTypes.java
index d9624eb..f1b61e8 100644
--- a/src/main/java/com/example/clientproject/data/adminTypes/AdminTypes.java
+++ b/src/main/java/com/example/clientproject/data/adminTypes/AdminTypes.java
@@ -9,6 +9,10 @@ import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
+/**
+ * AdminTypes Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/adminTypes/AdminTypesRepo.java b/src/main/java/com/example/clientproject/data/adminTypes/AdminTypesRepo.java
index b802208..7a0f6b9 100644
--- a/src/main/java/com/example/clientproject/data/adminTypes/AdminTypesRepo.java
+++ b/src/main/java/com/example/clientproject/data/adminTypes/AdminTypesRepo.java
@@ -7,9 +7,22 @@ import org.springframework.data.jpa.repository.Query;
import java.util.List;
import java.util.Optional;
+/**
+ * JPA Repository for the "AdminTypes" Entity
+ * Extends the JpaRepository library with the types of "AdminTypes" and "Long"
+ */
public interface AdminTypesRepo extends JpaRepository<AdminTypes, Long> {
+ /**
+ * FindAll method
+ * @return list of AdminTypes found
+ */
List<AdminTypes> findAll();
+ /**
+ * Find an AdminType by the Id
+ * @param adminTypeId - id of the AdminType to find
+ * @return - Optional object containing the AdminType found, if it's present
+ */
@Query("select a from AdminTypes a where a.adminTypeId = ?1")
Optional<AdminTypes> findByAdminTypeId(long adminTypeId);
}
diff --git a/src/main/java/com/example/clientproject/data/converters/TinyIntToBoolean.java b/src/main/java/com/example/clientproject/data/converters/TinyIntToBoolean.java
index e890651..ef9bcf8 100644
--- a/src/main/java/com/example/clientproject/data/converters/TinyIntToBoolean.java
+++ b/src/main/java/com/example/clientproject/data/converters/TinyIntToBoolean.java
@@ -2,7 +2,16 @@ package com.example.clientproject.data.converters;
import javax.persistence.AttributeConverter;
+/**
+ * Converter for TinyInt to Boolean values
+ * Implements the "AttributeConverter" Interface with types "Boolean" and "Integer"
+ */
public class TinyIntToBoolean implements AttributeConverter<Boolean, Integer> {
+ /**
+ * Overrides a method to convert from boolean to int
+ * @param attribute - the value to convert
+ * @return the converted value
+ */
@Override
public Integer convertToDatabaseColumn(Boolean attribute) {
if (attribute) {
@@ -12,6 +21,11 @@ public class TinyIntToBoolean implements AttributeConverter<Boolean, Integer> {
}
}
+ /**
+ * Overrides a method to convert from int to boolean
+ * @param dbData - the value to convert
+ * @return the converted value
+ */
@Override
public Boolean convertToEntityAttribute(Integer dbData) {
return dbData != 0;
diff --git a/src/main/java/com/example/clientproject/data/rewards/Rewards.java b/src/main/java/com/example/clientproject/data/rewards/Rewards.java
index b17309b..07f0580 100644
--- a/src/main/java/com/example/clientproject/data/rewards/Rewards.java
+++ b/src/main/java/com/example/clientproject/data/rewards/Rewards.java
@@ -9,6 +9,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.*;
import java.util.List;
+/**
+ * Rewards Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/rewards/RewardsRepo.java b/src/main/java/com/example/clientproject/data/rewards/RewardsRepo.java
index de5385b..8baac8c 100644
--- a/src/main/java/com/example/clientproject/data/rewards/RewardsRepo.java
+++ b/src/main/java/com/example/clientproject/data/rewards/RewardsRepo.java
@@ -7,11 +7,29 @@ import org.springframework.data.jpa.repository.Query;
import java.util.List;
import java.util.Optional;
+/**
+ * JPA Repository for the "Rewards" Entity
+ * Extends the JpaRepository library with the types of "Rewards" and "Long"
+ */
public interface RewardsRepo extends JpaRepository<StampBoards, Long> {
+ /**
+ * FindAll method
+ * @return list of StampBoards found
+ */
List<StampBoards> findAll();
+ /**
+ * Save method
+ * @param rewards - the new object to save
+ * @return - the object
+ */
Rewards save(Rewards rewards);
+ /**
+ * Find a Reward by the name
+ * @param rewardName - name of the Reward to find
+ * @return - Optional object containing the Reward found, if it's present
+ */
@Query("select r from Rewards r where r.rewardId = ?1")
Optional<Rewards> findByRewardName(String rewardName);
}
diff --git a/src/main/java/com/example/clientproject/data/shops/Shops.java b/src/main/java/com/example/clientproject/data/shops/Shops.java
index bffa969..a51d201 100644
--- a/src/main/java/com/example/clientproject/data/shops/Shops.java
+++ b/src/main/java/com/example/clientproject/data/shops/Shops.java
@@ -11,6 +11,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.*;
import java.util.List;
+/**
+ * Shops Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
@@ -28,6 +32,15 @@ public class Shops {
@Convert(converter = TinyIntToBoolean.class)
private boolean shopActive;
+ /**
+ * Constructor which does not require an ID
+ * @param name - name of the shop
+ * @param website - shop website
+ * @param earnings - shop earnings
+ * @param image - shop image
+ * @param countries - shop countries
+ * @param active - shop active status
+ */
public Shops(String name, String website, int earnings,
String image, String countries, boolean active) {
this.shopName = name;
diff --git a/src/main/java/com/example/clientproject/data/shops/ShopsRepo.java b/src/main/java/com/example/clientproject/data/shops/ShopsRepo.java
index c477d4c..2ee0113 100644
--- a/src/main/java/com/example/clientproject/data/shops/ShopsRepo.java
+++ b/src/main/java/com/example/clientproject/data/shops/ShopsRepo.java
@@ -6,26 +6,64 @@ import org.springframework.data.jpa.repository.Query;
import java.util.List;
import java.util.Optional;
+/**
+ * JPA Repository for the "Shops" Entity
+ * Extends the JpaRepository library with the types of "Shops" and "Long"
+ */
public interface ShopsRepo extends JpaRepository<Shops, Long> {
+ /**
+ * FindAll method
+ * @return list of Shops found
+ */
List<Shops> findAll();
+ /**
+ * Save method
+ * @param shops - the object to save
+ * @return - the object
+ */
Shops save(Shops shops);
+ /**
+ * Search by the name of the shop
+ * @param shopName - the name to search by
+ * @return - an option containing the object if one is found
+ */
@Query("select s from Shops s where s.shopName = ?1")
Optional<Shops> findByShopName(String shopName);
+ /**
+ * Search for shops using a free license
+ * @return - a list of the objects found
+ */
@Query("select s from Shops s where s.shopEarnings > 0 and s.shopEarnings < 10000")
List<Shops> findByFreeLicense();
+ /**
+ * Search for shops using a standard license
+ * @return - a list of the objects found
+ */
@Query("select s from Shops s where s.shopEarnings > 10000 and s.shopEarnings < 40000")
List<Shops> findByStandardLicense();
+ /**
+ * Search for shops using a premium license
+ * @return - a list of the objects found
+ */
@Query("select s from Shops s where s.shopEarnings > 40000")
List<Shops> findByPremiumLicense();
+ /**
+ * Search for active shops
+ * @return - a list containing the shops found
+ */
@Query("select s from Shops s where s.shopActive = true")
List<Shops> findActiveShops();
+ /**
+ * Search for inactive shops
+ * @return - a list containing the objects found
+ */
@Query("select s from Shops s where s.shopActive = false")
List<Shops> findInactiveShops();
}
diff --git a/src/main/java/com/example/clientproject/data/stampBoards/StampBoards.java b/src/main/java/com/example/clientproject/data/stampBoards/StampBoards.java
index 61b996a..ddac39e 100644
--- a/src/main/java/com/example/clientproject/data/stampBoards/StampBoards.java
+++ b/src/main/java/com/example/clientproject/data/stampBoards/StampBoards.java
@@ -8,6 +8,10 @@ import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
+/**
+ * StampBoards Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/stampBoards/StampBoardsRepo.java b/src/main/java/com/example/clientproject/data/stampBoards/StampBoardsRepo.java
index 4e3f945..d1b0297 100644
--- a/src/main/java/com/example/clientproject/data/stampBoards/StampBoardsRepo.java
+++ b/src/main/java/com/example/clientproject/data/stampBoards/StampBoardsRepo.java
@@ -4,8 +4,21 @@ import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;
+/**
+ * JPA Repository for the "StampBoards" Entity
+ * Extends the JpaRepository library with the types of "StampBoards" and "Long"
+ */
public interface StampBoardsRepo extends JpaRepository<StampBoards, Long> {
+ /**
+ * FindAll method
+ * @return list of StampBoards found
+ */
List<StampBoards> findAll();
+ /**
+ * Save Method
+ * @param stampBoards - the StampBoard to save
+ * @return - the object
+ */
StampBoards save(StampBoards stampBoards);
}
diff --git a/src/main/java/com/example/clientproject/data/tags/Tags.java b/src/main/java/com/example/clientproject/data/tags/Tags.java
index ab3e500..72e5193 100644
--- a/src/main/java/com/example/clientproject/data/tags/Tags.java
+++ b/src/main/java/com/example/clientproject/data/tags/Tags.java
@@ -9,6 +9,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.*;
import java.util.List;
+/**
+ * Tags Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/tags/TagsRepo.java b/src/main/java/com/example/clientproject/data/tags/TagsRepo.java
index efda7a0..0429026 100644
--- a/src/main/java/com/example/clientproject/data/tags/TagsRepo.java
+++ b/src/main/java/com/example/clientproject/data/tags/TagsRepo.java
@@ -4,8 +4,21 @@ import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;
+/**
+ * JPA Repository for the "Tags" Entity
+ * Extends the JpaRepository library with the types of "Tags" and "Long"
+ */
public interface TagsRepo extends JpaRepository<Tags, Long> {
+ /**
+ * FindAll method
+ * @return list of Tags found
+ */
List<Tags> findAll();
+ /**
+ * Save method
+ * @param tags - the object to save
+ * @return - the object
+ */
Tags save(Tags tags);
}
diff --git a/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethods.java b/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethods.java
index a14b3c1..5f1cf2b 100644
--- a/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethods.java
+++ b/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethods.java
@@ -7,6 +7,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.Entity;
import javax.persistence.Id;
+/**
+ * TwoFactorMethods Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethodsRepo.java b/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethodsRepo.java
index be4c453..89b563f 100644
--- a/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethodsRepo.java
+++ b/src/main/java/com/example/clientproject/data/twoFactorMethods/TwoFactorMethodsRepo.java
@@ -6,9 +6,22 @@ import org.springframework.data.jpa.repository.Query;
import java.util.List;
import java.util.Optional;
+/**
+ * JPA Repository for the "TwoFactorMethods" Entity
+ * Extends the JpaRepository library with the types of "TwoFactorMethods" and "Long"
+ */
public interface TwoFactorMethodsRepo extends JpaRepository<TwoFactorMethods, Long> {
+ /**
+ * FindAll method
+ * @return list of TwoFactorMethods found
+ */
List<TwoFactorMethods> findAll();
+ /**
+ * Search by the id of the two factor method
+ * @param twoFactorMethodId - the id to search by
+ * @return - an option containing the object if one is found
+ */
@Query("select t from TwoFactorMethods t where t.twoFactorMethodId = ?1")
Optional<TwoFactorMethods> findByTwoFactorMethodId(long twoFactorMethodId);
}
diff --git a/src/main/java/com/example/clientproject/data/userPermissions/UserPermissions.java b/src/main/java/com/example/clientproject/data/userPermissions/UserPermissions.java
index 238b818..00d5c5c 100644
--- a/src/main/java/com/example/clientproject/data/userPermissions/UserPermissions.java
+++ b/src/main/java/com/example/clientproject/data/userPermissions/UserPermissions.java
@@ -9,6 +9,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.*;
+/**
+ * UserPermissions Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/userPermissions/UserPermissionsRepo.java b/src/main/java/com/example/clientproject/data/userPermissions/UserPermissionsRepo.java
index 4fe6098..cda5137 100644
--- a/src/main/java/com/example/clientproject/data/userPermissions/UserPermissionsRepo.java
+++ b/src/main/java/com/example/clientproject/data/userPermissions/UserPermissionsRepo.java
@@ -5,17 +5,45 @@ import org.springframework.data.jpa.repository.Query;
import java.util.List;
+/**
+ * JPA Repository for the "UserPermissions" Entity
+ * Extends the JpaRepository library with the types of "UserPermissions" and "Long"
+ */
public interface UserPermissionsRepo extends JpaRepository<UserPermissions, Long> {
+ /**
+ * FindAll method
+ * @return list of UserPermissions found
+ */
List<UserPermissions> findAll();
+ /**
+ * Save method
+ * @param userPermissions - the object to save
+ * @return - the object
+ */
UserPermissions save(UserPermissions userPermissions);
+ /**
+ * Search by the userId of the userPermission
+ * @param userId - the id to search by
+ * @return - an option containing the object if one is found
+ */
@Query("select u from UserPermissions u where u.user.userId = ?1")
List<UserPermissions> findByUserId(long userId);
+ /**
+ * Search by the shopId of the userPermission
+ * @param shopId - the name to search by
+ * @return - an option containing the object if one is found
+ */
@Query("select u from UserPermissions u where u.shop.shopId = ?1")
List<UserPermissions> findByShopID(long shopId);
+ /**
+ * Search by the adminTypeId of the UserPermission
+ * @param adminTypeId - the id to search by
+ * @return - an option containing the object if one is found
+ */
@Query("select u from UserPermissions u where u.adminType.adminTypeId = ?1")
List<UserPermissions> findByAdminTypeId(long adminTypeId);
}
diff --git a/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoards.java b/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoards.java
index 3dfe67c..48430e7 100644
--- a/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoards.java
+++ b/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoards.java
@@ -7,6 +7,10 @@ import lombok.NoArgsConstructor;
import javax.persistence.*;
+/**
+ * UserStampBoards Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
diff --git a/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoardsRepo.java b/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoardsRepo.java
index c8d5462..7ad480e 100644
--- a/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoardsRepo.java
+++ b/src/main/java/com/example/clientproject/data/userStampBoards/UserStampBoardsRepo.java
@@ -4,8 +4,21 @@ import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;
+/**
+ * JPA Repository for the "UserStampBoards" Entity
+ * Extends the JpaRepository library with the types of "UserStampBoards" and "Long"
+ */
public interface UserStampBoardsRepo extends JpaRepository<UserStampBoards, Long> {
+ /**
+ * FindAll method
+ * @return list of UserStampBoards found
+ */
List<UserStampBoards> findAll();
+ /**
+ * Save method
+ * @param userStampBoards - the object to save
+ * @return - the object
+ */
UserStampBoards save(UserStampBoards userStampBoards);
}
diff --git a/src/main/java/com/example/clientproject/data/users/Users.java b/src/main/java/com/example/clientproject/data/users/Users.java
index cf2d0e1..7a3a5fe 100644
--- a/src/main/java/com/example/clientproject/data/users/Users.java
+++ b/src/main/java/com/example/clientproject/data/users/Users.java
@@ -9,10 +9,13 @@ import lombok.Data;
import lombok.NoArgsConstructor;
import javax.persistence.*;
-import java.time.LocalDateTime;
import java.util.List;
import java.util.Set;
+/**
+ * Users Entity
+ * Contains Getters, Setters, and constructors thanks to Lombok
+ */
@Data
@AllArgsConstructor
@NoArgsConstructor
@@ -29,6 +32,17 @@ public class Users {
private String userResetCode;
private String userResetCodeExpiry;
+ /**
+ * Constructor
+ * @param firstName - user first name
+ * @param surname - user surname
+ * @param email - user email
+ * @param password - user password
+ * @param profilePicture - user profile picture
+ * @param resetCode - user password reset code
+ * @param expiry - user password reset code expiry date time
+ * @param aTwoFactorMethod - user two-factor authentication method
+ */
public Users(String firstName, String surname, String email,
String password, String profilePicture, String resetCode,
String expiry, TwoFactorMethods aTwoFactorMethod) {
diff --git a/src/main/java/com/example/clientproject/data/users/UsersRepo.java b/src/main/java/com/example/clientproject/data/users/UsersRepo.java
index 3e1c46d..45ceb29 100644
--- a/src/main/java/com/example/clientproject/data/users/UsersRepo.java
+++ b/src/main/java/com/example/clientproject/data/users/UsersRepo.java
@@ -5,10 +5,28 @@ import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;
import java.util.Optional;
+/**
+ * JPA Repository for the "Users" Entity
+ * Extends the JpaRepository library with the types of "Users" and "Long"
+ */
public interface UsersRepo extends JpaRepository<Users, Long> {
+ /**
+ * FindAll method
+ * @return list of Users found
+ */
List<Users> findAll();
+ /**
+ * Method for finding a user by the email
+ * @param email - the email to search by
+ * @return - an optional containing the user if one is found
+ */
Optional<Users> findByUserEmail(String email);
+ /**
+ * Save method
+ * @param user - the object to save
+ * @return - the object
+ */
Users save(Users user);
}
--
GitLab