org.vmdb.hl7
Class RepeatElement

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Element
              |
              +--org.vmdb.hl7.RepeatElement

public class RepeatElement

extends HL7Element

Repeat Element.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

This class is an invisible element who's sole purpose is to provide a container for zero or more elements in a repeat. It handles the details of outputting the correct delimiters in HL7 and XML tags in XML representation.

Constructor Summary

RepeatElement()
Construct a Composite ID Element using the default name and type constants.

Method Summary

void	addElement(HL7Element hlE) Add an element to the end of the repeat.
void	clear() Return this element to its empty state.
HL7Element	firstElement() Get the first element of the repeat.
java.lang.String	getValue() Get the value of the first element of the repeat.
java.util.Iterator	iterator() Get an Iterator over all of the repeats.
int	size() Count the number of elements in the repeat.
java.lang.String	toHL7String() Extend the inherited toHL7String() method to properly delimit repeating fields.
java.lang.String	toString() Extend the inherited toString() method to properly delimit repeating fields.
java.lang.String	toXML(int iDepth) Extend the inherited toXML() method to properly format repeating fields.

Methods inherited from class org.vmdb.hl7.HL7Element

empty, getComponent, getLevel, getType, initialize, makeElement, setComponent, setLevel, setType, setValue

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RepeatElement

public RepeatElement()

Construct a Composite ID Element using the default name and type constants.

The only level repeats occur is Field (is this correct?) so this always sets level to FIELD. The name and type are dependent on the contained field(s) which are by definition all the same type.

Method Detail

iterator

public java.util.Iterator iterator()

Get an Iterator over all of the repeats.

Overrides:

iterator in class HL7Element

Returns:

Iterator over HL7Element derived objects or null if no values have been assigned.

size

public int size()

Count the number of elements in the repeat.

Overrides:

size in class HL7Element

Returns:

integer number of elements.

clear

public void clear()

Return this element to its empty state. In this case removing all repeating fields if any.

Overrides:

clear in class HL7Element

addElement

public void addElement(HL7Element hlE)

Add an element to the end of the repeat.

Sets the name and type of the added element based on the name and type assigned to this repeat via its inherited setName() and setType() methods.

Parameters:

hlE - HL7Element derived Element object to add.

firstElement

public HL7Element firstElement()

Get the first element of the repeat.

This is a convenience method useful because we sometimes just want one value and don't care if we ignore later repeating values.

Returns:

HL7Element derived object.

getValue

public java.lang.String getValue()

Get the value of the first element of the repeat.

This is a convenience method useful because we sometimes just want one value and don't care if we ignore later repeating values.

Overrides:

getValue in class HL7Element

Returns:

HL7Element derived object.

toString

public java.lang.String toString()

Extend the inherited toString() method to properly delimit repeating fields.

Overrides:

toString in class HL7Element

Returns:

String formatted as delimited HL7 for this field.

toHL7String

public java.lang.String toHL7String()

Extend the inherited toHL7String() method to properly delimit repeating fields.

Overrides:

toHL7String in class HL7Element

Returns:

String formatted as delimited HL7 for this field.

toXML

public java.lang.String toXML(int iDepth)

Extend the inherited toXML() method to properly format repeating fields.

Overrides:

toXML in class HL7Element

Parameters:

iDepth - int to determine depth to indent XML for readability.

Returns:

String formatted XML