Class Reservation

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.model.reservation.Reservation

All Implemented Interfaces:

Identified, Comparable<Reservation>

Direct Known Subclasses:

SeatReservation

@Entity
public class Reservation
extends Object
implements Identified, Comparable<Reservation>

Represents a time interval during which a specific actor is permitted to use a specific room exclusively.

See Also:

• SeatReservation

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	accessibilityRequired	Whether the applicant is reliant on proper accessibility, possibly due to temporarily or permanently impaired mobility.
private @NonNull Actor	applicant	The Actor who has placed this Reservation.
private @NonNull LocalDateTime	endDate	Specifies the date and time at which the interval ends during which the room is blocked for use by the applicant.
private @NonNull Long	id	Identifies this Reservation uniquely.
private @NonNull IntendedUse	intendedUse	The purpose of the applicant's booking of the room.
private @NonNull LocalDateTime	requestDate	The date and time at which the applicant first requested this Reservation.
private final @NonNull Set<RequiredCommonEquipment>	requiredCommonEquipment	The common equipment that the applicant needs for their intendedUse.
private final @NonNull Set<RequiredIndividualEquipment>	requiredIndividualEquipment	The individual equipment that the applicant needs for their intendedUse.
private @NonNull Room	room	The Room blocked for use by the applicant between the startDate and the endDate.
private @NonNull LocalDateTime	startDate	Specifies the date and time at which the interval begins during which the room is blocked for use by the applicant.

Constructor Summary

Constructors

Constructor	Description
Reservation()

Method Summary

Modifier and Type	Method	Description
void	addRequiredCommonEquipment(@NonNull RequiredCommonEquipment equipment)	Inserts a piece of common equipment to the requiredCommonEquipment set.
void	addRequiredIndividualEquipment(@NonNull RequiredIndividualEquipment equipment)	Insert a new piece of individual equipment into the requiredIndividualEquipment set.
@Range(from=-1L,to=1L) int	compareTo(@NonNull Reservation other)	Determines whether this Reservation or a conflicting other Reservation has higher priority.
@Range(from=0L,to=1L) double	computeScore()	Alias for matches(Room) with room as the Room argument.
@NonNull @Unmodifiable Set<RequiredCommonEquipment>	getRequiredCommonEquipment()
@NonNull @Unmodifiable Set<RequiredIndividualEquipment>	getRequiredIndividualEquipment()
@Range(from=0L,to=1L) double	matches(@NonNull Room room)	Determines how well the given Room is suited for this Reservation, based on the accessibility, the intended use and the required vs.
void	removeAllRequiredCommonEquipment(@NonNull CommonEquipmentType type)	Removes all pieces of common equipment from the requiredCommonEquipment set that match the given CommonEquipmentType.
void	removeAllRequiredCommonEquipment(@NonNull Collection<RequiredCommonEquipment> equipment)	Removes several pieces of common equipment from the requiredCommonEquipment set.
void	removeAllRequiredIndividualEquipment(@NonNull IndividualEquipmentType type)	Removes all pieces of individual equipment from the requiredIndividualEquipment set that match the given IndividualEquipmentType.
void	removeAllRequiredIndividualEquipment(@NonNull Collection<RequiredIndividualEquipment> equipment)	Removes several pieces of individual equipment from the requiredIndividualEquipment set.
void	removeRequiredCommonEquipment(@NonNull RequiredCommonEquipment equipment)	Removes a piece of common equipment from the requiredCommonEquipment set.
void	removeRequiredIndividualEquipment(@NonNull RequiredIndividualEquipment equipment)	Removes a piece of individual equipment from the requiredIndividualEquipment set.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Identified

getId

Field Details

id

@NonNull
private @NonNull Long id

Identifies this Reservation uniquely.

applicant

@NonNull
private @NonNull Actor applicant

The Actor who has placed this Reservation.

requestDate

@NonNull
private @NonNull LocalDateTime requestDate

The date and time at which the applicant first requested this Reservation. The request date is not identical to the startDate and not to the endDate.

startDate

@NonNull
private @NonNull LocalDateTime startDate

Specifies the date and time at which the interval begins during which the room is blocked for use by the applicant. The start date may be in the future (then, this object is “only” a reservation for later) or in the past (then, the applicant has possibly already entered the room and begun using it).

Must always come before the endDate!

endDate

@NonNull
private @NonNull LocalDateTime endDate

Specifies the date and time at which the interval ends during which the room is blocked for use by the applicant. The end date may be in the future (then, the applicant will have or still have the right to use the room) or in the past (then, the reservation has expired and the applicant is no longer permitted to use the room).

Must always come after the startDate!

room

@NonNull
private @NonNull Room room

The Room blocked for use by the applicant between the startDate and the endDate.

requiredIndividualEquipment

@NonNull
private final @NonNull Set<RequiredIndividualEquipment> requiredIndividualEquipment

The individual equipment that the applicant needs for their intendedUse. Not guaranteed to be available in the room.

requiredCommonEquipment

@NonNull
private final @NonNull Set<RequiredCommonEquipment> requiredCommonEquipment

The common equipment that the applicant needs for their intendedUse. Not guaranteed to be available in the room.

accessibilityRequired

private boolean accessibilityRequired

Whether the applicant is reliant on proper accessibility, possibly due to temporarily or permanently impaired mobility. Not guaranteed to be offered by the room.

intendedUse

@NonNull
private @NonNull IntendedUse intendedUse

The purpose of the applicant's booking of the room.

Constructor Details

Reservation

