ca.uhn.hl7v2.model.v21.datatype

Class CN

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v21.datatype.CN

All Implemented Interfaces:

Composite, Type, Serializable

public class CN
extends AbstractComposite

Represents an HL7 CN (composite ID number and name) data type. This type consists of the following components:

• ID (ST)
• family name (ST)
• given name (ST)
• middle initial or name (ST)
• degree (ST)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ST	getCn1_ID() Returns ID (component 1).
ST	getCn2_FamilyName() Returns family name (component 2).
ST	getCn3_GivenName() Returns given name (component 3).
ST	getCn4_MiddleInitialOrName() Returns middle initial or name (component 4).
ST	getCn5_Degree() Returns degree (component 5).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getDegree() Returns degree (component 5).
ST	getFamilyName() Returns family name (component 2).
ST	getGivenName() Returns given name (component 3).
ST	getID() Returns ID (component 1).
ST	getMiddleInitialOrName() Returns middle initial or name (component 4).

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

CN

public CN(Message message)

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

getID

public ST getID()

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

getCn1_ID

public ST getCn1_ID()

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

getFamilyName

public ST getFamilyName()

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

getCn2_FamilyName

public ST getCn2_FamilyName()

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

getGivenName

public ST getGivenName()

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

getCn3_GivenName

public ST getCn3_GivenName()

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

getMiddleInitialOrName

public ST getMiddleInitialOrName()

Returns middle initial or name (component 4). This is a convenience method that saves you from casting and handling an exception.

getCn4_MiddleInitialOrName

public ST getCn4_MiddleInitialOrName()

Returns middle initial or name (component 4). This is a convenience method that saves you from casting and handling an exception.

getDegree

public ST getDegree()

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

getCn5_Degree

public ST getCn5_Degree()

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