/*******************************************************************************
 *  Copyright 2017 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 *  Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *******************************************************************************/
package cdac.medinfo.sdk.hl7282.baselibs;

import cdac.medinfo.sdk.hl7282.baselibs.segmentfactory.DataElementFactory;
import cdac.medinfo.sdk.hl7282.commoninterface.IDataType;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.exceptions.InvalidComponentTypeException;
import cdac.medinfo.sdk.hl7282.utils.EnumDataType;
import cdac.medinfo.sdk.hl7282.utils.IDataTypeMap;

/**
 * RP - Reference pointer<p>
 * This data type transmits information about data stored on 
 * another system. It contains a reference pointer that uniquely identifies 
 * the data on the other system, the identity of the other system, and the 
 * type of data.
 * <p>Represents an HL7 RP data type. 
 * This data type has the following attributes:</p><p>
 *  1.  Pointer (ST)<b>Optional</b><br>
 *  2. Application ID (HD)<b>Optional</b><br>
 *  3. Type of Data (ID)<b>Optional</b><br>
 *  4. Subtype (ID)<b>Optional</b><br><p>
 * 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.
 * 
 * <p>User can also create Data Type through {@link DataElementFactory} 
 */
public class RP extends CompositeDataType    
{
	


	/**
	 * Default Constructor for RP
	 */
	public RP()
	{
		super(EnumDataType.HL7_DT_RP);
		 
	}

	/**
	 * Constructor  for CQ class which takes four arguments and 
	 * sets the value in the respective member variable.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */ 
	public RP(int iMinLength, int iMaxLength, String strCLength,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_RP);
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}


	/**
	 * Constructor for RP class which takes five arguments and 
	 * sets the value in the respective member variable.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iTableNo The Table number to which the value for the component is specified. 
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public RP(int iMinLength, int iMaxLength, String strCLength,int iTableNo,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_RP);
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;
		this.iTableNo = iTableNo;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());		
		}
	}
	/**
	 * Constructor for RP class which takes two arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public RP(int iComponentType,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RP);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}
	/**
	 * Constructor for RP class which takes five arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public RP(int iComponentType,int iMinLength, int iMaxLength, String strCLength,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RP);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;

		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}
	/**
	 * Constructor for RP class which takes six arguments and 
	 * sets the value in the respective member variable.
	 * @param objIDataTypeMap object of Data Type Map.
	 * @param iComponentType The Type of the component i.e Component or a subcomponent.
	 * @param iMinLength The Minimum length the DataType can have.
	 * @param iMaxLength The Maximum length the DataType can have.
	 * @param iCLength The Conformance length the DataType can have.
	 * @param iTableNo The Table number to which the value for the component is specified. 
	 * @throws InvalidComponentTypeException - if Component Type is not specified or valid. 
	 */
	public RP(int iComponentType,int iMinLength, int iMaxLength, String strCLength,int ITableNo,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RP);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		this.iTableNo = ITableNo;
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;

		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}



	/**
	 *Sets the Pointer.
	 *@param strPointer A unique key assigned by the system that stores the data.  
	 */
	public void setPointer(String strPointer)
	{
		if(strPointer!=null)
			setComponentType(1, strPointer);
		else
			setPointer((ST)null);
	}


	/**
	 *Sets the Pointer.
	 *@param objST A unique key assigned by the system that stores the data. 
	 */
	public void setPointer(ST objST)
	{
		setComponentType(1,objST);
	}

	/**
	 * Sets the ApplicationId.
	 * @param objApplicationId A unique designator of the system that stores the data. 
	 */
	public void setApplicationId(HD objApplicationId)
	{
		setComponentType(2,objApplicationId);
	}

	/**
	 *Sets the TypeOfData.
	 *@param strTypeOfData An ID data type that declares the general type of data.  
	 */
	public void setTypeOfData(String strTypeOfData)
	{
		if(strTypeOfData!=null)
			setComponentType(3, strTypeOfData);
		else
			setTypeOfData((ID)null);
	}

	/**
	 *Sets the TypeOfData.
	 *@param objID An ID data type that declares the general type of data. 
	 */
	public void setTypeOfData(ID objID)
	{
		setComponentType(3,objID);
	}

	/**
	 *Sets the Subtype.
	 *@param strSubtype An ID data type declaring the format for the data of subcomponent 
	 */
	public void setSubtype(String strSubtype)
	{
		if(strSubtype!=null)
			setComponentType(4, strSubtype);
		else
			setSubtype((ID)null);
	}

	/**
	 *Sets the Subtype.
	 *@param objID An ID data type declaring the format for the data of subcomponent
	 */
	public void setSubtype(ID objID)
	{
		setComponentType(4,objID);
	}

	/**
	 * Returns Pointer
	 * @return ST - data type.
	 */
	public ST getPointer()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(1);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ST)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns Application ID
	 * @return HD - data type.
	 */
	public HD getApplicationID()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(2);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (HD)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns Type of Data
	 * @return ID - data type.
	 */
	public ID getTypeOfData()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(3);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ID)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * Returns Subtype
	 * @return ID - data type.
	 */
	public ID getSubtype()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(4);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (ID)objDataCollection.elementAt(0);
		else
			return null;
	}

	/**
	 * This method checks the equality of Object.
	 * @param objObject object of Object class.
	 * @return boolean - shows success or failure of the comparison.
	 */
	public boolean equals(Object objObject)
	{
		if((objObject == null ) || (!(objObject instanceof RP)))
			return false;

		if(this.getPointer() == null)
		{
			if(((RP)objObject).getPointer() != null)
				return false;
		}
		else if(false == (this.getPointer().equals(((RP)objObject).getPointer())))
			return false;

		if(this.getApplicationID() == null)
		{
			if(((RP)objObject).getApplicationID() != null)
				return false;
		}
		else if(false == (this.getApplicationID().equals(((RP)objObject).getApplicationID())))
			return false;

		if(this.getTypeOfData() == null)
		{
			if(((RP)objObject).getTypeOfData() != null)
				return false;
		}
		else if(false == (this.getTypeOfData().equals(((RP)objObject).getTypeOfData())))
			return false;

		if(this.getSubtype() == null)
		{
			if(((RP)objObject).getSubtype() != null)
				return false;
		}
		else if(false == (this.getSubtype().equals(((RP)objObject).getSubtype())))
			return false;

		return true;
	}
}
