com.github.dannil.scbjavaclient.model.population.demography

Class FertilityRate

java.lang.Object

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

com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel<String,Integer,Double>

com.github.dannil.scbjavaclient.model.population.demography.FertilityRate

public class FertilityRate
extends AbstractRegionYearAndValueModel<String,Integer,Double>

Model for fertility rate.

Author:

Daniel Nilsson

Field Summary

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

region, year

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

value

Constructor Summary

Constructors

Constructor and Description
FertilityRate() Default constructor.
FertilityRate(String region, Integer gender, Integer year, Double value) Overloaded constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static List<String>	getCodes() Get the codes for the fertility rate from the API.
Integer	getGender() Getter for gender.
int	hashCode()
void	setGender(Integer gender) Setter for gender.
String	toString()

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

getRegion, getYear, setRegion, setYear

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

getValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FertilityRate

public FertilityRate()

Default constructor.

FertilityRate

public FertilityRate(String region,
             Integer gender,
             Integer year,
             Double value)

Overloaded constructor.

Parameters:

region - the region

gender - the gender

year - the year

value - the value

Method Detail

getGender

public Integer getGender()

Getter for gender.

Returns:

the gender

setGender

public void setGender(Integer gender)

Setter for gender.

Parameters:

gender - the gender

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRegionYearAndValueModel<String,Integer,Double>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRegionYearAndValueModel<String,Integer,Double>

toString

public String toString()

Specified by:

toString in class AbstractRegionYearAndValueModel<String,Integer,Double>

getCodes

public static List<String> getCodes()

Get the codes for the fertility rate from the API.

Returns:

a list of codes that is used by the API to index the values