edu.wright.hendrix11.familyTree.entity.event

Class Event

java.lang.Object

edu.wright.hendrix11.familyTree.entity.event.Event

Direct Known Subclasses:

Marriage, SinglePersonEvent

@MappedSuperclass
public abstract class Event
extends Object

Author:

Joe Hendrix

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
Date	getDate() Returns the date the event happened.
String	getDateString() Constructs and returns the date string.
Integer	getDay() Returns the day of the month this event happened.
Month	getMonth() Returns the month of the year this event happened.
Place	getPlace() Returns the place this event happened.
Integer	getYear() Returns the year this event happened.
boolean	isAbout() Returns true if the date is just an approximate.
void	setAbout(boolean about) Set if the date is an approximate date.
void	setDay(Integer day) Sets the day of the month this event happened.
void	setMonth(Month month) Sets the month of the year this event happened.
void	setPlace(Place place) Sets the place this event happened.
void	setYear(Integer year) Sets the year this event happened.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

getDate

public Date getDate()

Returns the date the event happened. Keep in mind this might be and approximate date, and not all fields may actually be known. Also, it is recommended to get the formatted date string from getDateString() rather than just formatting the date this method returns.

Returns:

the date the event happened

See Also:

getDateString(), isAbout()

getPlace

public Place getPlace()

Returns the place this event happened. This event also happened in all regions of this place.

Returns:

the place this event happened

See Also:

Place.getRegion(), Place.iterator()

setPlace

public void setPlace(Place place)

Sets the place this event happened. This event also happened in all regions of this place.

Parameters:

place - the place this event happened

isAbout

public boolean isAbout()

Returns true if the date is just an approximate.

Returns:

true if the date is just an approximate

setAbout

public void setAbout(boolean about)

Set if the date is an approximate date.

Parameters:

about - if the date is an approximate date

getDay

public Integer getDay()

Returns the day of the month this event happened. If the day is not known, it will return null.

Returns:

the day of the month this event happened

setDay

public void setDay(Integer day)

Sets the day of the month this event happened.

Parameters:

day - the day of the month this event happened

getMonth

public Month getMonth()

Returns the month of the year this event happened. If the month is not known, it will return null.

Returns:

the month of the year this event happened

setMonth

public void setMonth(Month month)

Sets the month of the year this event happened.

Parameters:

month - the month of the year this event happened

getYear

public Integer getYear()

Returns the year this event happened. If the year is not known, it will return null.

Returns:

the year this event happened

setYear

public void setYear(Integer year)

Sets the year this event happened.

Parameters:

year - the year

getDateString

public String getDateString()

Constructs and returns the date string.

Returns:

the formatted date string