/*******************************************************************************
 *  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;

/**
 * RCD - Row column definition<p>
 * This data type specifies the format of a column in terms of a segment field name, a data type, and a maximum length.
 * <p>Represents an HL7 RCD data type. 
 * This data type has the following attributes:</p><p>
 *  1. Segment Field Name (ST)<b>Optional</b><br>
 *  2. HL7 Data Type (ID)<b>Optional</b><br>
 *  3. Maximum Column Width (NM)<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 RCD extends CompositeDataType    
{
	


	/**
	 * Default Constructor for RCD
	 */
	public RCD()
	{
		super(EnumDataType.HL7_DT_RCD);
		 
	}

	/**
	 * 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 RCD(int iMinLength, int iMaxLength, String strCLength,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_RCD);
		this.iMinLength = iMinLength;
		this.iMaxLength = iMaxLength;
		this.iConformanceLength = strCLength;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}


	/**
	 * Constructor for RCD 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 RCD(int iMinLength, int iMaxLength, String strCLength,int iTableNo,int iComponentType) throws InvalidComponentTypeException
	{
		super(EnumDataType.HL7_DT_RCD);
		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 RCD 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 RCD(int iComponentType,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RCD);
		this.objIDataTypeMap = objIDataTypeMap;
		this.iComponentType = iComponentType;
		if(!isValidComponentType())
		{
			throw new InvalidComponentTypeException(this.getClass().getSimpleName());
		}
	}
	/**
	 * Constructor for RCD 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 RCD(int iComponentType,int iMinLength, int iMaxLength, String strCLength,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RCD);
		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 RCD 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 RCD(int iComponentType,int iMinLength, int iMaxLength, String strCLength,int ITableNo,IDataTypeMap objIDataTypeMap)
	{
		super(EnumDataType.HL7_DT_RCD);
		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 SegmentFieldName.
	 *@param strSegmentFieldName identifies the field occupying the column.  
	 */
	public void setSegmentFieldName(String strSegmentFieldName)
	{
		if(strSegmentFieldName!=null)
			setComponentType(1, strSegmentFieldName);
		else
			setSegmentFieldName((ST)null);
	}


	/**
	 *Sets the SegmentFieldName.
	 *@param objST identifies the field occupying the column. 
	 */
	public void setSegmentFieldName(ST objST)
	{
		setComponentType(1,objST);
	}

	/**
	 *Sets the HL7DataType.
	 *@param strHL7DataType The two or three character HL7 data type.  
	 */
	public void setHL7DataType(String strHL7DataType)
	{
		if(strHL7DataType!=null)
			setComponentType(2, strHL7DataType);
		else
			setHL7DataType((ID)null);
	}

	/**
	 *Sets the HL7DataType.
	 *@param objID The two or three character HL7 data type. 
	 */
	public void setHL7DataType(ID objID)
	{
		setComponentType(2,objID);
	}

	/**
	 *Sets the MaximumColumnWidth.
	 *@param strMaxColumnWidth The maximum width of the column, as dictated by the responding system. 
	 */
	public void setMaximumColumnWidth(String strMaxColumnWidth)
	{
		if(strMaxColumnWidth!=null)
			setComponentType(3, strMaxColumnWidth);
		else
			setMaximumColumnWidth((NM)null);
	}

	/**
	 *Sets the MaximumColumnWidth.
	 *@param objNM The maximum width of the column, as dictated by the responding system.
	 */
	public void setMaximumColumnWidth(NM objNM)
	{
		setComponentType(3,objNM);
	}

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

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

	/**
	 * Returns Maximum Column Width
	 * @return NM - data type.
	 */
	public NM getMaximumColumnWidth()
	{
		ISingleCollection<IDataType> objDataCollection =getComponentType(3);
		if(objDataCollection != null && objDataCollection.size() != 0) 
			return (NM)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 RCD)))
			return false;

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

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

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

		return true;
	}
}
