curam.core.address.impl

Class AddressFormat

java.lang.Object

curam.core.address.impl.AddressFormat

@AccessLevel(value=EXTERNAL)
public abstract class AddressFormat
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static short	kAddressElementMinLength
protected static short	kAddressFirstLine
protected static short	kAddressLineOffset
protected static char	kEquals
protected static int	kEqualsLen
protected static int	kMaxAddressDataSize
protected static int	kMaxAddressLineSize
protected static short	kOtherAddressLinesCount
protected static int	kTabDelimiterLen

Constructor Summary

Constructors

Constructor and Description
AddressFormat()

Method Summary

Modifier and Type	Method and Description
abstract curam.core.struct.AddressLineList	getAddressAsList(curam.core.struct.OtherAddressData otherAddressData) Method returns address as vector of strings.
abstract curam.core.struct.OtherAddressData	getLongFormat(curam.core.struct.OtherAddressData addressDataString) Given an address in OtherAddressData format, get address data as list by calling method getAddressAsList.
abstract curam.core.struct.OtherAddressData	getShortFormat(curam.core.struct.OtherAddressData addressDataString) This method uses environment variable "ENV_ADDRESSSTRINGFORMAT" to frame short format of the address.
curam.core.struct.EmptyIndStruct	isEmpty(curam.core.struct.OtherAddressData details) This method checks addressData string in OtherAddressData object is empty.
curam.core.struct.EqualIndStruct	isEqual(curam.core.struct.OtherAddressData firstAddressData, curam.core.struct.OtherAddressData secondAddressData) This method compares addressData and returns whether they are equal or not.

Methods inherited from class java.lang.Object

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

Field Detail

kTabDelimiterLen

protected static final int kTabDelimiterLen

See Also:

Constant Field Values

kEqualsLen

protected static final int kEqualsLen

See Also:

Constant Field Values

kEquals

protected static final char kEquals

See Also:

Constant Field Values

kMaxAddressDataSize

protected static final int kMaxAddressDataSize

See Also:

Constant Field Values

kMaxAddressLineSize

protected static final int kMaxAddressLineSize

See Also:

Constant Field Values

kAddressElementMinLength

protected static final short kAddressElementMinLength

See Also:

Constant Field Values

kAddressFirstLine

protected static final short kAddressFirstLine

See Also:

Constant Field Values

kOtherAddressLinesCount

protected static final short kOtherAddressLinesCount

See Also:

Constant Field Values

kAddressLineOffset

protected static final short kAddressLineOffset

See Also:

Constant Field Values

Constructor Detail

AddressFormat

public AddressFormat()

Method Detail

isEmpty

@AccessLevel(value=EXTERNAL)
public curam.core.struct.EmptyIndStruct isEmpty(curam.core.struct.OtherAddressData details)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

This method checks addressData string in OtherAddressData object is empty. Input address passed as OtherAddressData object to the method. addressData attribute in OtherAddressData contains the address string. If addressData is empty return EmptyIndStruct as true. If not addressData is parsed and each tag element value is checked for empty, if the value is not empty then return EmptyIndStruct false. or if all the tag element are empty value then return EmptyIndStruct true.

Parameters:

OtherAddressData -

Returns:

EmptyIndStruct.emptyInd variable is set to true if address data is empty or set to false if address data is not empty

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

isEqual

@AccessLevel(value=EXTERNAL)
public curam.core.struct.EqualIndStruct isEqual(curam.core.struct.OtherAddressData firstAddressData,
                                                                             curam.core.struct.OtherAddressData secondAddressData)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

This method compares addressData and returns whether they are equal or not. First layout of the addressData is compared if not equal returns false. Both the addressData parsed, tag element value from secondAddressData is found from each tag element in the firstAddressData. If all the tag element and the value matches then EqualIndStruct returned as true, if not false is returned.

Parameters:

OtherAddressData -

OtherAddressData -

Returns:

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getShortFormat

@AccessLevel(value=EXTERNAL)
public abstract curam.core.struct.OtherAddressData getShortFormat(curam.core.struct.OtherAddressData addressDataString)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

This method uses environment variable "ENV_ADDRESSSTRINGFORMAT" to frame short format of the address. The Short format of the address is used, for example, in participant search result, in participant context panels and on the participant evidence page.

Parameters:

addressDataString -

Returns:

OtherAddressData

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getLongFormat

@AccessLevel(value=EXTERNAL)
public abstract curam.core.struct.OtherAddressData getLongFormat(curam.core.struct.OtherAddressData addressDataString)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Given an address in OtherAddressData format, get address data as list by calling method getAddressAsList. Return address list from getAddressAsList is iterated to create the required long format. The long format of the address is used, for example, in validations and by the financial component for contact details.

Parameters:

addressDataString -

Returns:

OtherAddressData

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getAddressAsList

@AccessLevel(value=EXTERNAL)
public abstract curam.core.struct.AddressLineList getAddressAsList(curam.core.struct.OtherAddressData otherAddressData)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Method returns address as vector of strings.

Parameters:

addressDataString - contains address ID.

Returns:

.contains address vector of strings.

Throws:

curam.util.exception.InformationalException - Generic Exception Signature.

curam.util.exception.AppException - Generic Exception Signature.