Package com.storedobject.common

Class Address

java.lang.Object

com.storedobject.common.Address

Direct Known Subclasses:

AEAddress, CHAddress, GBAddress, INAddress, MYAddress, PKAddress, USAddress, XXAddress

public abstract class Address
extends Object

Class to check and manipulate mailing address information. Address is a String containing multiple lines of text (delimited by newline character). A valid address is stored in the following format:
First line: CCdX where
CC = the ISO 2 character country code (Example: IN for India, PK for Pakistan, US for USA)
d = Digit 0, 1, 2 or 3 (0 for Apartment, 1 for Villa, 2 for House, 3 for Office)
X = Apartment/villa/office number/name. Can contain any free text but can't be blank
Second line: Building name (may include floor/level etc.). Mandatory for apartments.
Third line: Street name.
Fourth line: Area/Community name.
Depending on the country, rest of the lines are interpreted.
Generic address is formatted as follows:
Line 0: Apartment/Villa/House XXX
Line 1: Building Name
Line 2: Street Name
Line 3: Area/Community Name
Line 4: Country Name

Author:

Syam

Method Summary

Modifier and Type	Method	Description
protected void	arrangeLines(ArrayList<String> lines)	This method is invoked for arranging the address lines to be displayed.
static String	check(String address)	Check correctness of the format of the given address.
static String	check(String address, boolean allowEmpty)	Check correctness of the format of the given address.
boolean	copy(Address address)	Copy details from the given address.
static Address	create(Country country)	Create a blank country specific address.
static Address	create(String address)	Create a country specific address from the give details.
String	encode()	Encode the address.
String	getApartmentName()	Get the apartment/villa/house/office name.
String	getAreaCaption()	Get the caption for the "area" line.
String	getAreaName()	Get area name.
String	getBuildingName()	Get the building name.
Country	getCountry()	Get country of this address.
int	getExtraLines()	Get the number of extra lines.
String	getHouseName()	Get the apartment/villa/house/office name.
String	getLine(int lineNumber)	Get a line (extra line) from the address.
String	getOfficeName()	Get the apartment/villa/house/office name.
final int	getPOBox()	Get the Post Box number.
String	getPOBoxName()	Get the caption for the Post Box.
final String	getPostalCode()	Get the Postal Code.
String	getPostalCodeCaption()	Get the caption for the Postal Code.
int	getPostalCodeMaxLength()	What is the maximum length of the postal code?
int	getPostalCodeMinLength()	What is the minimum length of the postal code?
String	getStreetName()	Get street name.
char	getType()	Get the type code.
String	getTypeValue()	Get the type code value.
static String	getTypeValue(char type)	Get the type code value for the given type.
static StringList	getTypeValues()	Get the type of addresses.
String	getVillaName()	Get the apartment/villa/house/office name.
boolean	isNumericPostalCode()	Whether the postal code is numeric or not.
final boolean	isPOBoxAddress()	Check if this is a Post Box based address.
final boolean	isPostalCodeAddress()	Check if this is a Postal Code based address.
boolean	isPostalCodeMandatory()	Is postal code mandatory?
final boolean	isValid()	Returns if the address is valid or not.
String	poBoxPrefix()	Prefix to be used when printing the PO box.
String	poBoxSuffix()	Suffix to be used when printing the PO box.
void	setApartmentName(String apartmentName)	Set the apartment/villa/house/office name.
void	setAreaName(String areaName)	Set area name.
void	setBuildingName(String buildingName)	Set the building name.
void	setHouseName(String houseName)	Set the apartment/villa/house/office name.
void	setLine(int lineNumber, String line)	Set an address line (extra line).
void	setOfficeName(String officeName)	Set the apartment/villa/house/office name.
final void	setPOBox(int poBox)	Set the Post Box number.
final void	setPostalCode(String postalCode)	Set the Postal Code.
void	setStreetName(String streetName)	Set street name.
void	setType(char type)	Set the type code.
void	setVillaName(String villaName)	Set the apartment/villa/house/office name.
final String	toString()	Convert the address into a human-readable String representation.
String	toString(String personName)	Same as toString() method but the name passed is included as the first line in the case of personal address or second name in the case of office addresses. .
final void	validate()	Validate the address.

Methods inherited from class java.lang.Object

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

Method Details

check

public static String check(String address)
                    throws SOException

Check correctness of the format of the given address.

Parameters:

address - Address

Returns:

Address (may be modified).

Throws:

SOException - If the email format is not valid

check

public static String check(String address,
 boolean allowEmpty)
                    throws SOException

Check correctness of the format of the given address.

Parameters:

address - Address

allowEmpty - Whether empty should be taken as valid or not

Returns:

Address (may be modified).

Throws:

SOException - If the email format is not valid

isValid

public final boolean isValid()

Returns if the address is valid or not.

Returns:

True or false.

validate

public final void validate()
                    throws Exception

Validate the address.

Throws:

Exception - if invalid.

copy

public boolean copy(Address address)

Copy details from the given address. Country will not be copied.

Parameters:

address - Address from which details to be copied.

Returns:

True if the address is valid after copying details.

create

public static Address create(String address)

Create a country specific address from the give details.

Parameters:

address - Address information in appropriate format

Returns:

Address created or null if address can't be created. The created address may be invalid.

create

public static Address create(Country country)

Create a blank country specific address.

