cdac.medinfo.sdk.hl7282.baselibs

Class VR

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType

cdac.medinfo.sdk.hl7282.baselibs.VR

All Implemented Interfaces:

IDataType

public class VR
extends CompositeDataType

VR - Value range

This data type contains the lower bound value and upper bound values that constitute a range. Either or both components may be populated.

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

1. First Data Code Value (ST)Optional
2. Last Data Code Value (ST)Optional

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
VR() Default Constructor for VR
VR(int iComponentType, IDataTypeMap objIDataTypeMap) Constructor for VR class which takes two arguments and sets the value in the respective member variable.
VR(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap) Constructor for VR class which takes five arguments and sets the value in the respective member variable.
VR(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap) Constructor for VR class which takes six arguments and sets the value in the respective member variable.
VR(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType) Constructor for VR class which takes four arguments and sets the value in the respective member variable.
VR(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType) Constructor for VR 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	getFirstDataCodeValue() Returns First Data Code Value
ST	getLastDataCodeValue() Returns Last Data Code Value
void	setFirstDataCodeValue(ST objST) Sets the FirstDataCodeValue.
void	setFirstDataCodeValue(java.lang.String strFirstDataCodeValue) Sets the FirstDataCodeValue.
void	setLastDataCodeValue(ST objST) Sets the LastDataCodeValue.
void	setLastDataCodeValue(java.lang.String strLastDataCodeValue) Sets the LastDataCodeValue.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VR

public VR()

Default Constructor for VR

VR

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

Constructor for VR 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.

VR

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

Constructor for VR 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.

VR

public VR(int iComponentType,
  IDataTypeMap objIDataTypeMap)

Constructor for VR 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.

VR

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

Constructor for VR 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.

VR

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

Constructor for VR 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

setFirstDataCodeValue

public void setFirstDataCodeValue(java.lang.String strFirstDataCodeValue)

Sets the FirstDataCodeValue.

Parameters:

strFirstDataCodeValue - Specifies the lower bound value.

setFirstDataCodeValue

public void setFirstDataCodeValue(ST objST)

Sets the FirstDataCodeValue.

Parameters:

objST - Specifies the lower bound value.

setLastDataCodeValue

public void setLastDataCodeValue(java.lang.String strLastDataCodeValue)

Sets the LastDataCodeValue.

Parameters:

strLastDataCodeValue - Specifies the upper bound value.

setLastDataCodeValue

public void setLastDataCodeValue(ST objST)

Sets the LastDataCodeValue.

Parameters:

objST - Specifies the upper bound value.

getFirstDataCodeValue

public ST getFirstDataCodeValue()

Returns First Data Code Value

Returns:

ST - data type.

getLastDataCodeValue

public ST getLastDataCodeValue()

Returns Last Data Code Value

Returns:

ST - data type.

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.