ca.uhn.hl7v2.model
Class AbstractSegment

java.lang.Object
  ca.uhn.hl7v2.model.AbstractStructure
      ca.uhn.hl7v2.model.AbstractSegment

All Implemented Interfaces:

Segment, Structure, Serializable

Direct Known Subclasses:

GenericSegment

public abstract class AbstractSegment
extends AbstractStructure
implements Segment

Provides common functionality needed by implementers of the Segment interface.

Implementing classes should define all the fields for the segment they represent in their constructor. The add() method is useful for this purpose.

For example the constructor for an MSA segment might contain the following code:
this.add(new ID(), true, 2, null);
this.add(new ST(), true, 20, null);
...

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

AbstractSegment(Group parent, ModelClassFactory factory)
Calls the abstract init() method to create the fields in this segment.

Method Summary

protected void	add(Class<? extends Type> c, boolean required, int maxReps, int length, Object[] constructorArgs) Deprecated. Use add(Class, boolean, int, int, Object[], String)
protected void	add(Class<? extends Type> c, boolean required, int maxReps, int length, Object[] constructorArgs, String name) Adds a field to the segment.
void	clear() Clears all data from this segment
protected Type	createNewTypeWithoutReflection(int field) Attempts to create an instance of a field type without using reflection.
String	encode() Encodes this message using the parser returned by Message.getParser()
Type[]	getField(int number) Returns an array of Field objects at the specified location in the segment.
Type	getField(int number, int rep) Returns a specific repetition of field at the specified index.
int	getLength(int number) Returns the maximum length of the field at the given index, in characters - fields are numbered from 1.
int	getMaxCardinality(int number) Returns the number of repetitions of this field that are allowed.
String	getName() Returns the class name (excluding package).
String[]	getNames() Returns the names of the fields in this segment.
protected int	getReps(int number)
protected <T extends Type> T	getTypedField(int number, int rep) Returns a specific repetition of field with concrete type at the specified index
protected <T extends Type> T[]	getTypedField(int number, T[] array) Returns an array of a specific type class
protected Type	insertRepetition(int fieldNum, int index) Inserts a repetition of a given Field into repetitions of that field by name.
boolean	isRequired(int number) Returns true if the given field is required in this segment - fields are numbered from 1.
static void	main(String[] args)
int	numFields() Returns the number of fields defined by this segment (repeating fields are not counted multiple times).
void	parse(String string) Parses the string into this segment using the parser returned by Message.getParser()
protected Type	removeRepetition(int fieldNum, int index) Removes a repetition of a given field by name.

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

AbstractSegment

public AbstractSegment(Group parent,
                       ModelClassFactory factory)

Calls the abstract init() method to create the fields in this segment.

Parameters:

parent - parent group

factory - all implementors need a model class factory to find datatype classes, so we include it as an arg here to emphasize that fact ... AbstractSegment doesn't actually use it though

Method Detail

getField

public Type[] getField(int number)
                throws HL7Exception

Returns an array of Field objects at the specified location in the segment. In the case of non-repeating fields the array will be of length one. Fields are numbered from 1.

Specified by:

getField in interface Segment

Throws:

HL7Exception - if field index is out of range.

getTypedField

protected <T extends Type> T[] getTypedField(int number,
                                             T[] array)

Returns an array of a specific type class

getReps

protected int getReps(int number)

getField

public Type getField(int number,
                     int rep)
              throws HL7Exception

Returns a specific repetition of field at the specified index. If there exist fewer repetitions than are required, the number of repetitions can be increased by specifying the lowest repetition that does not yet exist. For example if there are two repetitions but three are needed, the third can be created and accessed using the following code:
Type t = getField(x, 3);

Specified by:

getField in interface Segment

Parameters:

number - the field number (starting at 1)

rep - the repetition number (starting at 0)

Throws:

HL7Exception - if field index is out of range, if the specified repetition is greater than the maximum allowed, or if the specified repetition is more than 1 greater than the existing # of repetitions.

