ca.uhn.hl7v2.model.v21.segment.QRF 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.v21.segment;
// import ca.uhn.hl7v2.model.v21.group.*;
import ca.uhn.hl7v2.model.v21.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 QRF message segment (QUERY FILTER).
* This segment has the following fields:
*
* - QRF-1: WHERE SUBJECT FILTER (ST) repeating
*
- QRF-2: WHEN DATA START DATE/TIME (TS) optional
*
- QRF-3: WHEN DATA END DATE/TIME (TS) optional
*
- QRF-4: WHAT USER QUALIFIER (ST) optional repeating
*
- QRF-5: OTHER QRY SUBJECT FILTER (ST) optional repeating
*
*/
public class QRF extends AbstractSegment {
/**
* Creates a new QRF segment
*/
public QRF(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ST.class, true, 0, 20, new Object[]{ getMessage(), new Integer(0) }, "WHERE SUBJECT FILTER");
this.add(TS.class, false, 1, 19, new Object[]{ getMessage(), new Integer(0) }, "WHEN DATA START DATE/TIME");
this.add(TS.class, false, 1, 19, new Object[]{ getMessage(), new Integer(0) }, "WHEN DATA END DATE/TIME");
this.add(ST.class, false, 0, 20, new Object[]{ getMessage(), new Integer(0) }, "WHAT USER QUALIFIER");
this.add(ST.class, false, 0, 20, new Object[]{ getMessage(), new Integer(0) }, "OTHER QRY SUBJECT FILTER");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating QRF - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns all repetitions of WHERE SUBJECT FILTER (QRF-1).
*/
public ST[] getWHERESUBJECTFILTER() {
ST[] ret = null;
try {
Type[] t = this.getField(1);
ret = new ST[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (ST)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 WHERE SUBJECT FILTER (QRF-1).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getWHERESUBJECTFILTERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(1);
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
* QRF-1: "WHERE SUBJECT FILTER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getWHERESUBJECTFILTER(int rep) {
ST ret = null;
try {
Type t = this.getField(1, rep);
ret = (ST)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
* QRF-1: "WHERE SUBJECT FILTER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getQrf1_WHERESUBJECTFILTER(int rep) {
ST ret = null;
try {
Type t = this.getField(1, rep);
ret = (ST)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 WHERE SUBJECT FILTER (QRF-1).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getQrf1_WHERESUBJECTFILTERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(1);
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
* QRF-1: "WHERE SUBJECT FILTER" 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 ST insertWHERESUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(1, rep);
}
/**
* Inserts a repetition of
* QRF-1: "WHERE SUBJECT FILTER" 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 ST insertQrf1_WHERESUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(1, rep);
}
/**
* Removes a repetition of
* QRF-1: "WHERE SUBJECT FILTER" 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 ST removeWHERESUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(1, rep);
}
/**
* Removes a repetition of
* QRF-1: "WHERE SUBJECT FILTER" 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 ST removeQrf1_WHERESUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(1, rep);
}
/**
* Returns
* QRF-2: "WHEN DATA START DATE/TIME" - creates it if necessary
*/
public TS getWHENDATASTARTDATETIME() {
TS ret = null;
try {
Type t = this.getField(2, 0);
ret = (TS)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
* QRF-2: "WHEN DATA START DATE/TIME" - creates it if necessary
*/
public TS getQrf2_WHENDATASTARTDATETIME() {
TS ret = null;
try {
Type t = this.getField(2, 0);
ret = (TS)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
* QRF-3: "WHEN DATA END DATE/TIME" - creates it if necessary
*/
public TS getWHENDATAENDDATETIME() {
TS ret = null;
try {
Type t = this.getField(3, 0);
ret = (TS)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
* QRF-3: "WHEN DATA END DATE/TIME" - creates it if necessary
*/
public TS getQrf3_WHENDATAENDDATETIME() {
TS ret = null;
try {
Type t = this.getField(3, 0);
ret = (TS)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 WHAT USER QUALIFIER (QRF-4).
*/
public ST[] getWHATUSERQUALIFIER() {
ST[] ret = null;
try {
Type[] t = this.getField(4);
ret = new ST[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (ST)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 WHAT USER QUALIFIER (QRF-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getWHATUSERQUALIFIERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(4);
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
* QRF-4: "WHAT USER QUALIFIER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getWHATUSERQUALIFIER(int rep) {
ST ret = null;
try {
Type t = this.getField(4, rep);
ret = (ST)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
* QRF-4: "WHAT USER QUALIFIER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getQrf4_WHATUSERQUALIFIER(int rep) {
ST ret = null;
try {
Type t = this.getField(4, rep);
ret = (ST)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 WHAT USER QUALIFIER (QRF-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getQrf4_WHATUSERQUALIFIERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(4);
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
* QRF-4: "WHAT USER QUALIFIER" 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 ST insertWHATUSERQUALIFIER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(4, rep);
}
/**
* Inserts a repetition of
* QRF-4: "WHAT USER QUALIFIER" 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 ST insertQrf4_WHATUSERQUALIFIER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(4, rep);
}
/**
* Removes a repetition of
* QRF-4: "WHAT USER QUALIFIER" 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 ST removeWHATUSERQUALIFIER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(4, rep);
}
/**
* Removes a repetition of
* QRF-4: "WHAT USER QUALIFIER" 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 ST removeQrf4_WHATUSERQUALIFIER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(4, rep);
}
/**
* Returns all repetitions of OTHER QRY SUBJECT FILTER (QRF-5).
*/
public ST[] getOTHERQRYSUBJECTFILTER() {
ST[] ret = null;
try {
Type[] t = this.getField(5);
ret = new ST[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (ST)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 OTHER QRY SUBJECT FILTER (QRF-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getOTHERQRYSUBJECTFILTERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(5);
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
* QRF-5: "OTHER QRY SUBJECT FILTER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getOTHERQRYSUBJECTFILTER(int rep) {
ST ret = null;
try {
Type t = this.getField(5, rep);
ret = (ST)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
* QRF-5: "OTHER QRY SUBJECT FILTER" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getQrf5_OTHERQRYSUBJECTFILTER(int rep) {
ST ret = null;
try {
Type t = this.getField(5, rep);
ret = (ST)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 OTHER QRY SUBJECT FILTER (QRF-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getQrf5_OTHERQRYSUBJECTFILTERReps() {
ST[] ret = null;
try {
Type[] t = this.getField(5);
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
* QRF-5: "OTHER QRY SUBJECT FILTER" 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 ST insertOTHERQRYSUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(5, rep);
}
/**
* Inserts a repetition of
* QRF-5: "OTHER QRY SUBJECT FILTER" 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 ST insertQrf5_OTHERQRYSUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.insertRepetition(5, rep);
}
/**
* Removes a repetition of
* QRF-5: "OTHER QRY SUBJECT FILTER" 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 ST removeOTHERQRYSUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(5, rep);
}
/**
* Removes a repetition of
* QRF-5: "OTHER QRY SUBJECT FILTER" 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 ST removeQrf5_OTHERQRYSUBJECTFILTER(int rep) throws HL7Exception {
return (ST) super.removeRepetition(5, rep);
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new ST(getMessage());
case 1: return new TS(getMessage());
case 2: return new TS(getMessage());
case 3: return new ST(getMessage());
case 4: return new ST(getMessage());
default: return null;
}
}
}