cdac.medinfo.sdk.hl7282.baselibs

Class QIP

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType

cdac.medinfo.sdk.hl7282.baselibs.QIP

All Implemented Interfaces:

IDataType

public class QIP
extends CompositeDataType

QIP - Query input parameter list

This data type contains a segment field name and the list of values to be passed to the query processor.

Represents an HL7 QIP data type. This data type has the following attributes:

1. Segment Field Name (ST)Required
2. Values (ST)Required

This class provides accessors & mutators for the elements mentioned above. This class override the equal method, to check whether some other object is "equal to" this one.

User can also create Data Type through DataElementFactory

Constructor Summary

Constructors

Constructor and Description
QIP() Default Constructor for QIP
QIP(int iComponentType, IDataTypeMap objIDataTypeMap) Constructor for QIP class which takes two arguments and sets the value in the respective member variable.
QIP(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap) Constructor for QIP class which takes five arguments and sets the value in the respective member variable.
QIP(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap) Constructor for QIP class which takes six arguments and sets the value in the respective member variable.
QIP(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType) Constructor for QIP class which takes four arguments and sets the value in the respective member variable.
QIP(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType) Constructor for QIP class which takes five arguments and sets the value in the respective member variable.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objObject) This method checks the equality of Object.
ST	getSegmentFieldName() Returns Segment Field Name
ST	getValues() Returns Values
void	setSegmentFieldName(ST objST) Sets the SegmentFieldName.
void	setSegmentFieldName(java.lang.String strSegmentFieldName) Sets the SegmentFieldName.
void	setValues(ST objST) Sets the Values.
void	setValues(java.lang.String strValues) Sets the Values.
boolean	validate() The Method validates the Input value,and if validated properly then returns true.

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType

copy, dumpDataType, getAttributes, getDataTypeName, getLength, getValue, isPrimitive, read, setValue, write, writeToXML

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QIP

public QIP()

Default Constructor for QIP

QIP

public QIP(int iMinLength,
   int iMaxLength,
   java.lang.String strCLength,
   int iComponentType)
    throws InvalidComponentTypeException

Constructor for QIP class which takes four arguments and sets the value in the respective member variable.

Parameters:

iMinLength - The Minimum length the DataType can have.

iMaxLength - The Maximum length the DataType can have.

iCLength - The Conformance length the DataType can have.

iComponentType - The Type of the component i.e Component or a subcomponent.

Throws:

InvalidComponentTypeException - - if Component Type is not specified or valid.

QIP

public QIP(int iMinLength,
   int iMaxLength,
   java.lang.String strCLength,
   int iTableNo,
   int iComponentType)
    throws InvalidComponentTypeException

Constructor for QIP class which takes five arguments and sets the value in the respective member variable.

Parameters:

iMinLength - The Minimum length the DataType can have.

iMaxLength - The Maximum length the DataType can have.

iCLength - The Conformance length the DataType can have.

iTableNo - The Table number to which the value for the component is specified.

iComponentType - The Type of the component i.e Component or a subcomponent.

Throws:

InvalidComponentTypeException - - if Component Type is not specified or valid.

QIP

public QIP(int iComponentType,
   IDataTypeMap objIDataTypeMap)

Constructor for QIP class which takes two arguments and sets the value in the respective member variable.

Parameters:

objIDataTypeMap - object of Data Type Map.

iComponentType - The Type of the component i.e Component or a subcomponent.

Throws:

InvalidComponentTypeException - - if Component Type is not specified or valid.

QIP

public QIP(int iComponentType,
   int iMinLength,
   int iMaxLength,
   java.lang.String strCLength,
   IDataTypeMap objIDataTypeMap)

Constructor for QIP class which takes five arguments and sets the value in the respective member variable.

Parameters:

objIDataTypeMap - object of Data Type Map.

iComponentType - The Type of the component i.e Component or a subcomponent.

iMinLength - The Minimum length the DataType can have.

iMaxLength - The Maximum length the DataType can have.

iCLength - The Conformance length the DataType can have.

Throws:

InvalidComponentTypeException - - if Component Type is not specified or valid.

QIP

public QIP(int iComponentType,
   int iMinLength,
   int iMaxLength,
   java.lang.String strCLength,
   int ITableNo,
   IDataTypeMap objIDataTypeMap)

Constructor for QIP class which takes six arguments and sets the value in the respective member variable.

Parameters:

objIDataTypeMap - object of Data Type Map.

iComponentType - The Type of the component i.e Component or a subcomponent.

iMinLength - The Minimum length the DataType can have.

iMaxLength - The Maximum length the DataType can have.

iCLength - The Conformance length the DataType can have.

iTableNo - The Table number to which the value for the component is specified.

Throws:

InvalidComponentTypeException - - if Component Type is not specified or valid.

Method Detail

setSegmentFieldName

public void setSegmentFieldName(java.lang.String strSegmentFieldName)

Sets the SegmentFieldName.

Parameters:

strSegmentFieldName - This component contains the segment field name.

setSegmentFieldName

public void setSegmentFieldName(ST objST)

Sets the SegmentFieldName.

Parameters:

objST - This component contains the segment field name.

setValues

public void setValues(java.lang.String strValues)

Sets the Values.

Parameters:

strValues - This component contains the field value or values in the form "value1& value2 & value3".

setValues

public void setValues(ST objST)

Sets the Values.

Parameters:

objST - This component contains the field value or values in the form "value1& value2 & value3".

getSegmentFieldName

public ST getSegmentFieldName()

Returns Segment Field Name

Returns:

ST - data type.

getValues

public ST getValues()

Returns Values

Returns:

ST - data type.

validate

public boolean validate()
                 throws InvalidDataTypeException

The Method validates the Input value,and if validated properly then returns true. Here the validetion is based on the compulsory fields for the Datatype.

Specified by:

validate in interface IDataType

Overrides:

validate in class CompositeDataType

Returns:

boolean - true or false.

Throws:

InvalidDataTypeException - - if Invalid values is entered or Mandatory field is missing.

equals

public boolean equals(java.lang.Object objObject)

This method checks the equality of Object.

Overrides:

equals in class java.lang.Object

Parameters:

objObject - object of Object class.

Returns:

boolean - shows success or failure of the comparison.