unidue.ub.statistics.media.monographs

Class Event

java.lang.Object

unidue.ub.statistics.media.monographs.Event

All Implemented Interfaces:

java.lang.Comparable<Event>

public class Event
extends java.lang.Object
implements java.lang.Comparable<Event>

Representation object of one event from one of the three groups loans (loan and return) requests (request and hold) and stock (inventory and deletion).

Version:

1

Author:

Frank Lützenkirchen

Constructor Summary

Constructors

Constructor and Description
Event(Item item, java.lang.String date, java.lang.String hour, java.lang.String type, java.lang.String borrowerStatus, int sorter, int delta) Creates a new Event related to an item.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Event other) allows for a comparison of two events with respect to their timestamps.
java.lang.String	getBorrowerStatus() returns the status of the person initiating the event (student, non-student member of university, external user, research faculty, other)
java.lang.String	getDate() returns the date (yyyy-MM-dd HH:mm) of the event
int	getDelta() returns the change of the overall number of items in a particular state upon this event (a loan increases the number of loaned items by +1)
Event	getEndEvent() returns the Event-object, for example the return to a loan event.
Item	getItem() retrieves the item related to this event.
long	getTime() returns the timestamp (in milliseconds) of the event.
java.lang.String	getType() returns the type of the event (loan, return, request, hold, inventory, deletion or CALD)
java.lang.String	getYear() returns the year of the event
void	setDate(java.lang.String newDate) sets the Date of the event
void	setEndEvent(Event endEvent) relates to the end Event-object, for example the return to a loan event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(Item item,
             java.lang.String date,
             java.lang.String hour,
             java.lang.String type,
             java.lang.String borrowerStatus,
             int sorter,
             int delta)
      throws java.text.ParseException

Creates a new Event related to an item.

Parameters:

item - the item related to this event

date - the date, wehn this events happens

hour - the hour, wehn this events happens

type - the type of this event

borrowerStatus - the status of the person initiating the event

sorter - an additional sorter to allow sorting of events in the case of multiple events at the same time

delta - the change of the overall number of items in a particular state upon this event (a loan increases the number of loaned items by +1)

Throws:

java.text.ParseException - exception parsing the date field

Method Detail

getItem

public Item getItem()

retrieves the item related to this event.

Returns:

item the item related to this event.

setDate

public void setDate(java.lang.String newDate)

sets the Date of the event

Parameters:

newDate - the new Date

setEndEvent

public void setEndEvent(Event endEvent)

relates to the end Event-object, for example the return to a loan event.

Parameters:

endEvent - the event ending the started process

getEndEvent

public Event getEndEvent()

returns the Event-object, for example the return to a loan event.

Returns:

endEvent the event ending the started process

getYear

public java.lang.String getYear()

returns the year of the event

Returns:

year the year of the event

getTime

public long getTime()

returns the timestamp (in milliseconds) of the event.

Returns:

time the timestamp of the event

getDate

public java.lang.String getDate()

returns the date (yyyy-MM-dd HH:mm) of the event

Returns:

date the date of the event

getType

public java.lang.String getType()

returns the type of the event (loan, return, request, hold, inventory, deletion or CALD)

Returns:

type the type of event

getBorrowerStatus

public java.lang.String getBorrowerStatus()

returns the status of the person initiating the event (student, non-student member of university, external user, research faculty, other)

Returns:

status the status of the person initiating the event

getDelta

public int getDelta()

returns the change of the overall number of items in a particular state upon this event (a loan increases the number of loaned items by +1)

Returns:

delta the overall number of items in a particular state upon this event

compareTo

public int compareTo(Event other)

allows for a comparison of two events with respect to their timestamps. Allows for the ordering of events according to the timestamps.

Specified by:

compareTo in interface java.lang.Comparable<Event>

Returns:

difference +1 of event is after the other one, -1 if it before.