ca.uhn.hl7v2.parser

Class Pointer

java.lang.Object

ca.uhn.hl7v2.parser.Pointer

Direct Known Subclasses:

GroupPointer, SegmentPointer

Deprecated.

public abstract class Pointer
extends Object

A Pointer is a placeholder used in parsing traditionally encoded messages (which do not explicitly identify segment groups). Implementations of Pointer include SegmentPointer, which "points" to a Segment slot. This pointer can exist whether or not the underlying Segment object has been created. There is only one pointer per slot - multiple repetitions are accessed through the same pointer. prepNewInstance is used to create a new rep. setSegment(String segment) is responsible for parsing the given segment string into the current rep of the underlying Segment. Similarly there is a subclass called GroupPointer that points to a Group slot. GroupPointer's setSegment(...) method just forwards the request to it's children (which are GroupPointers and SegmentPointers).

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected EncodingCharacters	encodingChars Deprecated.
static int	FILL_FAILED_FULL Deprecated.
static int	FILL_FAILED_OUT_OF_ORDER Deprecated.
static int	FILL_FAILED_WRONG_SEGMENT Deprecated.
static int	FILL_OK Deprecated.
protected Group	parent Deprecated.
protected int	position Deprecated.
protected boolean	repeating Deprecated.

Constructor Summary

Constructors

Constructor and Description
Pointer() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	setSegment(String segment, boolean correctOrder) Deprecated. Parses the given String, which must contain a single traditionally encoded message segment, into the current repetition of the message Structure underlying this Pointer.

Methods inherited from class java.lang.Object

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

Field Detail

FILL_FAILED_WRONG_SEGMENT

public static final int FILL_FAILED_WRONG_SEGMENT

Deprecated.

See Also:

Constant Field Values

FILL_FAILED_FULL

public static final int FILL_FAILED_FULL

Deprecated.

See Also:

Constant Field Values

FILL_OK

public static final int FILL_OK

Deprecated.

See Also:

Constant Field Values

FILL_FAILED_OUT_OF_ORDER

public static final int FILL_FAILED_OUT_OF_ORDER

Deprecated.

See Also:

Constant Field Values

parent

protected Group parent

Deprecated.

position

protected int position

Deprecated.

repeating

protected boolean repeating

Deprecated.

encodingChars

protected EncodingCharacters encodingChars

Deprecated.

Constructor Detail

Pointer

public Pointer()

Deprecated.

Method Detail

setSegment

public abstract int setSegment(String segment,
             boolean correctOrder)
                        throws HL7Exception

Deprecated.

Parses the given String, which must contain a single traditionally encoded message segment, into the current repetition of the message Structure underlying this Pointer.

Parameters:

segment - the segment to parse

correctOrder - 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