ca.uhn.hl7v2.model

Interface Composite

All Superinterfaces:

Serializable, Type, Visitable

All Known Implementing Classes:

AbstractComposite, AbstractPersonNameComposite, CM, GenericComposite

public interface Composite
extends Type

Represents the category of HL7 data types that contain more than one component (e.g. CE). Implementing classes (i.e. composite data types) should initialize their components either when they are initialized or when they are first accessed. Only leaf values (values of primitives) should ever be returned as null.

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

Method Summary

Modifier and Type	Method and Description
Type	getComponent(int number) Returns the single component of this composite at the specified position (starting at 0).
Type[]	getComponents() Returns an array containing the components of this field.

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

clear, encode, getExtraComponents, getMessage, getName, parse

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

accept, isEmpty, provideLocation

Method Detail

getComponents

Type[] getComponents()

Returns an array containing the components of this field.

Returns:

array of components of this composite type

getComponent

Type getComponent(int number)
           throws DataTypeException

Returns the single component of this composite at the specified position (starting at 0).

Parameters:

number - index of the component to be retrieved (zero-based)

Returns:

component at this index

Throws:

DataTypeException