Class YearlyTotal

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.econ.YearlyTotal

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Object>, EliteTotals, IDBean, Cacheable

Direct Known Subclasses:

RolloverYearlyTotal

public class YearlyTotal
extends DatabaseBean
implements EliteTotals, Cloneable

A bean to store yearly Pilot Elite status totals.

Since:

9.2

Version:

12.4

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
YearlyTotal(int year, int pilotID)	Creates the bean.

Method Summary

Modifier and Type	Method	Description
void	add(FlightEliteScore sc)	Adds a Flight's totals.
void	addLegs(int legs, int distance, int pts)	Adds aggregated totals.
YearlyTotal	adjust(LocalDate ld)	Projects year to date totals over a full year.
Object	cacheKey()	Returns the cache key for this object.
YearlyTotal	delta(EliteLevel el)	Returns the prerequisites required to achieve a particular Elite level.
int	getDistance()	Returns the distance flown.
int	getLegs()	Returns the number of flight legs.
int	getPoints()	Returns the number of Elite points.
int	getYear()	Returns the program year.
boolean	hasRollover()	Returns whether this year's totals include rollovers from the previous year.
EliteLevel	matches(Collection<EliteLevel> lvls)	Returns the highest level whose requirements match this total.
boolean	matches(EliteTotals el)	Returns whether these totals match the requirements for a given Elite level.
void	reset(int year)	Resets the totals.
String	toString()
UpgradeReason	wouldMatch(EliteTotals el, FlightEliteScore sc)	Returns whether a specific flight leg would trigger a given Elite Level.

Methods inherited from class DatabaseBean

compareTo, equals, getHexID, getID, hashCode, setID, validateID, validateID

Modifier and Type	Method	Description
int	compareTo(Object o)
boolean	equals(Object o)
String	getHexID()	Returns the hexadecimal database ID of this object.
int	getID()	Returns the database ID of this object.
int	hashCode()
void	setID(int id)	Update the database row ID of this bean.
static void	validateID(int oldID, int newID)	Validates a database ID.
static void	validateID(int oldID, int newID, boolean allowZero)	Validates a database ID.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EliteTotals

hasDistance, hasLegs, hasPoints, isZero

Modifier and Type	Method	Description
default boolean	hasDistance()	Returns if the distance flown is greater than zero.
default boolean	hasLegs()	Returns if the number of flight lges is greater than zero.
default boolean	hasPoints()	Returns if the number of Elite points is greater than zero.
default boolean	isZero()	Returns if legs, distance and points are all zero.

Constructor Details

YearlyTotal

public YearlyTotal(int year,
 int pilotID)

Creates the bean.

Parameters:

year - the program year

pilotID - the Pilot's Database ID

Method Details

getLegs

public int getLegs()

Description copied from interface: EliteTotals

Returns the number of flight legs.

Specified by:

getLegs in interface EliteTotals

Returns:

the number of legs

getDistance

public int getDistance()

Description copied from interface: EliteTotals

Returns the distance flown.

Specified by:

getDistance in interface EliteTotals

Returns:

the distance in miles

getPoints

public int getPoints()

Description copied from interface: EliteTotals

Returns the number of Elite points.

Specified by:

getPoints in interface EliteTotals

Returns:

the number of points

getYear

public int getYear()

Returns the program year.

Returns:

the year

hasRollover

public boolean hasRollover()

Returns whether this year's totals include rollovers from the previous year.

Returns:

FALSE

reset

public void reset(int year)

Resets the totals.

Parameters:

year - the new program year

add

public void add(FlightEliteScore sc)

Adds a Flight's totals.

Parameters:

sc - a FlightEliteScore

addLegs

public void addLegs(int legs,
 int distance,
 int pts)

Adds aggregated totals.

Parameters:

legs - the number of flight legs

distance - the distance in miles

pts - the flight score

adjust

public YearlyTotal adjust(LocalDate ld)

Projects year to date totals over a full year. This will have no effect on totals for a prior year.

Parameters:

ld - the date to project from

Returns:

a YearlyTotal bean

matches

public boolean matches(EliteTotals el)

Returns whether these totals match the requirements for a given Elite level.

Parameters:

el - the EliteLevel

Returns:

TRUE if the legs, distance and points all exceed the requirements

matches

public EliteLevel matches(Collection<EliteLevel> lvls)

Returns the highest level whose requirements match this total.

Parameters:

lvls - a Collection of EliteLevels

Returns:

an EliteLevel, or the first level if none match

delta

public YearlyTotal delta(EliteLevel el)

Returns the prerequisites required to achieve a particular Elite level.

Parameters:

el - the EliteLevel

Returns:

a YearlyTotal with the amounts required

wouldMatch

public UpgradeReason wouldMatch(EliteTotals el,
 FlightEliteScore sc)

Returns whether a specific flight leg would trigger a given Elite Level.

Parameters:

el - the EliteLevel

sc - the FlightEliteScore for that leg

Returns:

an UpgradeReason

cacheKey

public Object cacheKey()

Description copied from interface: Cacheable

Returns the cache key for this object. Caches call this method when adding the object.

Specified by:

cacheKey in interface Cacheable

Overrides:

cacheKey in class DatabaseBean

Returns:

the cache key for the object

toString

public String toString()

Overrides:

toString in class Object