Parameters:

country - Country for which address to be created.

Returns:

Country specific blank address.

toString

public final String toString()

Convert the address into a human-readable String representation.

Overrides:

toString in class Object

Returns:

Human-readable String representation with required "new lines".

toString

public String toString(String personName)

Same as toString() method but the name passed is included as the first line in the case of personal address or second name in the case of office addresses. .

Parameters:

personName - Person name to be included

Returns:

Human-readable String representation with required "new lines".

arrangeLines

protected void arrangeLines(ArrayList<String> lines)

This method is invoked for arranging the address lines to be displayed.

Parameters:

lines - Address lines.

encode

public String encode()

Encode the address.

Returns:

Encoded address. Null will be returned if the address is not valid.

getExtraLines

public int getExtraLines()

Get the number of extra lines.

Returns:

Number of extra lines in the address.

getLine

public String getLine(int lineNumber)

Get a line (extra line) from the address.

Parameters:

lineNumber - Line number

Returns:

Line if exists, else null.

setLine

public void setLine(int lineNumber,
 String line)

Set an address line (extra line).

Parameters:

lineNumber - Line number.

line - Value to be set.

getTypeValue

public String getTypeValue()

Get the type code value.

Returns:

Type code value.

getTypeValue

public static String getTypeValue(char type)

Get the type code value for the given type.

Returns:

Type code value.

getTypeValues

public static StringList getTypeValues()

Get the type of addresses.

Returns:

Address types.

getType

public char getType()

Get the type code.

Returns:

Type code.

setType

public void setType(char type)

Set the type code.

Parameters:

type - Type code

getApartmentName

public String getApartmentName()

Get the apartment/villa/house/office name.

Returns:

Apartment/villa/house/office name.

setApartmentName

public void setApartmentName(String apartmentName)

Set the apartment/villa/house/office name.

Parameters:

apartmentName - Apartment/villa/house/office name

getVillaName

public String getVillaName()

Get the apartment/villa/house/office name.

Returns:

Apartment/villa/house/office name.

setVillaName

public void setVillaName(String villaName)

Set the apartment/villa/house/office name.

Parameters:

villaName - Apartment/villa/house/office name

getHouseName

public String getHouseName()

Get the apartment/villa/house/office name.

Returns:

Apartment/villa/house/office name.

setHouseName

public void setHouseName(String houseName)

Set the apartment/villa/house/office name.

Parameters:

houseName - Apartment/villa/house/office name

getOfficeName

public String getOfficeName()

Get the apartment/villa/house/office name.

Returns:

Apartment/villa/house/office name.

setOfficeName

public void setOfficeName(String officeName)

Set the apartment/villa/house/office name.

Parameters:

officeName - Apartment/villa/house/office name

getBuildingName

public String getBuildingName()

Get the building name.

Returns:

Building name.

setBuildingName

public void setBuildingName(String buildingName)

Set the building name.

Parameters:

buildingName - Building name to be set

getStreetName

public String getStreetName()

Get street name.

Returns:

Street name.

setStreetName

public void setStreetName(String streetName)

Set street name.

Parameters:

streetName - Street name to set

getAreaName

public String getAreaName()

Get area name.

Returns:

Area name.

setAreaName

public void setAreaName(String areaName)

Set area name.

Parameters:

areaName - Area name to set

getCountry

public Country getCountry()

Get country of this address.

Returns:

Country.

isPOBoxAddress

public final boolean isPOBoxAddress()

Check if this is a Post Box based address.

Returns:

True or false.

setPOBox

public final void setPOBox(int poBox)

Set the Post Box number.

Parameters:

poBox - Post Box number

getPOBox

public final int getPOBox()

Get the Post Box number.

Returns:

Post Box number.

poBoxPrefix

public String poBoxPrefix()

Prefix to be used when printing the PO box.

Returns:

By default, getPOBoxName() is returned.

poBoxSuffix

public String poBoxSuffix()

Suffix to be used when printing the PO box.

Returns:

By default, an empty string is returned.

isPostalCodeAddress

public final boolean isPostalCodeAddress()

Check if this is a Postal Code based address.

Returns:

True or false.

getPostalCode

public final String getPostalCode()

Get the Postal Code.

Returns:

Postal Code.

setPostalCode

public final void setPostalCode(String postalCode)

Set the Postal Code.

Parameters:

postalCode - Postal Code

getPostalCodeCaption

public String getPostalCodeCaption()

Get the caption for the Postal Code.

Returns:

Default implementation returns "Postal Code".

isNumericPostalCode

public boolean isNumericPostalCode()

Whether the postal code is numeric or not.

Returns:

True if numeric. False if alpha-numeric.

isPostalCodeMandatory

public boolean isPostalCodeMandatory()

Is postal code mandatory?

Returns:

True/false.

getPostalCodeMinLength

public int getPostalCodeMinLength()

What is the minimum length of the postal code?

Returns:

Minimum required length of the postal code.

getPostalCodeMaxLength

public int getPostalCodeMaxLength()

What is the maximum length of the postal code?

Returns:

Maximum required length of the postal code.

getPOBoxName

public String getPOBoxName()

Get the caption for the Post Box.

Returns:

Default implementation returns "Post Box".

getAreaCaption

public String getAreaCaption()

Get the caption for the "area" line.

Returns:

Default implementation returns "Area".