cdac.medinfo.sdk.hl7282.baselibs

Class VID

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType

cdac.medinfo.sdk.hl7282.baselibs.VID

All Implemented Interfaces:

IDataType

public class VID
extends CompositeDataType

VID - Version identifier

This data type is version identifier.

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

1. Version ID (ID)Required
2. Internationalization Code (CWE)Optional
3. International Version ID (CWE)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
VID() Default Constructor for VID
VID(int iComponentType, IDataTypeMap objIDataTypeMap) Constructor for VID class which takes two arguments and sets the value in the respective member variable.
VID(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap) Constructor for VID class which takes five arguments and sets the value in the respective member variable.
VID(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap) Constructor for VID class which takes six arguments and sets the value in the respective member variable.
VID(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType) Constructor for VID class which takes four arguments and sets the value in the respective member variable.
VID(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType) Constructor for VID 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.
CWE	getInternationalizationCode() Returns Internationalization Code
CWE	getInternationalVersionID() Returns International Version ID
ID	getVersionID() The method gives the object of Tye ID
void	setInternationalizationCode(CWE objInternationalizationCode) Sets the InternationalizationCode.
void	setInternationalVersionId(CWE objInternationalVersionId) Sets the InternationalVersionId.
void	setVersionId(ID objID) Sets the VersionId.
void	setVersionId(java.lang.String strVersionId) Sets the VersionId.
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

VID

public VID()

Default Constructor for VID

VID

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

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

VID

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

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

VID

public VID(int iComponentType,
   IDataTypeMap objIDataTypeMap)

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

VID

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

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

VID

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

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

setVersionId

public void setVersionId(java.lang.String strVersionId)

Sets the VersionId.

Parameters:

strVersionId - Used to identify the HL7 version.

setVersionId

public void setVersionId(ID objID)

Sets the VersionId.

Parameters:

objID - Used to identify the HL7 version.

setInternationalizationCode

public void setInternationalizationCode(CWE objInternationalizationCode)

Sets the InternationalizationCode.

Parameters:

objInternationalizationCode - Used to identify the international affiliate country code.

setInternationalVersionId

public void setInternationalVersionId(CWE objInternationalVersionId)

Sets the InternationalVersionId.

Parameters:

objInternationalVersionId - International affiliate's version.

getVersionID

public ID getVersionID()

The method gives the object of Tye ID

Returns:

ID - data type.

getInternationalizationCode

public CWE getInternationalizationCode()

Returns Internationalization Code

Returns:

CWE - data type.

getInternationalVersionID

public CWE getInternationalVersionID()

Returns International Version ID

Returns:

CWE - data type.

validate

public boolean validate()
                 throws InvalidDataTypeException

The Method validates the Input value,and if validated properly then returns true. Here the validation 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.