#105 | Create Assignment And Location Domain

pom.xml

@@ -161,6 +161,11 @@
             <groupId>com.mysql</groupId>
             <artifactId>mysql-connector-j</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>org.hibernate.orm</groupId>
+            <artifactId>hibernate-spatial</artifactId>
+        </dependency>
         <!-- ===================== -->
         <!-- database dependencies -->
         <!-- ===================== -->

src/main/java/com/ays/assignment/model/Assignment.java

@@ -0,0 +1,32 @@
+package com.ays.assignment.model;
+
+import com.ays.assignment.model.enums.AssignmentStatus;
+import com.ays.common.model.AysPhoneNumber;
+import com.ays.common.model.BaseDomainModel;
+import com.ays.institution.model.Institution;
+import com.ays.user.model.User;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.experimental.SuperBuilder;
+
+/**
+ * Assignment Domain Model to perform data transfer from service layer to controller
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder
+public class Assignment extends BaseDomainModel {
+
+    private String id;
+    private String description;
+    private String firstName;
+    private String lastName;
+    private AysPhoneNumber phoneNumber;
+    private Double latitude;
+    private Double longitude;
+    private AssignmentStatus status;
+
+    private User user;
+    private Institution institution;
+
+}

src/main/java/com/ays/assignment/model/dto/request/AssignmentListRequest.java

@@ -0,0 +1,79 @@
+package com.ays.assignment.model.dto.request;
+
+import com.ays.assignment.model.enums.AssignmentStatus;
+import com.ays.common.model.dto.request.AysFilteringRequest;
+import com.ays.common.model.dto.request.AysPagingRequest;
+import com.ays.common.util.validation.EnumValidation;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import jakarta.validation.constraints.AssertTrue;
+import lombok.Builder;
+import lombok.Data;
+import org.springframework.data.jpa.domain.Specification;
+
+import java.util.EnumSet;
+import java.util.Set;
+
+/**
+ * Represents a request object for fetching a list of user assignment with pagination,sorting and filtering options
+ * This class extends the {@link AysPagingRequest} class and adds additional validation rules for sorting.
+ */
+@Data
+@Builder
+public class AssignmentListRequest extends AysPagingRequest implements AysFilteringRequest {
+
+    private AssignmentStatus status;
+
+    /**
+     * Checks if the assignment status is valid.
+     *
+     * @return true if the assignment status is valid or null, false otherwise.
+     */
+    @AssertTrue(message = "IS ASSIGNMENT STATUS NOT ACCEPTED")
+    private boolean isStatusAccepted() {
+
+        if (this.status == null) {
+            return true;
+        }
+
+        EnumSet<AssignmentStatus> acceptedAssignmentStatuses = EnumSet.of(AssignmentStatus.AVAILABLE,
+                AssignmentStatus.RESERVED,
+                AssignmentStatus.ASSIGNED,
+                AssignmentStatus.IN_PROGRESS,
+                AssignmentStatus.DONE
+        );
+        return EnumValidation.anyOf(this.status, acceptedAssignmentStatuses);
+    }
+
+    /**
+     * Overrides the {@link AysPagingRequest#isSortPropertyAccepted()} method to validate sorting options
+     * and ensures that no unsupported sorting property is used in the request.
+     *
+     * @return true if the sorting property is accepted, false otherwise.
+     */
+    @JsonIgnore
+    @AssertTrue
+    @Override
+    public boolean isSortPropertyAccepted() {
+        final Set<String> acceptedFilterFields = Set.of();
+        return this.isPropertyAccepted(acceptedFilterFields);
+    }
+
+    /**
+     * Converts the request into a JPA Specification that filters assignments based on the specified status,
+     * if it is provided.
+     *
+     * @param clazz the class type of the specification.
+     * @return the generated JPA Specification based on the request filters.
+     */
+    @Override
+    public <C> Specification<C> toSpecification(Class<C> clazz) {
+        Specification<C> specification = Specification.where(null);
+        if (status != null) {
+            specification = specification.and((root, query, builder) ->
+                    builder.equal(root.get("status"), status));
+        }
+        // Add more filter conditions if needed
+        return specification;
+    }
+
+}

src/main/java/com/ays/assignment/model/dto/request/AssignmentSearchRequest.java

