ca.uhn.hl7v2.model.v24.message.VXX_V02 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/
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
* specific language governing rights and limitations under the License.
*
* The Original Code is "[file_name]". Description:
* "[one_line_description]"
*
* The Initial Developer of the Original Code is University Health Network. Copyright (C)
* 2002. All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* Alternatively, the contents of this file may be used under the terms of the
* GNU General Public License (the "GPL"), in which case the provisions of the GPL are
* applicable instead of those above. If you wish to allow use of your version of this
* file only under the terms of the GPL and not to allow others to use your version
* of this file under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL License.
* If you do not delete the provisions above, a recipient may use your version of
* this file under either the MPL or the GPL.
*
*/
package ca.uhn.hl7v2.model.v24.message;
import ca.uhn.hl7v2.model.v24.group.*;
import ca.uhn.hl7v2.model.v24.segment.*;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
/**
* Represents a VXX_V02 message structure (see chapter ?). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: MSA (Message Acknowledgment)
* - 3: QRD (Original-Style Query Definition)
* - 4: QRF (Original Style Query Filter) optional
* - 5: VXX_V02_PATIENT (a Group object) repeating
*
*/
public class VXX_V02 extends AbstractMessage {
/**
* Creates a new VXX_V02 message with DefaultModelClassFactory.
*/
public VXX_V02() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new VXX_V02 message with custom ModelClassFactory.
*/
public VXX_V02(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(MSA.class, true, false);
this.add(QRD.class, true, false);
this.add(QRF.class, false, false);
this.add(VXX_V02_PATIENT.class, true, true);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating VXX_V02 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.4"
*/
public String getVersion() {
return "2.4";
}
/**
* Returns
* MSH (Message Header) - creates it if necessary
*/
public MSH getMSH() {
MSH ret = null;
try {
ret = (MSH)this.get("MSH");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* MSA (Message Acknowledgment) - creates it if necessary
*/
public MSA getMSA() {
MSA ret = null;
try {
ret = (MSA)this.get("MSA");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* QRD (Original-Style Query Definition) - creates it if necessary
*/
public QRD getQRD() {
QRD ret = null;
try {
ret = (QRD)this.get("QRD");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* QRF (Original Style Query Filter) - creates it if necessary
*/
public QRF getQRF() {
QRF ret = null;
try {
ret = (QRF)this.get("QRF");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* PATIENT (a Group object) - creates it if necessary
*/
public VXX_V02_PATIENT getPATIENT() {
VXX_V02_PATIENT ret = null;
try {
ret = (VXX_V02_PATIENT)this.get("PATIENT");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* PATIENT (a Group object) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public VXX_V02_PATIENT getPATIENT(int rep) {
VXX_V02_PATIENT ret = null;
try {
ret = (VXX_V02_PATIENT)this.get("PATIENT", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of PATIENT
*/
public int getPATIENTReps() {
int reps = -1;
try {
reps = this.getAll("PATIENT").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PATIENT.
*
*
* Note that unlike {@link #getPATIENT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getPATIENTAll() throws HL7Exception {
return this.getAllAsList("PATIENT", VXX_V02_PATIENT.class);
}
/**
* Inserts a specific repetition of PATIENT (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPATIENT(VXX_V02_PATIENT structure, int rep) throws HL7Exception {
super.insertRepetition( "PATIENT", structure, rep);
}
/**
* Inserts a specific repetition of PATIENT (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public VXX_V02_PATIENT insertPATIENT(int rep) throws HL7Exception {
return (VXX_V02_PATIENT)super.insertRepetition("PATIENT", rep);
}
/**
* Removes a specific repetition of PATIENT (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public VXX_V02_PATIENT removePATIENT(int rep) throws HL7Exception {
return (VXX_V02_PATIENT)super.removeRepetition("PATIENT", rep);
}
}