Package com.storedobject.common

Class GBAddress

java.lang.Object

com.storedobject.common.Address

com.storedobject.common.GBAddress

public class GBAddress
extends Address

Represents an address specific to Great Britain with additional functionality for handling British postal codes and post towns. This class extends the Address class to provide GB-specific implementation details.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
String	getAreaCaption()	Get the caption for the "area" line.
int	getExtraLines()	Get the number of extra lines.
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	getPostTown()	Retrieves the post town from the address lines.
boolean	isNumericPostalCode()	Whether the postal code is numeric or not.
void	setPostTown(String postTown)	Sets the post town for the address.

Methods inherited from class com.storedobject.common.Address

arrangeLines, check, check, copy, create, create, encode, getApartmentName, getAreaName, getBuildingName, getCountry, getHouseName, getLine, getOfficeName, getPOBox, getPOBoxName, getPostalCode, getStreetName, getType, getTypeValue, getTypeValue, getTypeValues, getVillaName, isPOBoxAddress, isPostalCodeAddress, isPostalCodeMandatory, isValid, poBoxPrefix, poBoxSuffix, setApartmentName, setAreaName, setBuildingName, setHouseName, setLine, setOfficeName, setPOBox, setPostalCode, setStreetName, setType, setVillaName, toString, toString, validate

Methods inherited from class java.lang.Object

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

Method Details

getPostalCodeMaxLength

public int getPostalCodeMaxLength()

Description copied from class: Address

What is the maximum length of the postal code?

Overrides:

getPostalCodeMaxLength in class Address

Returns:

Maximum required length of the postal code.

getPostalCodeMinLength

public int getPostalCodeMinLength()

Description copied from class: Address

What is the minimum length of the postal code?

Overrides:

getPostalCodeMinLength in class Address

Returns:

Minimum required length of the postal code.

getExtraLines

public int getExtraLines()

Description copied from class: Address

Get the number of extra lines.

Overrides:

getExtraLines in class Address

Returns:

Number of extra lines in the address.

getPostTown

public String getPostTown()

Retrieves the post town from the address lines. The post town is a specific required component of postal addresses in Great Britain.

Returns:

the name of the post town as a String. If the post town is not defined, an empty string is returned.

setPostTown

public void setPostTown(String postTown)

Sets the post town for the address. The post town is converted to uppercase and any leading or trailing whitespace is trimmed before being assigned.

Parameters:

postTown - the name of the post town to be set. This should not be null or blank.

getPostalCodeCaption

public String getPostalCodeCaption()

Description copied from class: Address

Get the caption for the Postal Code.

Overrides:

getPostalCodeCaption in class Address

Returns:

Default implementation returns "Postal Code".

isNumericPostalCode

public boolean isNumericPostalCode()

Description copied from class: Address

Whether the postal code is numeric or not.

Overrides:

isNumericPostalCode in class Address

Returns:

True if numeric. False if alpha-numeric.

getAreaCaption

public String getAreaCaption()

Description copied from class: Address

Get the caption for the "area" line.

Overrides:

getAreaCaption in class Address

Returns:

Default implementation returns "Area".