org.opensrp.api.domain

Class Address

java.lang.Object

org.opensrp.api.domain.Address

public class Address
extends Object

Constructor Summary

Constructors

Constructor and Description
Address()
Address(String addressType, Date startDate, Date endDate, Map<String,String> addressFields, String latitude, String longitute, String postalCode, String state, String country)

Method Summary

Modifier and Type	Method and Description
void	addAddressField(org.opensrp.common.AddressField field, String value) Add field name from a list of predefined options from enum AddressField
void	addAddressField(String field, String value)
int	durationInDays() If startDate is not specified returns -1.
int	durationInMonths() If startDate is not specified returns -1.
int	durationInWeeks() If startDate is not specified returns -1.
int	durationInYears() If startDate is not specified returns -1.
String	getAddressField(org.opensrp.common.AddressField addressField)
String	getAddressField(String addressField)
String	getAddressFieldMatchingRegex(String regex) Returns field matching the regex.
Map<String,String>	getAddressFields()
String	getAddressType()
String	getCountry()
Date	getEndDate()
String	getLatitude()
String	getLongitute()
String	getPostalCode()
Date	getStartDate()
String	getState()
boolean	isActive() True if endDate is null or endDate is in future
void	removeAddressField(org.opensrp.common.AddressField field)
void	removeAddressField(String field)
void	setAddressFields(Map<String,String> addressFields) WARNING: Overrides all existing fields
void	setAddressType(String addressType)
void	setCountry(String country)
void	setEndDate(Date endDate)
void	setLatitude(String latitude)
void	setLongitute(String longitute)
void	setPostalCode(String postalCode)
void	setStartDate(Date startDate)
void	setState(String state)
String	toString()
Address	withAddressField(org.opensrp.common.AddressField field, String value)
Address	withAddressField(String field, String value)
Address	withAddressFields(Map<String,String> addressFields) WARNING: Overrides all existing fields
Address	withAddressType(String addressType) The type address represents
Address	withCountry(String country)
Address	withEndDate(Date endDate) The date when address was outdated or abandoned
Address	withLatitude(String latitude)
Address	withLongitute(String longitute)
Address	withPostalCode(String postalCode)
Address	withStartDate(Date startDate) The date when address was started or owned
Address	withState(String state)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address()

Address

public Address(String addressType,
               Date startDate,
               Date endDate,
               Map<String,String> addressFields,
               String latitude,
               String longitute,
               String postalCode,
               String state,
               String country)

Method Detail

getAddressType

public String getAddressType()

setAddressType

public void setAddressType(String addressType)

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date startDate)

getEndDate

public Date getEndDate()

setEndDate

public void setEndDate(Date endDate)

getAddressFields

public Map<String,String> getAddressFields()

getAddressField

public String getAddressField(String addressField)

getAddressFieldMatchingRegex

public String getAddressFieldMatchingRegex(String regex)

Returns field matching the regex. Note that incase of multiple fields matching criteria function would return first match. The must be well formed to find out a single value

Parameters:

regex -

Returns:

getAddressField

public String getAddressField(org.opensrp.common.AddressField addressField)

setAddressFields

public void setAddressFields(Map<String,String> addressFields)

WARNING: Overrides all existing fields

Parameters:

addressFields -

addAddressField

public void addAddressField(String field,
                            String value)

addAddressField

public void addAddressField(org.opensrp.common.AddressField field,
                            String value)

Add field name from a list of predefined options from enum AddressField

Parameters:

field -

value -

removeAddressField

public void removeAddressField(org.opensrp.common.AddressField field)

removeAddressField

public void removeAddressField(String field)

getLatitude

public String getLatitude()

setLatitude

public void setLatitude(String latitude)

getLongitute

public String getLongitute()

setLongitute

public void setLongitute(String longitute)

getPostalCode

public String getPostalCode()

setPostalCode

public void setPostalCode(String postalCode)

getState

public String getState()

setState

public void setState(String state)

getCountry

public String getCountry()

setCountry

public void setCountry(String country)

isActive

public boolean isActive()

True if endDate is null or endDate is in future

Returns:

durationInDays

public int durationInDays()

If startDate is not specified returns -1. If endDate is not specified duration is from startDate to current date

Returns:

durationInWeeks

public int durationInWeeks()

If startDate is not specified returns -1. If endDate is not specified duration is from startDate to current date

Returns:

durationInMonths

public int durationInMonths()

If startDate is not specified returns -1. If endDate is not specified duration is from startDate to current date

Returns:

durationInYears

public int durationInYears()

If startDate is not specified returns -1. If endDate is not specified duration is from startDate to current date

Returns:

withAddressType

public Address withAddressType(String addressType)

The type address represents

Parameters:

addressType -

Returns:

withStartDate

public Address withStartDate(Date startDate)

The date when address was started or owned

Parameters:

endDate -

Returns:

withEndDate

public Address withEndDate(Date endDate)

The date when address was outdated or abandoned

Parameters:

endDate -

Returns:

withAddressFields

public Address withAddressFields(Map<String,String> addressFields)

WARNING: Overrides all existing fields

Parameters:

addressFields -

Returns:

withAddressField

public Address withAddressField(String field,
                                String value)

withAddressField

public Address withAddressField(org.opensrp.common.AddressField field,
                                String value)

withLatitude

public Address withLatitude(String latitude)

withLongitute

public Address withLongitute(String longitute)

withPostalCode

public Address withPostalCode(String postalCode)

withState

public Address withState(String state)

withCountry

public Address withCountry(String country)

toString

public String toString()

Overrides:

toString in class Object