ca.uhn.hl7v2.model.v25.datatype

Class SN

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v25.datatype.SN

All Implemented Interfaces:

Composite, Type, Serializable

public class SN
extends AbstractComposite

Represents an HL7 SN (Structured Numeric) data type. This type consists of the following components:

• Comparator (ST)
• Num1 (NM)
• Separator/Suffix (ST)
• Num2 (NM)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ST	getComparator() Returns Comparator (component 1).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
NM	getNum1() Returns Num1 (component 2).
NM	getNum2() Returns Num2 (component 4).
ST	getSeparatorSuffix() Returns Separator/Suffix (component 3).
ST	getSn1_Comparator() Returns Comparator (component 1).
NM	getSn2_Num1() Returns Num1 (component 2).
ST	getSn3_SeparatorSuffix() Returns Separator/Suffix (component 3).
NM	getSn4_Num2() Returns Num2 (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

SN

public SN(Message message)

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

getComparator

public ST getComparator()

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

getSn1_Comparator

public ST getSn1_Comparator()

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

getNum1

public NM getNum1()

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

getSn2_Num1

public NM getSn2_Num1()

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

getSeparatorSuffix

public ST getSeparatorSuffix()

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

getSn3_SeparatorSuffix

public ST getSn3_SeparatorSuffix()

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

getNum2

public NM getNum2()

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

getSn4_Num2

public NM getSn4_Num2()

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