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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class XAD
extends AbstractType
implements Composite

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

• street address (SAD) (SAD)
• other designation (ST)
• city (ST)
• state or province (ST)
• zip or postal code (ST)
• country (ID)
• address type (ID)
• other geographic designation (ST)
• county/parish code (IS)
• census tract (IS)
• address representation code (ID)
• address validity range (DR)

See Also:

Serialized Form

Constructor Summary

XAD(Message message)
Creates a new XAD type

Method Summary

ID	getAddressRepresentationCode() Returns address representation code (component #11).
ID	getAddressType() Returns address type (component #7).
DR	getAddressValidityRange() Returns address validity range (component #12).
IS	getCensusTract() Returns census tract (component #10).
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).
IS	getCountyParishCode() Returns county/parish code (component #9).
ST	getOtherDesignation() Returns other designation (component #2).
ST	getOtherGeographicDesignation() Returns other geographic designation (component #8).
ST	getStateOrProvince() Returns state or province (component #4).
SAD	getStreetAddress() Returns street address (SAD) (component #1).
SAD	getXad1_StreetAddress() Returns street address (SAD) (component #1).
IS	getXad10_CensusTract() Returns census tract (component #10).
ID	getXad11_AddressRepresentationCode() Returns address representation code (component #11).
DR	getXad12_AddressValidityRange() Returns address validity range (component #12).
ST	getXad2_OtherDesignation() Returns other designation (component #2).
ST	getXad3_City() Returns city (component #3).
ST	getXad4_StateOrProvince() Returns state or province (component #4).
ST	getXad5_ZipOrPostalCode() Returns zip or postal code (component #5).
ID	getXad6_Country() Returns country (component #6).
ID	getXad7_AddressType() Returns address type (component #7).
ST	getXad8_OtherGeographicDesignation() Returns other geographic designation (component #8).
IS	getXad9_CountyParishCode() Returns county/parish code (component #9).
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

XAD

public XAD(Message message)

Creates a new XAD 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 SAD getStreetAddress()

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

getXad1_StreetAddress

public SAD getXad1_StreetAddress()

Returns street address (SAD) (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.

getXad2_OtherDesignation

public ST getXad2_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.

getXad3_City

public ST getXad3_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.

getXad4_StateOrProvince

public ST getXad4_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.

getXad5_ZipOrPostalCode

public ST getXad5_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.

getXad6_Country

public ID getXad6_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.

getXad7_AddressType

public ID getXad7_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.

getXad8_OtherGeographicDesignation

public ST getXad8_OtherGeographicDesignation()

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

getCountyParishCode

public IS getCountyParishCode()

Returns county/parish code (component #9). This is a convenience method that saves you from casting and handling an exception.

getXad9_CountyParishCode

public IS getXad9_CountyParishCode()

Returns county/parish code (component #9). This is a convenience method that saves you from casting and handling an exception.

getCensusTract

public IS getCensusTract()

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

getXad10_CensusTract

public IS getXad10_CensusTract()

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

getAddressRepresentationCode

public ID getAddressRepresentationCode()

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

getXad11_AddressRepresentationCode

public ID getXad11_AddressRepresentationCode()

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

getAddressValidityRange

public DR getAddressValidityRange()

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

getXad12_AddressValidityRange

public DR getXad12_AddressValidityRange()

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