ca.uhn.hl7v2.model.v25.segment.CM2 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 CM2 message segment (Clinical Study Schedule Master).
* This segment has the following fields:
*
* - CM2-1: Set ID- CM2 (SI) optional
*
- CM2-2: Scheduled Time Point (CE)
*
- CM2-3: Description of Time Point (ST) optional
*
- CM2-4: Events Scheduled This Time Point (CE) repeating
*
*/
public class CM2 extends AbstractSegment {
/**
* Creates a new CM2 segment
*/
public CM2(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(SI.class, false, 1, 4, new Object[]{ getMessage(), new Integer(0) }, "Set ID- CM2");
this.add(CE.class, true, 1, 250, new Object[]{ getMessage(), new Integer(0) }, "Scheduled Time Point");
this.add(ST.class, false, 1, 300, new Object[]{ getMessage(), new Integer(0) }, "Description of Time Point");
this.add(CE.class, true, 0, 250, new Object[]{ getMessage(), new Integer(0) }, "Events Scheduled This Time Point");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating CM2 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* CM2-1: "Set ID- CM2" - creates it if necessary
*/
public SI getSetIDCM2() {
SI ret = null;
try {
Type t = this.getField(1, 0);
ret = (SI)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
* CM2-1: "Set ID- CM2" - creates it if necessary
*/
public SI getCm21_SetIDCM2() {
SI ret = null;
try {
Type t = this.getField(1, 0);
ret = (SI)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
* CM2-2: "Scheduled Time Point" - creates it if necessary
*/
public CE getScheduledTimePoint() {
CE ret = null;
try {
Type t = this.getField(2, 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
* CM2-2: "Scheduled Time Point" - creates it if necessary
*/
public CE getCm22_ScheduledTimePoint() {
CE ret = null;
try {
Type t = this.getField(2, 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
* CM2-3: "Description of Time Point" - creates it if necessary
*/
public ST getDescriptionOfTimePoint() {
ST ret = null;
try {
Type t = this.getField(3, 0);
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
* CM2-3: "Description of Time Point" - creates it if necessary
*/
public ST getCm23_DescriptionOfTimePoint() {
ST ret = null;
try {
Type t = this.getField(3, 0);
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 all repetitions of Events Scheduled This Time Point (CM2-4).
*/
public CE[] getEventsScheduledThisTimePoint() {
CE[] ret = null;
try {
Type[] t = this.getField(4);
ret = new CE[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (CE)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 Events Scheduled This Time Point (CM2-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getEventsScheduledThisTimePointReps() {
CE[] 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
* CM2-4: "Events Scheduled This Time Point" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getEventsScheduledThisTimePoint(int rep) {
CE ret = null;
try {
Type t = this.getField(4, rep);
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 a specific repetition of
* CM2-4: "Events Scheduled This Time Point" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getCm24_EventsScheduledThisTimePoint(int rep) {
CE ret = null;
try {
Type t = this.getField(4, rep);
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 a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getCm24_EventsScheduledThisTimePointReps() {
CE[] 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
* CM2-4: "Events Scheduled This Time Point" 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 CE insertEventsScheduledThisTimePoint(int rep) throws HL7Exception {
return (CE) super.insertRepetition(4, rep);
}
/**
* Inserts a repetition of
* CM2-4: "Events Scheduled This Time Point" 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 CE insertCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception {
return (CE) super.insertRepetition(4, rep);
}
/**
* Removes a repetition of
* CM2-4: "Events Scheduled This Time Point" 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 CE removeEventsScheduledThisTimePoint(int rep) throws HL7Exception {
return (CE) super.removeRepetition(4, rep);
}
/**
* Removes a repetition of
* CM2-4: "Events Scheduled This Time Point" 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 CE removeCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception {
return (CE) super.removeRepetition(4, rep);
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new SI(getMessage());
case 1: return new CE(getMessage());
case 2: return new ST(getMessage());
case 3: return new CE(getMessage());
default: return null;
}
}
}