Package com.storedobject.common

Class PKAddress

java.lang.Object

com.storedobject.common.Address

com.storedobject.common.PKAddress

public final class PKAddress
extends Address

IN Address
line[0]: Place name within the district
line[1]: District code
line[2]: Province code

Author:

Syam

Method Summary

Modifier and Type	Method	Description
int	getDistrict()	Retrieves the district identifier from the address data.
String	getDistrictName()	Retrieves the name of the district from the address data.
static String[]	getDistricts(int state)	Retrieves the list of districts for a specified state.
int	getExtraLines()	Get the number of extra lines.
String	getPlaceName()	Retrieves the name of the place from the address data.
int	getPostalCodeMaxLength()	What is the maximum length of the postal code?
int	getProvince()	Retrieves the province identifier from the address data.
String	getProvinceName()	Retrieves the name of the province from the address data.
static String[]	getProvinces()	Retrieves the list of provinces available in the address data.
boolean	isPostalCodeMandatory()	Is postal code mandatory?
void	setDistrict(int district)	Sets the district identifier in the address data.
void	setPlaceName(String placeName)	Sets the name of the place in the address data.
void	setProvince(int province)	Sets the province identifier in the address data.

Methods inherited from class com.storedobject.common.Address

arrangeLines, check, check, copy, create, create, encode, getApartmentName, getAreaCaption, getAreaName, getBuildingName, getCountry, getHouseName, getLine, getOfficeName, getPOBox, getPOBoxName, getPostalCode, getPostalCodeCaption, getPostalCodeMinLength, getStreetName, getType, getTypeValue, getTypeValue, getTypeValues, getVillaName, isNumericPostalCode, isPOBoxAddress, isPostalCodeAddress, 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

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.

getPlaceName

public String getPlaceName()

Retrieves the name of the place from the address data.

Returns:

The name of the place extracted from the address lines.

setPlaceName

public void setPlaceName(String placeName)

Sets the name of the place in the address data.

Parameters:

placeName - The name of the place to set. If null, it is replaced with an empty string.

getProvince

public int getProvince()
                throws SOException

Retrieves the province identifier from the address data.

Returns:

The province identifier extracted from the address lines.

Throws:

SOException - If an error occurs while extracting the province information.

setProvince

public void setProvince(int province)

Sets the province identifier in the address data.

Parameters:

province - The province identifier to set. The value is adjusted to ensure it falls within the valid range based on the number of provinces available.

getProvinceName

public String getProvinceName()

Retrieves the name of the province from the address data.

Returns:

The name of the province extracted from the address lines.

getDistrict

public int getDistrict()
                throws SOException

Retrieves the district identifier from the address data.

Returns:

The district identifier extracted from the address lines.

Throws:

SOException - If an error occurs while extracting the district information.

setDistrict

public void setDistrict(int district)

Sets the district identifier in the address data.

Parameters:

district - The district identifier to set. The value is adjusted to ensure it falls within the valid range of districts for the specified province.

getDistrictName

public String getDistrictName()
                       throws SOException

Retrieves the name of the district from the address data.

Returns:

The name of the district extracted from the address lines.

Throws:

SOException - If an error occurs while extracting the district information.

getProvinces

public static String[] getProvinces()

Retrieves the list of provinces available in the address data.

Returns:

An array of strings containing the names of all provinces.

getDistricts

public static String[] getDistricts(int state)

Retrieves the list of districts for a specified state.

Parameters:

state - The index of the state for which the districts are to be retrieved. The index corresponds to the position of the state in a predefined collection of states.

Returns:

An array of strings containing the names of the districts for the specified state.

isPostalCodeMandatory

public boolean isPostalCodeMandatory()

Description copied from class: Address

Is postal code mandatory?

Overrides:

isPostalCodeMandatory in class Address

Returns:

True/false.

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.