|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectca.uhn.hl7v2.util.Terser
public class Terser
Wraps a message to provide access to fields using a terse location specification syntax. For example:
terser.set("MSH-9-3", "ADT_A01");
can be used instead of
message.getMSH().getMessageType().getMessageStructure().setValue("ADT_A01");
The syntax of a location spec is as follows:
location_spec: segment_path_spec "-" field ["(" rep ")"] ["-" component ["-" subcomponent]]
... where rep, field, component, and subcomponent are integers (representing, respectively, the field repetition (starting at 0), and the field number, component number, and subcomponent numbers (starting at 1). Omitting the rep is equivalent to specifying 0; omitting the component or subcomponent is equivalent to specifying 1.
The syntax for the segment_path_spec is as follows:
segment_path_spec: ["/"] (group_spec ["(" rep ")"] "/")* segment_spec ["(" rep ")"]
... where rep has the same meaning as for fields. A leading "/" indicates that navigation to the location begins at the root of the message; ommitting this indicates that navigation begins at the current location of the underlying SegmentFinder (see getFinder() -- this allows manual navigation if desired). The syntax for group_spec is:
group_spec: ["."] group_name_pattern
Here, a . indicates that the group should be searched for (using a SegmentFinder) starting at the current location in the message. The wildcards "*" and "?" represent any number of arbitrary characters, and a single arbitrary character, respectively. For example, "M*" and "?S?" match MSH. The first group with a name that matches the given group_name_pattern will be matched.
The segment_spec is analogous to the group_spec.
As another example, the following subcomponent in an SIU_S12 message:
msg.getSIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE(1).getSIU_S12_AIGNTE().getAIG().getResourceGroup(1).getIdentifier();
/SIU_S12_RGSAISNTEAIGNTEAILNTEAIPNTE(1)/SIU_S12_AIGNTE/AIG-5(1)-1
/*AIG*(1)/SIU_S12_AIGNTE/AIG-5(1)-1
/*AIG*(1)/.AIG-5(1)
The search function only iterates through rep 0 of each group. Thus if rep 0 of the first group in this example was desired instead of rep 1, the following syntax would also work (since there is only one AIG segment position in SUI_S12):
/.AIG-5(1)
Constructor Summary | |
---|---|
Terser(Message message)
Creates a new instance of Terser |
Method Summary | |
---|---|
static java.lang.String |
get(Segment segment,
int field,
int rep,
int component,
int subcomponent)
Returns the string value of the Primitive at the given location. |
java.lang.String |
get(java.lang.String spec)
Gets the string value of the field specified. |
SegmentFinder |
getFinder()
Returns the segment finder used by this Terser. |
static int[] |
getIndices(java.lang.String spec)
Given a Terser path, returns an array containing field num, field rep, component, and subcomponent. |
static Primitive |
getPrimitive(Type type,
int component,
int subcomponent)
Returns the Primitive object at the given location in the given field. |
Segment |
getSegment(java.lang.String segSpec)
Returns the segment specified in the given segment_path_spec. |
static int |
numComponents(Type type)
Returns the number of components in the given type, i.e. |
static int |
numSubComponents(Type type,
int component)
Returns the number of sub-components in the specified component, i.e. |
static void |
set(Segment segment,
int field,
int rep,
int component,
int subcomponent,
java.lang.String value)
Sets the string value of the Primitive at the given location. |
void |
set(java.lang.String spec,
java.lang.String value)
Sets the string value of the field specified. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Terser(Message message)
Method Detail |
---|
public static java.lang.String get(Segment segment, int field, int rep, int component, int subcomponent) throws HL7Exception
segment
- the segment from which to get the primitivefield
- the field numberrep
- the field repetitioncomponent
- the component number (use 1 for primitive field)subcomponent
- the subcomponent number (use 1 for primitive component)
HL7Exception
public static void set(Segment segment, int field, int rep, int component, int subcomponent, java.lang.String value) throws HL7Exception
HL7Exception
public static Primitive getPrimitive(Type type, int component, int subcomponent)
public java.lang.String get(java.lang.String spec) throws HL7Exception
Gets the string value of the field specified. See the class docs for syntax of the location spec.
If a repetition is omitted for a repeating segment or field, the first rep is used. If the component or subcomponent is not specified for a composite field, the first component is used (this allows one to write code that will work with later versions of the HL7 standard).
HL7Exception
public Segment getSegment(java.lang.String segSpec) throws HL7Exception
HL7Exception
public static int[] getIndices(java.lang.String spec) throws HL7Exception
HL7Exception
public void set(java.lang.String spec, java.lang.String value) throws HL7Exception
HL7Exception
public static int numSubComponents(Type type, int component)
component
- numbered from 1public static int numComponents(Type type)
public SegmentFinder getFinder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |