ca.uhn.hl7v2.model.v24.datatype
Class CF

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.CF

All Implemented Interfaces:

Composite, Type, Serializable

public class CF
extends AbstractType
implements Composite

Represents an HL7 CF (coded element with formatted values) data type. This type consists of the following components:

• identifier (ID) (ID)
• formatted text (FT)
• name of coding system (IS)
• alternate identifier (ID) (ID)
• alternate formatted text (FT)
• name of alternate coding system (IS)

See Also:

Serialized Form

Constructor Summary

CF(Message message)
Creates a new CF type

Method Summary

FT	getAlternateFormattedText() Returns alternate formatted text (component #5).
ID	getAlternateIdentifier() Returns alternate identifier (ID) (component #4).
ID	getCf1_Identifier() Returns identifier (ID) (component #1).
FT	getCf2_FormattedText() Returns formatted text (component #2).
IS	getCf3_NameOfCodingSystem() Returns name of coding system (component #3).
ID	getCf4_AlternateIdentifier() Returns alternate identifier (ID) (component #4).
FT	getCf5_AlternateFormattedText() Returns alternate formatted text (component #5).
IS	getCf6_NameOfAlternateCodingSystem() Returns name of alternate coding system (component #6).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
FT	getFormattedText() Returns formatted text (component #2).
ID	getIdentifier() Returns identifier (ID) (component #1).
IS	getNameOfAlternateCodingSystem() Returns name of alternate coding system (component #6).
IS	getNameOfCodingSystem() Returns name of coding system (component #3).

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

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

CF

public CF(Message message)

Creates a new CF type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getIdentifier

public ID getIdentifier()

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

getCf1_Identifier

public ID getCf1_Identifier()

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

getFormattedText

public FT getFormattedText()

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

getCf2_FormattedText

public FT getCf2_FormattedText()

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

getNameOfCodingSystem

public IS getNameOfCodingSystem()

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

getCf3_NameOfCodingSystem

public IS getCf3_NameOfCodingSystem()

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

getAlternateIdentifier

public ID getAlternateIdentifier()

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

getCf4_AlternateIdentifier

public ID getCf4_AlternateIdentifier()

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

getAlternateFormattedText

public FT getAlternateFormattedText()

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

getCf5_AlternateFormattedText

public FT getCf5_AlternateFormattedText()

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

getNameOfAlternateCodingSystem

public IS getNameOfAlternateCodingSystem()

Returns name of alternate coding system (component #6). This is a convenience method that saves you from casting and handling an exception.

getCf6_NameOfAlternateCodingSystem

public IS getCf6_NameOfAlternateCodingSystem()

Returns name of alternate coding system (component #6). This is a convenience method that saves you from casting and handling an exception.