com.merge.HL7.v231.fields
Class HL7FieldAD

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.fields.HL7FieldAD

public class HL7FieldAD
extends HL7Field

This data type specifies the address of a person, place or organization.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldAD()
Creates an empty HL7 AD type field object.

Method Summary

java.lang.String	getAddressType() Gets the Address Type component of this field.
java.lang.String	getCity() Gets the City component of this field.
java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
java.lang.String	getCountry() Gets the Country component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getOtherDesignation() Gets the Other Designation component of this field.
java.lang.String	getOtherGeographicDesignation() Gets the Other Geographic Designation component of this field.
java.lang.String	getStateorProvince() Gets the State or Province component of this field.
java.lang.String	getStreetAddress() Gets the Street Address component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getZiporPostalCode() Gets the Zip or Postal Code component of this field.
boolean	isAddressTypeEmpty() Tells whether the Address Type component has been specified.
boolean	isAddressTypeNull() Tells whether the Address Type component has a has Null value as defined by HL7.
boolean	isCityEmpty() Tells whether the City component has been specified.
boolean	isCityNull() Tells whether the City component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isCountryEmpty() Tells whether the Country component has been specified.
boolean	isCountryNull() Tells whether the Country component has a has Null value as defined by HL7.
boolean	isOtherDesignationEmpty() Tells whether the Other Designation component has been specified.
boolean	isOtherDesignationNull() Tells whether the Other Designation component has a has Null value as defined by HL7.
boolean	isOtherGeographicDesignationEmpty() Tells whether the Other Geographic Designation component has been specified.
boolean	isOtherGeographicDesignationNull() Tells whether the Other Geographic Designation component has a has Null value as defined by HL7.
boolean	isStateorProvinceEmpty() Tells whether the State or Province component has been specified.
boolean	isStateorProvinceNull() Tells whether the State or Province component has a has Null value as defined by HL7.
boolean	isStreetAddressEmpty() Tells whether the Street Address component has been specified.
boolean	isStreetAddressNull() Tells whether the Street Address component has a has Null value as defined by HL7.
boolean	isZiporPostalCodeEmpty() Tells whether the Zip or Postal Code component has been specified.
boolean	isZiporPostalCodeNull() Tells whether the Zip or Postal Code component has a has Null value as defined by HL7.
void	setAddressType(java.lang.String val) Sets the Address Type from a string.
void	setCity(java.lang.String val) Sets the City from a string.
void	setCountry(java.lang.String val) Sets the Country from a string.
void	setOtherDesignation(java.lang.String val) Sets the Other Designation from a string.
void	setOtherGeographicDesignation(java.lang.String val) Sets the Other Geographic Designation from a string.
void	setStateorProvince(java.lang.String val) Sets the State or Province from a string.
void	setStreetAddress(java.lang.String val) Sets the Street Address from a string.
void	setZiporPostalCode(java.lang.String val) Sets the Zip or Postal Code from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldAD

public HL7FieldAD()

Creates an empty HL7 AD type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getStreetAddress

public java.lang.String getStreetAddress()

Gets the Street Address component of this field.

Returns:

the Street Address value

setStreetAddress

public void setStreetAddress(java.lang.String val)

Sets the Street Address from a string.

Parameters:

val - The value to set for Street Address

isStreetAddressEmpty

public boolean isStreetAddressEmpty()

Tells whether the Street Address component has been specified.

Returns:

true if the component is empty.

isStreetAddressNull

public boolean isStreetAddressNull()

Tells whether the Street Address component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getOtherDesignation

public java.lang.String getOtherDesignation()

Gets the Other Designation component of this field.

Returns:

the Other Designation value

setOtherDesignation

public void setOtherDesignation(java.lang.String val)

Sets the Other Designation from a string.

Parameters:

val - The value to set for Other Designation

isOtherDesignationEmpty

public boolean isOtherDesignationEmpty()

Tells whether the Other Designation component has been specified.

Returns:

true if the component is empty.

isOtherDesignationNull

public boolean isOtherDesignationNull()

Tells whether the Other Designation component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getCity

public java.lang.String getCity()

Gets the City component of this field.

Returns:

the City value

setCity

public void setCity(java.lang.String val)

Sets the City from a string.

Parameters:

val - The value to set for City

isCityEmpty

public boolean isCityEmpty()

Tells whether the City component has been specified.

Returns:

true if the component is empty.

isCityNull

public boolean isCityNull()

Tells whether the City component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getStateorProvince

public java.lang.String getStateorProvince()

Gets the State or Province component of this field.

Returns:

the State or Province value

setStateorProvince

public void setStateorProvince(java.lang.String val)

Sets the State or Province from a string.

Parameters:

val - The value to set for State or Province

isStateorProvinceEmpty

public boolean isStateorProvinceEmpty()

Tells whether the State or Province component has been specified.

Returns:

true if the component is empty.

isStateorProvinceNull

public boolean isStateorProvinceNull()

Tells whether the State or Province component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getZiporPostalCode

public java.lang.String getZiporPostalCode()

Gets the Zip or Postal Code component of this field.

Returns:

the Zip or Postal Code value

setZiporPostalCode

public void setZiporPostalCode(java.lang.String val)

Sets the Zip or Postal Code from a string.

Parameters:

val - The value to set for Zip or Postal Code

isZiporPostalCodeEmpty

public boolean isZiporPostalCodeEmpty()

Tells whether the Zip or Postal Code component has been specified.

Returns:

true if the component is empty.

isZiporPostalCodeNull

public boolean isZiporPostalCodeNull()

Tells whether the Zip or Postal Code component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getCountry

public java.lang.String getCountry()

Gets the Country component of this field.

Returns:

the Country value

setCountry

public void setCountry(java.lang.String val)

Sets the Country from a string.

Parameters:

val - The value to set for Country

isCountryEmpty

public boolean isCountryEmpty()

Tells whether the Country component has been specified.

Returns:

true if the component is empty.

isCountryNull

public boolean isCountryNull()

Tells whether the Country component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAddressType

public java.lang.String getAddressType()

Gets the Address Type component of this field.

Returns:

the Address Type value

setAddressType

public void setAddressType(java.lang.String val)

Sets the Address Type from a string.

Parameters:

val - The value to set for Address Type

isAddressTypeEmpty

public boolean isAddressTypeEmpty()

Tells whether the Address Type component has been specified.

Returns:

true if the component is empty.

isAddressTypeNull

public boolean isAddressTypeNull()

Tells whether the Address Type component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getOtherGeographicDesignation

public java.lang.String getOtherGeographicDesignation()

Gets the Other Geographic Designation component of this field.

Returns:

the Other Geographic Designation value

setOtherGeographicDesignation

public void setOtherGeographicDesignation(java.lang.String val)

Sets the Other Geographic Designation from a string.

Parameters:

val - The value to set for Other Geographic Designation

isOtherGeographicDesignationEmpty

public boolean isOtherGeographicDesignationEmpty()

Tells whether the Other Geographic Designation component has been specified.

Returns:

true if the component is empty.

isOtherGeographicDesignationNull

public boolean isOtherGeographicDesignationNull()

Tells whether the Other Geographic Designation component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.