ca.uhn.hl7v2.model

Interface Structure

All Superinterfaces:

Serializable, Visitable

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, GenericMessage.V27, GenericMessage.V271, GenericMessage.V28, GenericMessage.V281, GenericSegment

public interface Structure
extends Serializable, Visitable

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

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).

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

accept, isEmpty, provideLocation

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.

Returns:

message the root message this structure is part of

getName

String getName()

Returns the structure's name.

Returns:

name of this structure

getParent

Group getParent()

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

Returns:

parent group of this structure