inspireit.uddi.base
Class Address

java.lang.Object
  |
  +--inspireit.uddi.base.Address

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class Address

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

The Address class is a simple list of AddressLine elements. UDDI compliant registries are responsible for preserving the order of any AddressLine data provided. Address structures also have two optional attributes for recording the useType (freeform text) and sortCode data. The sortCode values are not significant within a UDDI registry, but may be used by user interfaces that present contact information in some ordered fashion using the values provided in sortCode attribute.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected AddressLines	addressLines Structure containing the AddressLines.
protected UDDILocale	locale The locale defining the language used for the Address.
static TModelKey	postalAddress Canonical TModel that identifies a canonical postal address structure with common address sub-elements.
protected java.lang.String	sortCode Optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses.
protected TModelKey	tModelKey This is the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.
protected UseType	useType Optional attribute that is used to describe the type of address in freeform text.

Constructor Summary

Address()
Address constructor.

Method Summary

void	addAddressLine(AddressLine addressLine) Adds an AddressLine.
boolean	equals(java.lang.Object o) Checks whether an object is equal to this Address.
AddressLines	getAddressLines() Gets the AddressLines.
UDDILocale	getLocale() Gets the UDDILocale defining the language used for the Address.
java.lang.String	getSortCode() Gets the optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses.
TModelKey	getTModelKey() Gets the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.
UseType	getUseType() Gets the optional attribute that is used to describe the type of address in freeform text.
void	removeAddressLine(AddressLine addressLine) Removes an AddressLine.
void	setLocale(UDDILocale locale) Sets the locale defining the language used for the Address.
void	setSortCode(java.lang.String sortCode) Sets the optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses.
void	setTModelKey(TModelKey tModelKey) Sets the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.
void	setUseType(UseType useType) Sets the optional attribute that is used to describe the type of address in freeform text.
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this Address.

Methods inherited from class java.lang.Object

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

Field Detail

useType

protected UseType useType

Optional attribute that is used to describe the type of address in freeform text. Suggested examples include "headquarters", "sales office", "billing department", etc.

sortCode

protected java.lang.String sortCode

Optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses. The suggested values for sortCode include numeric ordering values (e.g. 1, 2, 3), alphabetic character ordering values (e.g. a, b, c) or the first n positions of relevant data within the address.

addressLines

protected AddressLines addressLines

Structure containing the AddressLines.

tModelKey

protected TModelKey tModelKey

This is the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.

locale

protected UDDILocale locale

The locale defining the language used for the Address.

postalAddress

public static final TModelKey postalAddress

Canonical TModel that identifies a canonical postal address structure with common address sub-elements.

Since:

UDDI V3.0

Constructor Detail

Address

public Address()

Address constructor.

Method Detail

addAddressLine

public void addAddressLine(AddressLine addressLine)

Adds an AddressLine.

Parameters:

addressLine - The AddressLine to add.

removeAddressLine

public void removeAddressLine(AddressLine addressLine)

Removes an AddressLine.

Parameters:

addressLine - The AddressLine to remove.

getAddressLines

public AddressLines getAddressLines()

Gets the AddressLines.

Returns:

the AddressLines

getUseType

public UseType getUseType()

Gets the optional attribute that is used to describe the type of address in freeform text. Typical examples include "headquarters", "sales office", "billing department", etc.

Returns:

a description of the type of address in freeform text.

setUseType

public void setUseType(UseType useType)

Sets the optional attribute that is used to describe the type of address in freeform text. Suggested examples include "headquarters", "sales office", "billing department", etc.

Parameters:

useType - A description of the type of address in freeform text.

getSortCode

public java.lang.String getSortCode()

Gets the optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses. The suggested values for sortCode include numeric ordering values (e.g. 1, 2, 3), alphabetic character ordering values (e.g. a, b, c) or the first n positions of relevant data within the address.

Returns:

the attribute that can be used to drive the behavior of external display mechanisms that sort addresses

setSortCode

public void setSortCode(java.lang.String sortCode)

Sets the optional attribute that can be used to drive the behavior of external display mechanisms that sort addresses. The suggested values for sortCode include numeric ordering values (e.g. 1, 2, 3), alphabetic character ordering values (e.g. a, b, c) or the first n positions of relevant data within the address.

Parameters:

sortCode - Data that can be used to drive the behavior of external display mechanisms that sort addresses.

getTModelKey

public TModelKey getTModelKey()

Gets the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.

Returns:

the TModelKey

Since:

UDDI V2.0

setTModelKey

public void setTModelKey(TModelKey tModelKey)

Sets the unique key reference that implies that the keyName keyValue pairs given by subsequent addressLine elements are to be interpreted by the taxonomy associated with the tModel that is referenced.

Parameters:

tModelKey - The TModelKey

Since:

UDDI V2.0

getLocale

public UDDILocale getLocale()

Gets the UDDILocale defining the language used for the Address.

Returns:

the UDDILocale defining the language used for the Address; null if no locale was specified

Since:

UDDI V3.0

setLocale

public void setLocale(UDDILocale locale)

Sets the locale defining the language used for the Address.

Parameters:

locale - The UDDILocale defining the language used for the Address.

Since:

UDDI V3.0

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Visits this Address.

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

Parameters:

visitor - The Visitor visiting this Address.

equals

public boolean equals(java.lang.Object o)

Checks whether an object is equal to this Address. Two Addresses are equal if they have represent the same address and are used for the same purpose. The sortCode attribute is not considered.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to test for equality.

Returns:

true if o and this AddressLine are equal; false otherwise