ca.uhn.hl7v2.model.v24.datatype
Class AD

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.AD

All Implemented Interfaces:

Composite, Type, Serializable

public class AD
extends AbstractType
implements Composite

Represents an HL7 AD (address) data type. This type consists of the following components:

• street address (ST) (ST)
• other designation (ST)
• city (ST)
• state or province (ST)
• zip or postal code (ST)
• country (ID)
• address type (ID)
• other geographic designation (ST)

See Also:

Serialized Form

Constructor Summary

AD(Message message)
Creates a new AD type

Method Summary

ST	getAd1_StreetAddress() Returns street address (ST) (component #1).
ST	getAd2_OtherDesignation() Returns other designation (component #2).
ST	getAd3_City() Returns city (component #3).
ST	getAd4_StateOrProvince() Returns state or province (component #4).
ST	getAd5_ZipOrPostalCode() Returns zip or postal code (component #5).
ID	getAd6_Country() Returns country (component #6).
ID	getAd7_AddressType() Returns address type (component #7).
ST	getAd8_OtherGeographicDesignation() Returns other geographic designation (component #8).
ID	getAddressType() Returns address type (component #7).
ST	getCity() Returns city (component #3).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ID	getCountry() Returns country (component #6).
ST	getOtherDesignation() Returns other designation (component #2).
ST	getOtherGeographicDesignation() Returns other geographic designation (component #8).
ST	getStateOrProvince() Returns state or province (component #4).
ST	getStreetAddress() Returns street address (ST) (component #1).
ST	getZipOrPostalCode() Returns zip or postal code (component #5).

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

AD

public AD(Message message)

Creates a new AD type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getStreetAddress

public ST getStreetAddress()

Returns street address (ST) (component #1). This is a convenience method that saves you from casting and handling an exception.

getAd1_StreetAddress

public ST getAd1_StreetAddress()

Returns street address (ST) (component #1). This is a convenience method that saves you from casting and handling an exception.

getOtherDesignation

public ST getOtherDesignation()

Returns other designation (component #2). This is a convenience method that saves you from casting and handling an exception.

getAd2_OtherDesignation

public ST getAd2_OtherDesignation()

Returns other designation (component #2). This is a convenience method that saves you from casting and handling an exception.

getCity

public ST getCity()

Returns city (component #3). This is a convenience method that saves you from casting and handling an exception.

getAd3_City

public ST getAd3_City()

Returns city (component #3). This is a convenience method that saves you from casting and handling an exception.

getStateOrProvince

public ST getStateOrProvince()

Returns state or province (component #4). This is a convenience method that saves you from casting and handling an exception.

getAd4_StateOrProvince

public ST getAd4_StateOrProvince()

Returns state or province (component #4). This is a convenience method that saves you from casting and handling an exception.

getZipOrPostalCode

public ST getZipOrPostalCode()

Returns zip or postal code (component #5). This is a convenience method that saves you from casting and handling an exception.

getAd5_ZipOrPostalCode

public ST getAd5_ZipOrPostalCode()

Returns zip or postal code (component #5). This is a convenience method that saves you from casting and handling an exception.

getCountry

public ID getCountry()

Returns country (component #6). This is a convenience method that saves you from casting and handling an exception.

getAd6_Country

public ID getAd6_Country()

Returns country (component #6). This is a convenience method that saves you from casting and handling an exception.

getAddressType

public ID getAddressType()

Returns address type (component #7). This is a convenience method that saves you from casting and handling an exception.

getAd7_AddressType

public ID getAd7_AddressType()

Returns address type (component #7). This is a convenience method that saves you from casting and handling an exception.

getOtherGeographicDesignation

public ST getOtherGeographicDesignation()

Returns other geographic designation (component #8). This is a convenience method that saves you from casting and handling an exception.

getAd8_OtherGeographicDesignation

public ST getAd8_OtherGeographicDesignation()

Returns other geographic designation (component #8). This is a convenience method that saves you from casting and handling an exception.