public Reservation()

Method Details

getRequiredIndividualEquipment

@Contract(pure=true)
@NonNull
public @NonNull @Unmodifiable Set<RequiredIndividualEquipment> getRequiredIndividualEquipment()

Returns:

A copy of the requiredIndividualEquipment.

getRequiredCommonEquipment

@Contract(pure=true)
@NonNull
public @NonNull @Unmodifiable Set<RequiredCommonEquipment> getRequiredCommonEquipment()

Returns:

A copy of the requiredCommonEquipment.

addRequiredIndividualEquipment

public void addRequiredIndividualEquipment(@NonNull
 @NonNull RequiredIndividualEquipment equipment)

Insert a new piece of individual equipment into the requiredIndividualEquipment set.

Parameters:

equipment - Additional individual equipment needed by the applicant for the intendedUse of the room.

removeRequiredIndividualEquipment

public void removeRequiredIndividualEquipment(@NonNull
 @NonNull RequiredIndividualEquipment equipment)

Removes a piece of individual equipment from the requiredIndividualEquipment set.

Parameters:

equipment - Individual equipment not needed any longer by the applicant for the intendedUse of the room.

removeAllRequiredIndividualEquipment

public void removeAllRequiredIndividualEquipment(@NonNull
 @NonNull Collection<RequiredIndividualEquipment> equipment)

Removes several pieces of individual equipment from the requiredIndividualEquipment set.

Parameters:

equipment - Individual equipment not needed any longer by the applicant for the intendedUse of the room.

removeAllRequiredIndividualEquipment

public void removeAllRequiredIndividualEquipment(@NonNull
 @NonNull IndividualEquipmentType type)

Removes all pieces of individual equipment from the requiredIndividualEquipment set that match the given IndividualEquipmentType.

Parameters:

type - The type of individual equipment no longer needed by the applicant for the intendedUse of the room.

addRequiredCommonEquipment

public void addRequiredCommonEquipment(@NonNull
 @NonNull RequiredCommonEquipment equipment)

Inserts a piece of common equipment to the requiredCommonEquipment set.

Parameters:

equipment - The additional common equipment needed by the applicant for the intendedUse of the room.

removeRequiredCommonEquipment

public void removeRequiredCommonEquipment(@NonNull
 @NonNull RequiredCommonEquipment equipment)

Removes a piece of common equipment from the requiredCommonEquipment set.

Parameters:

equipment - Common equipment not needed any longer by the applicant for the intendedUse of the room.

removeAllRequiredCommonEquipment

public void removeAllRequiredCommonEquipment(@NonNull
 @NonNull Collection<RequiredCommonEquipment> equipment)

Removes several pieces of common equipment from the requiredCommonEquipment set.

Parameters:

equipment - Common equipment no longer by the applicant for the intendedUse of the room.

removeAllRequiredCommonEquipment

public void removeAllRequiredCommonEquipment(@NonNull
 @NonNull CommonEquipmentType type)

Removes all pieces of common equipment from the requiredCommonEquipment set that match the given CommonEquipmentType.

Parameters:

type - The type of common equipment no longer needed by the applicant for the intendedUse of the room.

computeScore

@Contract(pure=true)
public @Range(from=0L,to=1L) double computeScore()

Alias for matches(Room) with room as the Room argument.

Returns:

Score indicating how well the Room matches this Reservation.

matches

@Contract(pure=true)
public @Range(from=0L,to=1L) double matches(@NonNull
 @NonNull Room room)

Determines how well the given Room is suited for this Reservation, based on the accessibility, the intended use and the required vs. available equipment.

Accessibility score

Accessibility score :=

• accessibility is not required: 1
• accessibility is required:
  • Room.accessibility = Accessibility.FULL: 1
  • Room.accessibility = Accessibility.PARTIAL: ½
  • Room.accessibility = Accessibility.NONE: 0

Accessibility score ∈ [0, 1]

Use-case score

Use-case score :=

• intendedUse = IntendedUse.STUDYING:
  • Room = QuietStudyRoom: 1
  • else: ½
• else:
  • Room = ConferenceRoom: 1
  • else: 0

Use-case score ∈ [0, 1]

Equipment score

• IndividualEquipment score := (Σ requiredIndividualEquipment available in the Room) / (requiredIndividualEquipment.size)
• CommonEquipment score := (Σ requiredCommonEquipment available in the Room) / (requiredCommonEquipment.size)
• equipment score := ½ individual-equipment score + ½ common-equipment score

Equipment score ∈ [0, 1]

Total score

Total score := ½ accessibility score + ½ (¾ equipment score + ¼ use-case score)

Total score ∈ [0, 1]

Parameters:

room - The Room which this Reservation shall be matched to.

Returns:

How well the Room matches this Reservation's requirements.

compareTo

@Contract(pure=true)
public @Range(from=-1L,to=1L) int compareTo(@NonNull
 @NonNull Reservation other)
                                     throws IllegalArgumentException

Determines whether this Reservation or a conflicting other Reservation has higher priority. “Conflicting” means that both Reservations reference the same room. (Currently, the startDate and endDate fields are not taken into account, though.)

The priority is determined based on the result of matches(Room) for both Reservations.

Specified by:

compareTo in interface Comparable<Reservation>

Parameters:

other - A second, different Reservation for the same room.

Returns:

Greater than zero if this Reservation matches the Room better than the other Reservation does. Zero if both reservations match equally well. Negative if this Reservation matches worse than the other one.

Throws:

IllegalArgumentException - If the room fields differ.