ca.uhn.hl7v2.model.v24.segment
Class RDF

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.RDF

All Implemented Interfaces:

Segment, Structure, Serializable

public class RDF
extends AbstractSegment

Represents an HL7 RDF message segment (Table Row Definition). This segment has the following fields:

• RDF-1: Number of Columns per Row (NM)
• RDF-2: Column Description (RCD) repeating

See Also:

Serialized Form

Constructor Summary

RDF(Group parent, ModelClassFactory factory)
Creates a new RDF segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
RCD[]	getColumnDescription() Returns all repetitions of Column Description (RDF-2).
RCD	getColumnDescription(int rep) Returns a specific repetition of RDF-2: "Column Description" - creates it if necessary
int	getColumnDescriptionReps() Returns a count of the current number of repetitions of Column Description (RDF-2).
NM	getNumberOfColumnsPerRow() Returns RDF-1: "Number of Columns per Row" - creates it if necessary
NM	getRdf1_NumberOfColumnsPerRow() Returns RDF-1: "Number of Columns per Row" - creates it if necessary
RCD	getRdf2_ColumnDescription(int rep) Returns a specific repetition of RDF-2: "Column Description" - creates it if necessary
int	getRdf2_ColumnDescriptionReps() Returns a count of the current number of repetitions of Column Description (RDF-2).
RCD	insertColumnDescription(int rep) Inserts a repetition of RDF-2: "Column Description" at a specific index
RCD	insertRdf2_ColumnDescription(int rep) Inserts a repetition of RDF-2: "Column Description" at a specific index
RCD	removeColumnDescription(int rep) Removes a repetition of RDF-2: "Column Description" at a specific index
RCD	removeRdf2_ColumnDescription(int rep) Removes a repetition of RDF-2: "Column Description" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

RDF

public RDF(Group parent,
           ModelClassFactory factory)

Creates a new RDF segment

Method Detail

getNumberOfColumnsPerRow

public NM getNumberOfColumnsPerRow()

Returns RDF-1: "Number of Columns per Row" - creates it if necessary

getRdf1_NumberOfColumnsPerRow

public NM getRdf1_NumberOfColumnsPerRow()

Returns RDF-1: "Number of Columns per Row" - creates it if necessary

getColumnDescription

public RCD[] getColumnDescription()

Returns all repetitions of Column Description (RDF-2).

getColumnDescriptionReps

public int getColumnDescriptionReps()

Returns a count of the current number of repetitions of Column Description (RDF-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getColumnDescription

public RCD getColumnDescription(int rep)

Returns a specific repetition of RDF-2: "Column Description" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRdf2_ColumnDescription

public RCD getRdf2_ColumnDescription(int rep)

Returns a specific repetition of RDF-2: "Column Description" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getRdf2_ColumnDescriptionReps

public int getRdf2_ColumnDescriptionReps()

Returns a count of the current number of repetitions of Column Description (RDF-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertColumnDescription

public RCD insertColumnDescription(int rep)
                            throws HL7Exception

Inserts a repetition of RDF-2: "Column Description" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertRdf2_ColumnDescription

public RCD insertRdf2_ColumnDescription(int rep)
                                 throws HL7Exception

Inserts a repetition of RDF-2: "Column Description" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeColumnDescription

public RCD removeColumnDescription(int rep)
                            throws HL7Exception

Removes a repetition of RDF-2: "Column Description" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeRdf2_ColumnDescription

public RCD removeRdf2_ColumnDescription(int rep)
                                 throws HL7Exception

Removes a repetition of RDF-2: "Column Description" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment