ca.uhn.hl7v2.model.v231.datatype

Class FN

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v231.datatype.FN

All Implemented Interfaces:

Composite, Type, Serializable

public class FN
extends AbstractComposite

Represents an HL7 FN (family + last name prefix) data type. This type consists of the following components:

• family name (ST)
• last name prefix (ST)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getFamilyName() Returns family name (component 1).
ST	getFn1_FamilyName() Returns family name (component 1).
ST	getFn2_LastNamePrefix() Returns last name prefix (component 2).
ST	getLastNamePrefix() Returns last name prefix (component 2).

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

clear, getTyped

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

FN

public FN(Message message)

Creates a new FN 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.

getFamilyName

public ST getFamilyName()

Returns family name (component 1). This is a convenience method that saves you from casting and handling an exception.

getFn1_FamilyName

public ST getFn1_FamilyName()

Returns family name (component 1). This is a convenience method that saves you from casting and handling an exception.

getLastNamePrefix

public ST getLastNamePrefix()

Returns last name prefix (component 2). This is a convenience method that saves you from casting and handling an exception.

getFn2_LastNamePrefix

public ST getFn2_LastNamePrefix()

Returns last name prefix (component 2). This is a convenience method that saves you from casting and handling an exception.