@@ -0,0 +1,21 @@
+package com.ays.assignment.model.dto.request;
+
+import lombok.Builder;
+import lombok.Getter;
+
+/**
+ * A DTO class representing the request data for searching assignment with respect to user's location.
+ * <p>
+ * This class provides getters and setters for the latitude, and longitude fields.
+ * It also includes a builder pattern implementation for constructing instances of this class with optional parameters.
+ * <p>
+ * The purpose of this class is to encapsulate the request data related to searching assignment with respect to user's location, allowing for easy
+ * transfer of the data between different layers of the application.
+ */
+@Getter
+@Builder
+public class AssignmentSearchRequest {
+
+    private Double latitude;
+    private Double longitude;
+}

src/main/java/com/ays/assignment/model/dto/response/AssignmentResponse.java

@@ -0,0 +1,25 @@
+package com.ays.assignment.model.dto.response;
+
+import com.ays.common.model.dto.response.BaseResponse;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.experimental.SuperBuilder;
+
+/**
+ * A DTO (Data Transfer Object) representing a list of user assignment in a paginated response.
+ */
+@Getter
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder
+public class AssignmentResponse extends BaseResponse {
+
+    private String id;
+    private String description;
+    private String firstName;
+    private String lastName;
+    private Double longitude;
+    private Double latitude;
+
+    private AssignmentSearchResponse assignmentSearchResponse;
+
+}

src/main/java/com/ays/assignment/model/dto/response/AssignmentSearchResponse.java

@@ -0,0 +1,32 @@
+package com.ays.assignment.model.dto.response;
+
+import com.ays.common.model.AysPhoneNumber;
+import com.ays.common.model.dto.response.BaseResponse;
+import com.ays.institution.model.dto.response.InstitutionResponse;
+import com.ays.user.model.enums.UserRole;
+import com.ays.user.model.enums.UserStatus;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.experimental.SuperBuilder;
+
+/**
+ * This class represents the response for a user with assignment.
+ * It includes information such as the user's username, first and last name, email, institution, role and status.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder
+public class AssignmentSearchResponse extends BaseResponse {
+
+    private String id;
+    private String username;
+    private String firstName;
+    private String lastName;
+    private String email;
+    private UserRole role;
+    private UserStatus status;
+    private AysPhoneNumber phoneNumber;
+
+    private InstitutionResponse institution;
+
+}

src/main/java/com/ays/assignment/model/entity/AssignmentEntity.java

@@ -0,0 +1,99 @@
+package com.ays.assignment.model.entity;
+
+import com.ays.assignment.model.enums.AssignmentStatus;
+import com.ays.common.model.entity.BaseEntity;
+import com.ays.institution.model.entity.InstitutionEntity;
+import com.ays.user.model.entity.UserEntity;
+import jakarta.persistence.*;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
+import org.locationtech.jts.geom.Coordinate;
+import org.locationtech.jts.geom.GeometryFactory;
+import org.locationtech.jts.geom.Point;
+
+/**
+ * Assignment entity, which holds the information regarding assignment.
+ */
+@Entity
+@Data
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder
+@NoArgsConstructor
+@AllArgsConstructor
+@Table(name = "AYS_ASSIGNMENT")
+public class AssignmentEntity extends BaseEntity {
+
+    @Id
+    @Column(name = "ID")
+    private String id;
+
+    @Column(name = "INSTITUTION_ID")
+    private String institutionId;
+
+    @Column(name = "USER_ID")
+    private String userId;
+
+    @Column(name = "DESCRIPTION")
+    private String description;
+
+    @Column(name = "FIRST_NAME")
+    private String firstName;
+
+    @Column(name = "LAST_NAME")
+    private String lastName;
+
+    @Column(name = "COUNTRY_CODE")
+    private String countryCode;
+
+    @Column(name = "LINE_NUMBER")
+    private String lineNumber;
+
+    @Column(name = "POINT", columnDefinition = "ST_GeomFromText(Point, 4326)")
+    private Point point;
+
+    @Enumerated(EnumType.STRING)
+    @Column(name = "ASSIGNMENT_STATUS")
+    private AssignmentStatus status;
+
+    @OneToOne
+    @JoinColumn(name = "INSTITUTION_ID", referencedColumnName = "ID", insertable = false, updatable = false)
+    private InstitutionEntity institution;
+
+    @OneToOne
+    @JoinColumn(name = "USER_ID", referencedColumnName = "ID", insertable = false, updatable = false)
+    private UserEntity user;
+
+    public void setPoint(double latitude, double longitude) {
+        Coordinate coordinate = new Coordinate(latitude, longitude);
+        GeometryFactory geometryFactory = new GeometryFactory();
+        this.point = geometryFactory.createPoint(coordinate);
+    }
+
+    public boolean isAvailable() {
+        return AssignmentStatus.AVAILABLE.equals(this.status);
+    }
+
+    public boolean isReserved() {
+        return AssignmentStatus.RESERVED.equals(this.status);
+    }
+
+    public boolean isAssigned() {
+        return AssignmentStatus.ASSIGNED.equals(this.status);
+    }
+
+    public boolean isInProgress() {
+        return AssignmentStatus.IN_PROGRESS.equals(this.status);
+    }
+
+    public boolean isDone() {
+        return AssignmentStatus.DONE.equals(this.status);
+    }
+
+    public void updateAssignmentStatus(AssignmentStatus assignmentStatus) {
+        this.status = assignmentStatus;
+    }
+
+}

