com.github.dannil.scbjavaclient.model.population.partnership

Class Partnership

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

com.github.dannil.scbjavaclient.model.population.partnership.Partnership

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

Model for partnership data.

Author:

Daniel Nilsson

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
Partnership() Default constructor.
Partnership(String region, String maritalStatus, String sex, Integer year, List<ValueNode<Integer>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the partnership data from the API.
String	getMaritalStatus() Getter for marital status.
String	getSex() Getter for sex.
int	hashCode()
void	setMaritalStatus(String maritalStatus) Setter for marital status.
void	setSex(String sex) Setter for sex.
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

Partnership

public Partnership()

Default constructor.

Partnership

public Partnership(String region,
                   String maritalStatus,
                   String sex,
                   Integer year,
                   List<ValueNode<Integer>> values)

Overloaded constructor.

Parameters:

region - the region

maritalStatus - the marital status

sex - the sex

year - the year

values - the values

Method Detail

getMaritalStatus

public String getMaritalStatus()

Getter for marital status.

Returns:

the marital status.

setMaritalStatus

public void setMaritalStatus(String maritalStatus)

Setter for marital status.

Parameters:

maritalStatus - the marital status

getSex

public String getSex()

Getter for sex.

Returns:

the sex.

setSex

public void setSex(String sex)

Setter for sex.

Parameters:

sex - the sex

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRegionYearAndValueModel<String,Integer,Integer>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRegionYearAndValueModel<String,Integer,Integer>

toString

public String toString()

Specified by:

toString in class AbstractRegionYearAndValueModel<String,Integer,Integer>

getInputs

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

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

Returns:

a list of the available codes and their values