/*******************************************************************************
 *  Copyright 2017-2018 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.dcm30_04.baselibs;

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumCollimatorShape;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
/**
* This item class contains the methods to set, get and validate the attribute present in Collimator Shape Sequence.
 */


public class CollimatorShapeSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	CollimatorShapeSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	CollimatorShapeSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates CollimatorShapeSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	CollimatorShapeSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in CollimatorShapeSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try{
			if(getDataForTag(0x0018, 0x1700).getValue().equals(EnumCollimatorShape.RECTANGULAR)){
				if(!contains(0x0018,0x1702))
					throw new MandatoryMissingException("0x0018,0x1702");
				if(!contains(0x0018,0x1704))
					throw new MandatoryMissingException("0x0018,0x1704");
				if(!contains(0x0018,0x1706))
					throw new MandatoryMissingException("0x0018,0x1706");
				if(!contains(0x0018,0x1708))
					throw new MandatoryMissingException("0x0018,0x1708");
			}
			if(getDataForTag(0x0018, 0x1700).getValue().equals(EnumCollimatorShape.CIRCULAR)){
				if(!contains(0x0018,0x1710))
					throw new MandatoryMissingException("0x0018,0x1710");
				if(!contains(0x0018,0x1712))
					throw new MandatoryMissingException("0x0018,0x1712");
			}
			if(getDataForTag(0x0018, 0x1700).getValue().equals(EnumCollimatorShape.POLYGONAL)){
				if(!contains(0x0018,0x1720))
					throw new MandatoryMissingException("0x0018,0x1720");
			}
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets type Collimator Shape.
	 * Shape(s) of the collimator.
	 * Defined Terms:
	 * 1) RECTANGULAR.
	 * 2) CIRCULAR.
	 * 3) POLYGONAL.
	 * @param enumCollimatorShape -enum value of Collimator Shape.
	 */
	public void setCollimatorShape(EnumCollimatorShape enumCollimatorShape)
	{
		/* Accept the Collimator Shape in String format of type CS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1700, enumCollimatorShape.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1700,DicomConstants.DCM_DT_CS, enumCollimatorShape.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Collimator Shape. 
	 * Shape(s) of the collimator.
	 * @return String - value of Collimator Shape.
	 */
	public String getCollimatorShape()
	{
		Object objValue = getValue(0x0018,0x1700);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Collimator Left Vertical Edge.
	 * @param strCollimatorLeftVerticalEdge String value of Collimator Left Vertical Edge.
	 */
	public void setCollimatorLeftVerticalEdge(String strCollimatorLeftVerticalEdge )
	{
		/*Accept the Collimator Left Vertical Edge in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1702, strCollimatorLeftVerticalEdge ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1702,DicomConstants.DCM_DT_IS, strCollimatorLeftVerticalEdge );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Collimator Left Vertical Edge.
	 * @return String - value of Collimator Left Vertical Edge.
	 */
	public String getCollimatorLeftVerticalEdge()
	{
		Object objValue = getValue(0x0018,0x1702);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Collimator Right Vertical Edge.
	 * @param strCollimatorRightVerticalEdge String value of Collimator Right Vertical Edge.
	 */
	public void setCollimatorRightVerticalEdge(String strCollimatorRightVerticalEdge )
	{
		/*Accept the Collimator Right Vertical Edge in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1704, strCollimatorRightVerticalEdge ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1704,DicomConstants.DCM_DT_IS, strCollimatorRightVerticalEdge );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Collimator Right Vertical Edge.
	 * @return String - value of Collimator Right Vertical Edge.
	 */
	public String getCollimatorRightVerticalEdge()
	{
		Object objValue = getValue(0x0018,0x1704);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Collimator Upper Horizontal Edge.
	 * @param strCollimatorUpperHorizontalEdge String value of Collimator Upper Horizontal Edge.
	 */
	public void setCollimatorUpperHorizontalEdge(String strCollimatorUpperHorizontalEdge )
	{
		/*Accept the Collimator Upper Horizontal Edge in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1706, strCollimatorUpperHorizontalEdge ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1706,DicomConstants.DCM_DT_IS, strCollimatorUpperHorizontalEdge );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Collimator Upper Horizontal Edge.
	 * @return String - value of Collimator Upper Horizontal Edge.
	 */
	public String getCollimatorUpperHorizontalEdge()
	{
		Object objValue = getValue(0x0018,0x1706);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Collimator Lower Horizontal Edge.
	 * @param strCollimatorLowerHorizontalEdge String value of Collimator Lower Horizontal Edge.
	 */
	public void setCollimatorLowerHorizontalEdge(String strCollimatorLowerHorizontalEdge )
	{
		/*Accept the Collimator Lower Horizontal Edge in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1708, strCollimatorLowerHorizontalEdge ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1708,DicomConstants.DCM_DT_IS, strCollimatorLowerHorizontalEdge );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Collimator Lower Horizontal Edge.
	 * @return String - value of Collimator Lower Horizontal Edge.
	 */
	public String getCollimatorLowerHorizontalEdge()
	{
		Object objValue = getValue(0x0018,0x1708);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Center of Circular Collimator.
	 * @param strCenterofCircularCollimator String value of Center of Circular Collimator.
	 */
	public void setCenterofCircularCollimator(String[] strCenterofCircularCollimator )
	{
		/*Accept the Center of Circular Collimator in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1710, strCenterofCircularCollimator ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1710,DicomConstants.DCM_DT_IS, strCenterofCircularCollimator );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Center of Circular Collimator.
	 * @return String - value of Center of Circular Collimator.
	 */
	public String[] getCenterofCircularCollimator()
	{
		Object objValue = getValue(0x0018,0x1710);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Sets Radius of Circular Collimator.
	 * @param strRadiusofCircularCollimator String value of Radius of Circular Collimator.
	 */
	public void setRadiusofCircularCollimator(String strRadiusofCircularCollimator )
	{
		/*Accept the Radius of Circular Collimator in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1712, strRadiusofCircularCollimator ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1712,DicomConstants.DCM_DT_IS, strRadiusofCircularCollimator );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Radius of Circular Collimator.
	 * @return String - value of Radius of Circular Collimator.
	 */
	public String getRadiusofCircularCollimator()
	{
		Object objValue = getValue(0x0018,0x1712);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Vertices of the Polygonal Collimator.
	 * @param strVerticesofthePolygonalCollimator String value of Vertices of the Polygonal Collimator.
	 */
	public void setVerticesofthePolygonalCollimator(String[] strVerticesofthePolygonalCollimator )
	{
		/*Accept the Vertices of the Polygonal Collimator in String format of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x1720, strVerticesofthePolygonalCollimator ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1720,DicomConstants.DCM_DT_IS, strVerticesofthePolygonalCollimator );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Vertices of the Polygonal Collimator.
	 * @return String - value of Vertices of the Polygonal Collimator.
	 */
	public String[] getVerticesofthePolygonalCollimator()
	{
		Object objValue = getValue(0x0018,0x1720);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
}
