/*******************************************************************************
 *  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.exceptions.ConditionFailedException;
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 Image Center Point Coordinates Sequence Item
 */
public class ImageCenterPointCoordinatesSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ImageCenterPointCoordinatesSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	ImageCenterPointCoordinatesSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates Image Center Point Coordinates Sequence Item with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ImageCenterPointCoordinatesSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Sets The X offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if Sequence item is present.
	 * @param strXOffsetInSlideCoordinateSystem String value of X offset in Slide Coordinate System.
	 */
	public void setXOffsetInSlideCoordinateSystem(String strXOffsetInSlideCoordinateSystem)
	{
		/* Accept the X offset in Slide Coordinate System of type DS.
		 * 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(0x0040,0x072A,strXOffsetInSlideCoordinateSystem,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0040,0x072A,DicomConstants.DCM_DT_DS, strXOffsetInSlideCoordinateSystem);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves The X offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if the Image Center Point Coordinates Sequence item is present.
	 * @return String - value of  X offset in Slide Coordinate System.
	 */
	public String getXOffsetInSlideCoordinateSystem()
	{
		Object objValue = getValue(0x0040,0x072A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets The Y offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if Sequence item is present.
	 * @param strYOffsetInSlideCoordinateSystem String value of Y offset in Slide Coordinate System.
	 */
	public void setYOffsetInSlideCoordinateSystem(String strYOffsetInSlideCoordinateSystem)
	{
		/* Accept the Y offset in Slide Coordinate System of type DS.
		 * 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(0x0040,0x073A,strYOffsetInSlideCoordinateSystem,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0040,0x073A,DicomConstants.DCM_DT_DS, strYOffsetInSlideCoordinateSystem);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves The Y offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if the Image Center Point Coordinates Sequence item is present.
	 * @return String - value of  Y offset in Slide Coordinate System.
	 */
	public String getYOffsetInSlideCoordinateSystem()
	{
		Object objValue = getValue(0x0040,0x073A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets The Z offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if Sequence item is present.
	 * @param strZOffsetInSlideCoordinateSystem String value of Z offset in Slide Coordinate System.
	 */
	public void setZOffsetInSlideCoordinateSystem(String strZOffsetInSlideCoordinateSystem)
	{
		/* Accept the Z offset in Slide Coordinate System of type DS.
		 * 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(0x0040,0x074A,strZOffsetInSlideCoordinateSystem,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0040,0x074A,DicomConstants.DCM_DT_DS, strZOffsetInSlideCoordinateSystem);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves The Z offset in millimeters from the Origin of the Slide Coordinate System.
	 * Required if the Image Center Point Coordinates Sequence item is present.
	 * @return String - value of  Z offset in Slide Coordinate System.
	 */
	public String getZOffsetInSlideCoordinateSystem()
	{
		Object objValue = getValue(0x0040,0x074A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in {@link ImageCenterPointCoordinatesSequenceItem} 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(!contains(0x0040,0x072A))
				throw new ConditionFailedException("0040,072A Required if sequence item is present.");
			if(!contains(0x0040,0x073A))
				throw new ConditionFailedException("0040,073A Required if sequence item is present.");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		catch( ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}
}
