|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Group
An abstraction representing >1 message parts which may repeated together. An implementation of Group should enforce contraints about on the contents of the group and throw an exception if an attempt is made to add a Structure that the Group instance does not recognize.
Method Summary | |
---|---|
java.lang.String |
addNonstandardSegment(java.lang.String name)
Expands the group definition to include a segment that is not defined by HL7 to be part of this group (eg an unregistered Z segment). |
java.lang.String |
addNonstandardSegment(java.lang.String name,
int theIndex)
Expands the group definition to include a segment that is not defined by HL7 to be part of this group (eg an unregistered Z segment). |
Structure |
get(java.lang.String name)
Returns the named structure. |
Structure |
get(java.lang.String name,
int rep)
Returns a particular repetition of the named Structure. |
Structure[] |
getAll(java.lang.String name)
Returns an array of Structure objects by name. |
java.lang.Class |
getClass(java.lang.String name)
Returns the Class of the Structure at the given name index. |
java.lang.String[] |
getNames()
Returns an ordered array of the names of the Structures in this Group. |
boolean |
isRepeating(java.lang.String name)
Returns true if the named structure is repeating. |
boolean |
isRequired(java.lang.String name)
Returns true if the named structure is required. |
Methods inherited from interface ca.uhn.hl7v2.model.Structure |
---|
getMessage, getName, getParent |
Method Detail |
---|
Structure[] getAll(java.lang.String name) throws HL7Exception
HL7Exception
- if the named Structure is not part of this Group.Structure get(java.lang.String name) throws HL7Exception
HL7Exception
- if the named Structure is not part of this Group.Structure get(java.lang.String name, int rep) throws HL7Exception
HL7Exception
- if the named Structure is not part of this group,
if the structure is not repeatable and the given rep is > 0,
or if the given repetition number is more than one greater than the
existing number of repetitions.boolean isRequired(java.lang.String name) throws HL7Exception
HL7Exception
boolean isRepeating(java.lang.String name) throws HL7Exception
HL7Exception
java.lang.String[] getNames()
get(name)
.
java.lang.Class getClass(java.lang.String name)
java.lang.String addNonstandardSegment(java.lang.String name) throws HL7Exception
HL7Exception
java.lang.String addNonstandardSegment(java.lang.String name, int theIndex) throws HL7Exception
The
- index (zero-indexed) at which to insert this segment
HL7Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |