ca.uhn.hl7v2.parser

Class GroupPointer

java.lang.Object

ca.uhn.hl7v2.parser.Pointer

ca.uhn.hl7v2.parser.GroupPointer

Deprecated.

MessageIterator is now used

public class GroupPointer
extends Pointer

A GroupPointer is used when parsing traditionally encoded HL7 messages. It acts as a placeholder for a unique group "slot" in a message structure. There is one GroupPointer per unique Group path (even if the group repeats, and regardless of whether any instances exist).

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

Field Summary

Fields inherited from class ca.uhn.hl7v2.parser.Pointer

FILL_FAILED_FULL, FILL_FAILED_OUT_OF_ORDER, FILL_FAILED_WRONG_SEGMENT, FILL_OK, position

Constructor Summary

Constructors

Constructor and Description
GroupPointer(PipeParser parser, Group parent, int position, EncodingCharacters encodingChars) Deprecated. Creates new GroupPointer

Method Summary

Methods

Modifier and Type	Method and Description
int	setSegment(String segment, boolean orderedCorrectly) Deprecated. Parses the given String, which must contain a single traditionally encoded message segment, into the current repetition of the message Group underlying this Pointer by forwarding it to each of it's children until one of them succeeds.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupPointer

public GroupPointer(PipeParser parser,
            Group parent,
            int position,
            EncodingCharacters encodingChars)
             throws HL7Exception

Deprecated.

Creates new GroupPointer

Throws:

HL7Exception

Method Detail

setSegment

public int setSegment(String segment,
             boolean orderedCorrectly)
               throws HL7Exception

Deprecated.

Parses the given String, which must contain a single traditionally encoded message segment, into the current repetition of the message Group underlying this Pointer by forwarding it to each of it's children until one of them succeeds.

Specified by:

setSegment in class Pointer

Parameters:

segment - the segment to parse

orderedCorrectly - false if this segment should not actually be parsed because the current location precedes the location of a segment that has already been parsed. In this case, the return value should be either FILL_FAILED_FULL, FILL_FAILED_WRONG_SEGMENT, or FILL_FAILED_OUT_OF_ORDER, but the segment should not be parsed.

Returns:

an int indicating the success or flavours of failure of the request

Throws:

HL7Exception