getTypedField

protected <T extends Type> T getTypedField(int number,
                                           int rep)

Returns a specific repetition of field with concrete type at the specified index

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Attempts to create an instance of a field type without using reflection.

Note that the default implementation just returns null, and it is not neccesary to override this method to provide any particular behaviour. When a new field instance is needed within a segment, this method is tried first, and if it returns null, reflection is used instead. Implementations of this method is auto-generated by the source generator module.

Parameters:

field - Field number - Note that this is zero indexed!

Returns:

Returns a newly instantiated type, or null if not possible

isRequired

public boolean isRequired(int number)
                   throws HL7Exception

Returns true if the given field is required in this segment - fields are numbered from 1.

Specified by:

isRequired in interface Segment

Throws:

HL7Exception - if field index is out of range.

getLength

public int getLength(int number)
              throws HL7Exception

Returns the maximum length of the field at the given index, in characters - fields are numbered from 1.

Specified by:

getLength in interface Segment

Throws:

HL7Exception - if field index is out of range.

getMaxCardinality

public int getMaxCardinality(int number)
                      throws HL7Exception

Returns the number of repetitions of this field that are allowed.

Specified by:

getMaxCardinality in interface Segment

Throws:

HL7Exception - if field index is out of range.

add

protected void add(Class<? extends Type> c,
                   boolean required,
                   int maxReps,
                   int length,
                   Object[] constructorArgs)
            throws HL7Exception

Deprecated. Use add(Class, boolean, int, int, Object[], String)

Throws:

HL7Exception

add

protected void add(Class<? extends Type> c,
                   boolean required,
                   int maxReps,
                   int length,
                   Object[] constructorArgs,
                   String name)
            throws HL7Exception

Adds a field to the segment. The field is initially empty (zero repetitions). The field number is sequential depending on previous add() calls. Implementing classes should use the add() method in their constructor in order to define fields in their segment.

Parameters:

c - the class of the data for this field - this should inherit from Type

required - whether a value for this field is required in order for the segment to be valid

maxReps - the maximum number of repetitions - 0 implies that there is no limit

length - the maximum length of each repetition of the field (in characters)

constructorArgs - an array of objects that will be used as constructor arguments if new instances of this class are created (use null for zero-arg constructor)

name - the name of the field

Throws:

HL7Exception - if the given class does not inherit from Type or if it can not be instantiated.

main

public static void main(String[] args)

numFields

public int numFields()

Returns the number of fields defined by this segment (repeating fields are not counted multiple times).

Specified by:

numFields in interface Segment

getName

public String getName()

Returns the class name (excluding package).

Specified by:

getName in interface Structure

See Also:

Structure.getName()

getNames

public String[] getNames()

Returns the names of the fields in this segment.

Specified by:

getNames in interface Segment

parse

public void parse(String string)
           throws HL7Exception

Parses the string into this segment using the parser returned by Message.getParser()

Note that this method will not currently work to parse an MSH segment if the encoding characters are not already set. This limitation should be resolved in a future version

Specified by:

parse in interface Segment

Throws:

HL7Exception

encode

public String encode()
              throws HL7Exception

Encodes this message using the parser returned by Message.getParser()

Specified by:

encode in interface Segment

Throws:

HL7Exception

removeRepetition

protected Type removeRepetition(int fieldNum,
                                int index)
                         throws HL7Exception

Removes a repetition of a given field by name. For example, if a PID segment contains 10 repititions a "Patient Identifier List" field and "Patient Identifier List" is supplied with an index of 2, then this call would remove the 3rd repetition.

Returns:

The removed structure

Throws:

HL7Exception - if the named Structure is not part of this Group.

insertRepetition

protected Type insertRepetition(int fieldNum,
                                int index)
                         throws HL7Exception

Inserts a repetition of a given Field into repetitions of that field by name.

Returns:

The newly created and inserted field

Throws:

HL7Exception - if the named Structure is not part of this Group.

clear

public void clear()

Clears all data from this segment