Package com.storedobject.common

Class INAddress

java.lang.Object

com.storedobject.common.Address

com.storedobject.common.INAddress

public final class INAddress
extends Address

IN Address
line[0]: Post Office
line[1]: District code
line[2]: State code

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.
protected String	convert(int lineNumber)
int	getDistrict()	Retrieves the district code associated with this address.
String	getDistrictName()	Retrieves the name of the district associated with this address.
static String[]	getDistricts(int state)	Retrieves the list of districts associated with the specified state.
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?
String	getPostOfficeName()	Retrieves the name of the post office associated with this address.
int	getState()	Retrieves the state code associated with this address.
String	getStateName()	Retrieves the name of the state associated with this address.
static String[]	getStates()	Retrieves the list of states associated with the address.
boolean	isPostalCodeMandatory()	Is postal code mandatory?
protected boolean	parse()
void	setDistrict(int district)	Sets the district code for this address.
void	setPostOfficeName(String name)	Sets the name of the post office associated with this address.
void	setState(int state)	Sets the state code for this address.

Methods inherited from class com.storedobject.common.Address

check, check, copy, create, create, encode, getApartmentName, getAreaCaption, getAreaName, getBuildingName, getCountry, getHouseName, getLine, getOfficeName, getPOBox, getPOBoxName, getPostalCode, 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

parse

protected boolean parse()
                 throws SOException

Throws:

SOException

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.

convert

protected String convert(int lineNumber)
                  throws SOException

Throws:

SOException

getPostOfficeName

public String getPostOfficeName()

Retrieves the name of the post office associated with this address.

Returns:

The name of the post office as a String.

setPostOfficeName

public void setPostOfficeName(String name)

Sets the name of the post office associated with this address.

Parameters:

name - The name of the post office to be set. If the value is null, it sets an empty string as the post office name.

getState

public int getState()
             throws SOException

Retrieves the state code associated with this address.

Returns:

The state code as an integer.

Throws:

SOException - If an error occurs during the extraction process.

setState

public void setState(int state)

Sets the state code for this address. The state index is calculated in a cyclic manner based on the total number of states. If an error occurs while retrieving the district, a default value of 0 is used.

Parameters:

state - The state code to be set. The value should be a non-negative integer. The method ensures its validity by taking the modulo with the total number of available states.

getStateName

public String getStateName()

Retrieves the name of the state associated with this address.

Returns:

The name of the state as a String.

getDistrict

public int getDistrict()
                throws SOException

Retrieves the district code associated with this address.

Returns:

The district code as an integer.

Throws:

SOException - If an error occurs during the extraction process.

setDistrict

public void setDistrict(int district)

Sets the district code for this address. The district is calculated in a cyclic manner based on the total number of districts available for the state. If an error occurs while retrieving the state, a default state of 0 is used.

Parameters:

district - The district code to be set. The value is normalized by taking the modulo with the total number of districts available for the determined state.

getDistrictName

public String getDistrictName()
                       throws SOException

Retrieves the name of the district associated with this address.

Returns:

The district name as a String.

Throws:

SOException - If an error occurs during the extraction process.

getStates

public static String[] getStates()

Retrieves the list of states associated with the address.

Returns:

An array of Strings representing the states.

getDistricts

public static String[] getDistricts(int state)

Retrieves the list of districts associated with the specified state.

Parameters:

state - The state code for which the districts are to be retrieved. The value is expected to correspond to an index within the valid range of states.

Returns:

An array of Strings representing the districts associated with the specified state.

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".

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.

isPostalCodeMandatory

public boolean isPostalCodeMandatory()

Description copied from class: Address

Is postal code mandatory?

Overrides:

isPostalCodeMandatory in class Address

Returns:

True/false.

arrangeLines

protected void arrangeLines(ArrayList<String> lines)

Description copied from class: Address

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

Overrides:

arrangeLines in class Address

Parameters:

lines - Address lines.