Examples of ca.uhn.hl7v2.util.Terser

ca.uhn.hl7v2.util.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; omitting 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();

... is referenced by all of the following location_spec:

/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) @author Bryan Tripp @author Ryan W. Gross (General Electric Corporation - Healthcare IT).




76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93             out = DefaultApplication.makeACK(header);
        } catch (IOException e) {
            throw new HL7Exception(e);
        }
        
        Terser t = new Terser(out);
        t.set("/MSA-1", theAckCode);


        //TODO: when 2.5 is available, use 2.5 fields for remaining problems 
        if (theErrorCode != HL7Exception.MESSAGE_ACCEPTED) {
            t.set("/MSA-3", theDescription.substring(0, Math.min(80, theDescription.length())));            
            t.set("/ERR-1-4-1", String.valueOf(theErrorCode));
            t.set("/ERR-1-4-3", "HL70357");
        }
        
        String originalEncoding = ourParser.getEncoding(theMessage.getMessage());
        String ackText = ourParser.encode(out, originalEncoding);
        return new TransportableImpl(ackText);

View Full Code Here





326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361     }
    
    private void parse(StringTokenizer tok, Message message, StructRef root, EncodingCharacters ec) 
            throws HL7Exception {
        
        Terser t = new Terser(message);
        
        synchronized (root) {
            StructRef ref = root.getSuccessor("MSH");            
            
            int field = 0;
            Segment segment = null;
            int[] fields = new int[0];
            
            while (tok.hasMoreTokens()) {
                String token = tok.nextToken();
                if (token.charAt(0) == ec.getFieldSeparator()) {
                    field++;
                } else if (token.charAt(0) == ourSegmentSeparator) {
                    field = 0;
                } else if (field == 0) {
                    StructRef newref = drill(ref, token);
                    if (newref == null) {
                        segment = null;
                        fields = new int[0];
                    } else {
                        ref = newref;
                        if (ourLog.isDebugEnabled()) {
                            ourLog.debug("Parsing into segment " + ref.getFullPath());
                        }
                        segment = t.getSegment(ref.getFullPath());
                        fields = ref.getFields();
                    }
                } else if (segment != null && Arrays.binarySearch(fields, field) >= 0) {
                    parse(token, segment, field, ec);
                }

View Full Code Here


127
128
129
130
131
132
133
134
135
136
137
138                 Message response = app.processMessage(incomingMessageObject, theMetadata);
                
                //Here we explicitly use the same encoding as that of the inbound message - this is important with GenericParser, which might use a different encoding by default
                outgoingMessageString = myParser.encode(response, myParser.getEncoding(incomingMessageString));
                
                Terser t = new Terser(response);
                outgoingMessageCharset = t.get("MSH-18"); 
            }
            catch (Exception e) {
                outgoingMessageString = Responder.logAndMakeErrorMessage(e, (Segment) incomingMessageObject.get("MSH"), myParser, myParser.getEncoding(incomingMessageString));
            }
        }

View Full Code Here


263
264
265
266
267
268
269
270
271
272
273
274
275     
    /**
     * Returns the first Application that has been bound to messages of this type.  
     */
    private ReceivingApplication findApplication(Message theMessage) throws HL7Exception {
        Terser t = new Terser(theMessage);
        AppRoutingData msgData = 
            new AppRoutingDataImpl(t.get("/MSH-9-1"), t.get("/MSH-9-2"), t.get("/MSH-11-1"), t.get("/MSH-12"));
            
        ReceivingApplication app = findDestination(msgData);
        
        //have to send back an application reject if no apps available to process
        if (app == null)
 

View Full Code Here


101
102
103
104
105
106
107
108
109
110
111
112
113     
    /**
     * @see ca.uhn.hl7v2.protocol.Initiator#sendAndReceive(ca.uhn.hl7v2.model.Message)
     */
    public Message sendAndReceive(Message theMessage) throws HL7Exception {
        Terser t = new Terser(theMessage);
        String appAckNeeded = t.get("/MSH-16");
        String msgId = t.get("/MSH-10");
        
        String messageText = getParser().encode(theMessage);
        Map metadata = getMetadata(theMessage);
        Transportable out = new TransportableImpl(messageText, metadata);
        
 

View Full Code Here


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162         return need;
    }
    
    private Map getMetadata(Message theMessage) throws HL7Exception {
        Map md = new HashMap();
        Terser t = new Terser(theMessage);


        //snapshot so concurrent changes won't break our iteration
        Object[] fields = getMetadataFields().toArray(new Object[0]);
        
        for (int i = 0; i < fields.length; i++) {
            String field = fields[i].toString();
            String val = t.get(field); 
            md.put(field, val);
        }
        
        return md;
    }

View Full Code Here


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74      * @param message a parsed message to validate (note that MSH-9-1 and MSH-9-2 must be valued)
     * @return true if the message is OK
     * @throws HL7Exception if there is at least one error and this validator is set to fail on errors
     */
    public boolean validate(Message message) throws HL7Exception {
        Terser t = new Terser(message);
        
        MessageRule[] rules = EMPTY_MESSAGE_RULES_ARRAY;
        if (myContext != null) {
          rules = myContext.getMessageRules(message.getVersion(), t.get("MSH-9-1"), t.get("MSH-9-2"));
        }
        
        ValidationException toThrow = null;
        boolean result = true;
        for (int i = 0; i < rules.length; i++) {
 

View Full Code Here


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99             LogFactory.getLog(logName).error("message validation failure", problems[i]);
        }
    }
    
    private void addProblemsToACK(Message ack, HL7Exception[] problems) throws HL7Exception {
        Terser t = new Terser(ack);
        
        if (problems.length > 0) {
            t.set("MSA-1", "AE");        
            t.set("MSA-3", "Errors were encountered while testing the message");
        }
        
        Segment err = (Segment) ack.get("ERR");
        for (int i = 0; i < problems.length; i++) {
            // problems[i].populate(err); FIXME: broken! needs database

View Full Code Here


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325         
        // create error message ...
        String errorMessage = null;
        try {
            Message out = DefaultApplication.makeACK(inHeader);
            Terser t = new Terser(out);
            
            //copy required data from incoming message ...
            try {
                t.set("/MSH-10", MessageIDGenerator.getInstance().getNewID());
            }
            catch (IOException ioe) {
                throw new HL7Exception("Problem creating error message ID: " + ioe.getMessage());
            }
            
            //populate MSA ...
            t.set("/MSA-1", "AE"); //should this come from HL7Exception constructor?
            t.set("/MSA-2", Terser.get(inHeader, 10, 0, 1, 1));
            String excepMessage = e.getMessage();
            if (excepMessage != null)
                t.set("/MSA-3", excepMessage.substring(0, Math.min(80, excepMessage.length())));
            
            /* Some earlier ACKs don't have ERRs, but I think we'll change this within HAPI
               so that there is a single ACK for each version (with an ERR). */
            //see if it's an HL7Exception (so we can get specific information) ...
            if (e.getClass().equals(HL7Exception.class)) {
                Segment err = (Segment) out.get("ERR");
                // ((HL7Exception) e).populate(err); // FIXME: this is broken, it relies on the database in a place where it's not available
            }
            else {
                t.set("/ERR-1-4-1", "207");
                t.set("/ERR-1-4-2", "Application Internal Error");
                t.set("/ERR-1-4-3", "HL70357");
            }
            
            if (encoding != null) {
                errorMessage = p.encode(out, encoding);
            } else {
 

View Full Code Here


114
115
116
117
118
119
120
121
122
123
124
125       throw new HL7Exception("Can't encode null message",
          ErrorCode.REQUIRED_FIELD_MISSING);
    }


    // register message with response Receiver(s) (by message ID)
    Terser t = new Terser(out);
    String messID = t.get("/MSH-10");


    if (messID == null || messID.length() == 0) {
      throw new HL7Exception(
          "MSH segment missing required field Control ID (MSH-10)",
          ErrorCode.REQUIRED_FIELD_MISSING);

View Full Code Here



0
1
2
3
4
5
6
7
8
9



TOP

Related Classes of ca.uhn.hl7v2.util.Terser

ca.uhn.hl7v2.app.ActiveInitiator
ca.uhn.hl7v2.app.DefaultApplication
ca.uhn.hl7v2.app.Initiator
ca.uhn.hl7v2.app.MessageTypeRouter
ca.uhn.hl7v2.app.Responder
ca.uhn.hl7v2.conf.check.DefaultValidator
ca.uhn.hl7v2.examples.ExampleUseTerser
ca.uhn.hl7v2.examples.HandlingMultipleVersions
ca.uhn.hl7v2.hoh.hapi.api.MessageSendable
ca.uhn.hl7v2.hoh.relay.sender.RelayHttpSender



Copyright © 2018 www.massapicom. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.