ca.uhn.hl7v2.model.v25.group

Class RTB_K13_ROW_DEFINITION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.RTB_K13_ROW_DEFINITION

All Implemented Interfaces:

Group, Structure, Serializable

public class RTB_K13_ROW_DEFINITION
extends AbstractGroup

Represents a RTB_K13_ROW_DEFINITION group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: RDF (Table Row Definition)
• 2: RDT (Table Row Data) optional repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
RTB_K13_ROW_DEFINITION(Group parent, ModelClassFactory factory) Creates a new RTB_K13_ROW_DEFINITION group

Method Summary

Methods

Modifier and Type	Method and Description
RDF	getRDF() Returns RDF (Table Row Definition) - creates it if necessary
RDT	getRDT() Returns the first repetition of RDT (Table Row Data) - creates it if necessary
RDT	getRDT(int rep) Returns a specific repetition of RDT (Table Row Data) - creates it if necessary
List<RDT>	getRDTAll() Returns a non-modifiable List containing all current existing repetitions of RDT.
int	getRDTReps() Returns the number of existing repetitions of RDT
String	getVersion() Returns "2.5"
RDT	insertRDT(int rep) Inserts a specific repetition of RDT (Table Row Data)
void	insertRDT(RDT structure, int rep) Inserts a specific repetition of RDT (Table Row Data)
RDT	removeRDT(int rep) Removes a specific repetition of RDT (Table Row Data)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

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

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

getMessage, getParent

Constructor Detail

RTB_K13_ROW_DEFINITION

public RTB_K13_ROW_DEFINITION(Group parent,
                      ModelClassFactory factory)

Creates a new RTB_K13_ROW_DEFINITION group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getRDF

public RDF getRDF()

Returns RDF (Table Row Definition) - creates it if necessary

getRDT

public RDT getRDT()

Returns the first repetition of RDT (Table Row Data) - creates it if necessary

getRDT

public RDT getRDT(int rep)

Returns a specific repetition of RDT (Table Row Data) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getRDTReps

public int getRDTReps()

Returns the number of existing repetitions of RDT

getRDTAll

public List<RDT> getRDTAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of RDT.

Note that unlike getRDT(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertRDT

public void insertRDT(RDT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRDT

public RDT insertRDT(int rep)
              throws HL7Exception

Inserts a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRDT

public RDT removeRDT(int rep)
              throws HL7Exception

Removes a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)