ca.uhn.hl7v2.model

Interface Structure

All Superinterfaces:

Serializable

All Known Subinterfaces:

Group, Message, Segment, SuperStructure

All Known Implementing Classes:

AbstractGroup, AbstractMessage, AbstractSegment, AbstractStructure, AbstractSuperMessage, GenericGroup, GenericMessage, GenericMessage.UnknownVersion, GenericMessage.V21, GenericMessage.V22, GenericMessage.V23, GenericMessage.V231, GenericMessage.V24, GenericMessage.V25, GenericMessage.V251, GenericMessage.V26, GenericSegment

public interface Structure
extends Serializable

Part of an HL7 message: either a segment or group. There are certain methods (e.g. Group.get()) that will always return either a segment or a group. This interface allows methods like this to declare a return type of Structure instead of Object.

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

Method Summary

Methods

Modifier and Type	Method and Description
Message	getMessage() Returns the Message object to which this structure belongs.
String	getName() Returns the structure's name.
Group	getParent() Returns the parent group within which this structure exists (may be root message group).
boolean	isEmpty()

Method Detail

getMessage

Message getMessage()

Returns the Message object to which this structure belongs. This should normally be set at construction time. A Structure can only belong to a single Message. This is primarily to avoid a situation where intended changes in one message cause unintended changes in another that shares one of the same Structure objects.

getName

String getName()

Returns the structure's name.

getParent

Group getParent()

Returns the parent group within which this structure exists (may be root message group).

isEmpty

boolean isEmpty()
                throws HL7Exception

Returns:

true if the structure is not populated

Throws:

HL7Exception