ca.uhn.hl7v2.model.v25.segment.QRI Maven / Gradle / Ivy
/*
* This class is an auto-generated source file for a HAPI
* HL7 v2.x standard structure class.
*
* For more information, visit: http://hl7api.sourceforge.net/
*/
package ca.uhn.hl7v2.model.v25.segment;
// import ca.uhn.hl7v2.model.v25.group.*;
import ca.uhn.hl7v2.model.v25.datatype.*;
import ca.uhn.log.HapiLogFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.Type;
import ca.uhn.hl7v2.model.AbstractSegment;
import ca.uhn.hl7v2.model.Varies;
/**
*Represents an HL7 QRI message segment (Query Response Instance).
* This segment has the following fields:
*
* - QRI-1: Candidate Confidence (NM) optional
*
- QRI-2: Match Reason Code (IS) optional repeating
*
- QRI-3: Algorithm Descriptor (CE) optional
*
*/
public class QRI extends AbstractSegment {
/**
* Creates a new QRI segment
*/
public QRI(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(NM.class, false, 1, 10, new Object[]{ getMessage(), new Integer(0) }, "Candidate Confidence");
this.add(IS.class, false, 0, 2, new Object[]{ getMessage() }, "Match Reason Code");
this.add(CE.class, false, 1, 250, new Object[]{ getMessage(), new Integer(393) }, "Algorithm Descriptor");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating QRI - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* QRI-1: "Candidate Confidence" - creates it if necessary
*/
public NM getCandidateConfidence() {
NM ret = null;
try {
Type t = this.getField(1, 0);
ret = (NM)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* QRI-1: "Candidate Confidence" - creates it if necessary
*/
public NM getQri1_CandidateConfidence() {
NM ret = null;
try {
Type t = this.getField(1, 0);
ret = (NM)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns all repetitions of Match Reason Code (QRI-2).
*/
public IS[] getMatchReasonCode() {
IS[] ret = null;
try {
Type[] t = this.getField(2);
ret = new IS[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (IS)t[i];
}
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a count of the current number of repetitions of Match Reason Code (QRI-2).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getMatchReasonCodeReps() {
IS[] ret = null;
try {
Type[] t = this.getField(2);
return t.length;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
}
/**
* Returns a specific repetition of
* QRI-2: "Match Reason Code" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public IS getMatchReasonCode(int rep) {
IS ret = null;
try {
Type t = this.getField(2, rep);
ret = (IS)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a specific repetition of
* QRI-2: "Match Reason Code" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public IS getQri2_MatchReasonCode(int rep) {
IS ret = null;
try {
Type t = this.getField(2, rep);
ret = (IS)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a count of the current number of repetitions of Match Reason Code (QRI-2).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getQri2_MatchReasonCodeReps() {
IS[] ret = null;
try {
Type[] t = this.getField(2);
return t.length;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
}
/**
* Inserts a repetition of
* QRI-2: "Match Reason Code" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public IS insertMatchReasonCode(int rep) throws HL7Exception {
return (IS) super.insertRepetition(2, rep);
}
/**
* Inserts a repetition of
* QRI-2: "Match Reason Code" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public IS insertQri2_MatchReasonCode(int rep) throws HL7Exception {
return (IS) super.insertRepetition(2, rep);
}
/**
* Removes a repetition of
* QRI-2: "Match Reason Code" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public IS removeMatchReasonCode(int rep) throws HL7Exception {
return (IS) super.removeRepetition(2, rep);
}
/**
* Removes a repetition of
* QRI-2: "Match Reason Code" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public IS removeQri2_MatchReasonCode(int rep) throws HL7Exception {
return (IS) super.removeRepetition(2, rep);
}
/**
* Returns
* QRI-3: "Algorithm Descriptor" - creates it if necessary
*/
public CE getAlgorithmDescriptor() {
CE ret = null;
try {
Type t = this.getField(3, 0);
ret = (CE)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* QRI-3: "Algorithm Descriptor" - creates it if necessary
*/
public CE getQri3_AlgorithmDescriptor() {
CE ret = null;
try {
Type t = this.getField(3, 0);
ret = (CE)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new NM(getMessage());
case 1: return new IS(getMessage(), new Integer( 392 ));
case 2: return new CE(getMessage());
default: return null;
}
}
}