com.github.dannil.scbjavaclient.model

Class AbstractRegionYearAndValueModel<R,Y,V>

java.lang.Object

com.github.dannil.scbjavaclient.model.AbstractValueModel<V>

com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel<Y,V>

com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel<R,Y,V>

Type Parameters:

R - the region

Y - the year

V - the value

Direct Known Subclasses:

Area, AverageAge, Density, FertilityRate, LiveBirth, MeanAgeFirstChild, Partnership, PartnershipChange, Population

public abstract class AbstractRegionYearAndValueModel<R,Y,V>
extends AbstractYearAndValueModel<Y,V>

Abstract model which handles region, year and value. Since these values are used by almost every single client response, this class will be extended by a majority of the implemented models.

Author:

Daniel Nilsson

Field Summary

Fields

Modifier and Type	Field and Description
protected R	region

Fields inherited from class com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel

year

Fields inherited from class com.github.dannil.scbjavaclient.model.AbstractValueModel

values

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegionYearAndValueModel() Default constructor.
protected	AbstractRegionYearAndValueModel(R region, Y year, List<ValueNode<V>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
R	getRegion() Getter for region.
int	hashCode()
void	setRegion(R region) Setter for region.
abstract String	toString()

Methods inherited from class com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel

getYear, setYear

Methods inherited from class com.github.dannil.scbjavaclient.model.AbstractValueModel

getValue, getValues, setValue, setValues

Methods inherited from class java.lang.Object

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

Field Detail

region

protected R region

Constructor Detail

AbstractRegionYearAndValueModel

protected AbstractRegionYearAndValueModel()

Default constructor.

AbstractRegionYearAndValueModel

protected AbstractRegionYearAndValueModel(R region,
                                          Y year,
                                          List<ValueNode<V>> values)

Overloaded constructor.

Parameters:

region - the region

year - the year

values - the values

Method Detail

getRegion

public R getRegion()

Getter for region.

Returns:

the region

setRegion

public void setRegion(R region)

Setter for region.

Parameters:

region - the region

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractYearAndValueModel<Y,V>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractYearAndValueModel<Y,V>

toString

public abstract String toString()

Specified by:

toString in class AbstractYearAndValueModel<Y,V>