Package ca.uhn.hl7v2.model.v251.datatype

Class RP

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.RP

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class RP
extends AbstractComposite

Represents an HL7 RP (Reference Pointer) data type. This type consists of the following components:

• Pointer (ST)
• Application ID (HD)
• Type of Data (ID)
• Subtype (ID)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RP(Message message)	Creates a new RP type

Method Summary

Modifier and Type	Method	Description
HD	getApplicationID()	Returns Application ID (component 2).
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
ST	getPointer()	Returns Pointer (component 1).
ST	getRp1_Pointer()	Returns Pointer (component 1).
HD	getRp2_ApplicationID()	Returns Application ID (component 2).
ID	getRp3_TypeOfData()	Returns Type of Data (component 3).
ID	getRp4_Subtype()	Returns Subtype (component 4).
ID	getSubtype()	Returns Subtype (component 4).
ID	getTypeOfData()	Returns Type of Data (component 3).

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

accept, clear, getTyped, isEmpty, provideLocation

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 Details

RP

public RP(Message message)

Creates a new RP type

Method Details

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.

getPointer

public ST getPointer()

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

getRp1_Pointer

public ST getRp1_Pointer()

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

getApplicationID

public HD getApplicationID()

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

getRp2_ApplicationID

public HD getRp2_ApplicationID()

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

getTypeOfData

public ID getTypeOfData()

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

getRp3_TypeOfData

public ID getRp3_TypeOfData()

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

getSubtype

public ID getSubtype()

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

getRp4_Subtype

public ID getRp4_Subtype()

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