src/main/java/com/ays/assignment/model/enums/AssignmentStatus.java

@@ -0,0 +1,14 @@
+package com.ays.assignment.model.enums;
+
+/**
+ * Enumeration keeping assignment status.
+ */
+public enum AssignmentStatus {
+
+    AVAILABLE,
+    RESERVED,
+    ASSIGNED,
+    IN_PROGRESS,
+    DONE
+
+}

src/main/java/com/ays/assignment/model/mapper/AssignmentEntityToAssignmentMapper.java

@@ -0,0 +1,63 @@
+package com.ays.assignment.model.mapper;
+
+import com.ays.assignment.model.Assignment;
+import com.ays.assignment.model.entity.AssignmentEntity;
+import com.ays.common.model.mapper.BaseMapper;
+import org.locationtech.jts.geom.Point;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.factory.Mappers;
+
+import java.util.Optional;
+
+/**
+ * AssignmentEntityToAssignmentMapper is an interface that defines the mapping between an {@link AssignmentEntity} and an {@link Assignment}.
+ * This interface uses the MapStruct annotation @Mapper to generate an implementation of this interface at compile-time.
+ * <p>The class provides a static method {@code initialize()} that returns an instance of the generated mapper implementation.
+ * <p>The interface extends the MapStruct interface {@link BaseMapper}, which defines basic mapping methods.
+ * The interface adds no additional mapping methods, but simply defines the types to be used in the mapping process.
+ */
+@Mapper
+public interface AssignmentEntityToAssignmentMapper extends BaseMapper<AssignmentEntity, Assignment> {
+
+    @Override
+    @Mapping(target = "phoneNumber.countryCode", source = "source.countryCode")
+    @Mapping(target = "phoneNumber.lineNumber", source = "source.lineNumber")
+    @Mapping(target = "latitude", expression = "java(mapToLatitude(source.getPoint()))")
+    @Mapping(target = "longitude", expression = "java(mapToLongitude(source.getPoint()))")
+    Assignment map(AssignmentEntity source);
+
+    /**
+     * Initializes the mapper.
+     *
+     * @return the initialized mapper object.
+     */
+    static AssignmentEntityToAssignmentMapper initialize() {
+        return Mappers.getMapper(AssignmentEntityToAssignmentMapper.class);
+    }
+
+    /**
+     * Maps a Point object to latitude.
+     *
+     * @param point The Point object.
+     * @return The latitude coordinate.
+     */
+    default Double mapToLatitude(Point point) {
+        return Optional.ofNullable(point)
+                .map(Point::getY)
+                .orElse(null);
+    }
+
+    /**
+     * Maps a Point object to longitude.
+     *
+     * @param point The Point object.
+     * @return The longitude coordinate.
+     */
+    default Double mapToLongitude(Point point) {
+        return Optional.ofNullable(point)
+                .map(Point::getX)
+                .orElse(null);
+    }
+
+}