|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectca.uhn.hl7v2.model.AbstractSegment
public abstract class AbstractSegment
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);
...
Constructor Summary | |
---|---|
AbstractSegment(Group parent,
ModelClassFactory factory)
Calls the abstract init() method to create the fields in this segment. |
Method Summary | |
---|---|
protected void |
add(java.lang.Class<? extends Type> c,
boolean required,
int maxReps,
int length,
java.lang.Object[] constructorArgs)
Deprecated. Use add(Class, boolean, int, int, Object[], String) |
protected void |
add(java.lang.Class<? extends Type> c,
boolean required,
int maxReps,
int length,
java.lang.Object[] constructorArgs,
java.lang.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. |
java.lang.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. |
Message |
getMessage()
Returns the Message to which this segment belongs. |
java.lang.String |
getName()
Returns the class name (excluding package). |
java.lang.String[] |
getNames()
Returns the names of the fields in this segment. |
Group |
getParent()
Returns the parent group within which this structure exists (may be root message group). |
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(java.lang.String[] args)
|
int |
numFields()
Returns the number of fields defined by this segment (repeating fields are not counted multiple times). |
void |
parse(java.lang.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractSegment(Group parent, ModelClassFactory factory)
parent
- parent groupfactory
- 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 thoughMethod Detail |
---|
public Type[] getField(int number) throws HL7Exception
getField
in interface Segment
HL7Exception
- if field index is out of range.public Type getField(int number, int rep) throws HL7Exception
Type t = getField(x, 3);
getField
in interface Segment
number
- the field number (starting at 1)rep
- the repetition number (starting at 0)
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.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.
field
- Field number - Note that this is zero indexed!
null
if not possiblepublic boolean isRequired(int number) throws HL7Exception
isRequired
in interface Segment
HL7Exception
- if field index is out of range.public int getLength(int number) throws HL7Exception
getLength
in interface Segment
HL7Exception
- if field index is out of range.public int getMaxCardinality(int number) throws HL7Exception
getMaxCardinality
in interface Segment
HL7Exception
- if field index is out of range.public Message getMessage()
getMessage
in interface Structure
public Group getParent()
Structure
getParent
in interface Structure
protected void add(java.lang.Class<? extends Type> c, boolean required, int maxReps, int length, java.lang.Object[] constructorArgs) throws HL7Exception
add(Class, boolean, int, int, Object[], String)
HL7Exception
protected void add(java.lang.Class<? extends Type> c, boolean required, int maxReps, int length, java.lang.Object[] constructorArgs, java.lang.String name) throws HL7Exception
c
- the class of the data for this field - this should inherit from Typerequired
- whether a value for this field is required in order for the segment
to be validmaxReps
- the maximum number of repetitions - 0 implies that there is no limitlength
- 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
HL7Exception
- if the given class does not inherit from Type or if it can
not be instantiated.public static void main(java.lang.String[] args)
public int numFields()
numFields
in interface Segment
public java.lang.String getName()
getName
in interface Structure
Structure.getName()
public java.lang.String[] getNames()
getNames
in interface Segment
public void parse(java.lang.String string) throws HL7Exception
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 resulved in a future version
parse
in interface Segment
HL7Exception
public java.lang.String encode() throws HL7Exception
Message.getParser()
encode
in interface Segment
HL7Exception
protected Type removeRepetition(int fieldNum, int index) throws HL7Exception
HL7Exception
- if the named Structure is not part of this Group.protected Type insertRepetition(int fieldNum, int index) throws HL7Exception
HL7Exception
- if the named Structure is not part of this Group.public void clear()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |