ca.uhn.hl7v2.model.v21.datatype

Class AD

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v21.datatype.AD

All Implemented Interfaces:

Composite, Type, Serializable

public class AD
extends AbstractComposite

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

• street address (ST)
• other designation (ST)
• city (ST)
• state or province (ST)
• zip (ST)
• country (ST)

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractComposite

log

Constructor Summary

Constructors

Constructor and Description
AD(Message message) Creates a new AD type

Method Summary

Methods

Modifier and Type	Method and Description
ST	getAd1_StreetAddress() Returns street address (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_Zip() Returns zip (component 5).
ST	getAd6_Country() Returns country (component 6).
ST	getCity() Returns city (component 3).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getCountry() Returns country (component 6).
ST	getOtherDesignation() Returns other designation (component 2).
ST	getStateOrProvince() Returns state or province (component 4).
ST	getStreetAddress() Returns street address (component 1).
ST	getZip() Returns zip (component 5).

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

clear, getTyped, isEmpty

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

encode, getExtraComponents, getMessage, getName, parse, toString

Methods inherited from class java.lang.Object

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

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

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.

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

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

getZip

public ST getZip()

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

getAd5_Zip

public ST getAd5_Zip()

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

getCountry

public ST getCountry()

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

getAd6_Country

public ST getAd6_Country()

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