com.github.dannil.scbjavaclient.model.population.amount

Class Population

java.lang.Object

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

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

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

com.github.dannil.scbjavaclient.model.population.amount.Population

public class Population
extends AbstractRegionYearAndValueModel<String,Integer,String>

Model for population data.

Since:

0.1.0

Field Summary

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

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

Constructor and Description
Population() Default constructor.
Population(String region, String relationshipStatus, String age, Integer gender, Integer year, List<ValueNode<String>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAge() Getter for age.
Integer	getGender() Getter for gender.
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the population data from the API.
String	getRelationshipStatus() Getter for relationship status.
int	hashCode()
void	setAge(String age) Setter for age.
void	setGender(Integer gender) Setter for gender.
void	setRelationshipStatus(String relationshipStatus) Setter for relationship status.
String	toString()

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

getRegion, setRegion

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

Constructor Detail

Population

public Population()

Default constructor.

Population

public Population(String region,
                  String relationshipStatus,
                  String age,
                  Integer gender,
                  Integer year,
                  List<ValueNode<String>> values)

Overloaded constructor.

Parameters:

region - the region

relationshipStatus - the relationship status

age - the age

gender - the gender

year - the year

values - the values

Method Detail

getRelationshipStatus

public String getRelationshipStatus()

Getter for relationship status.

Returns:

the relationship status

setRelationshipStatus

public void setRelationshipStatus(String relationshipStatus)

Setter for relationship status.

Parameters:

relationshipStatus - the relationship status

getAge

public String getAge()

Getter for age.

Returns:

the age

setAge

public void setAge(String age)

Setter for age.

Parameters:

age - the age

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,String>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRegionYearAndValueModel<String,Integer,String>

toString

public String toString()

Specified by:

toString in class AbstractRegionYearAndValueModel<String,Integer,String>

getInputs

public static Map<String,Collection<String>> getInputs()

Get the available codes and their respective values for the population data from the API.

Returns:

a list of the available codes and their values