/*******************************************************************************
 *  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.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
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 Navigation Indicator Sequence .
 */

public class NavigationIndicatorSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	NavigationIndicatorSequenceItem()
	{
		super();
	}


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

	/**
	 * This constructor creates NavigationIndicatorSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	NavigationIndicatorSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in FillStyleSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0072,0x0218))
				throw new MandatoryMissingException("0072,0218") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	public void setNavigationDisplaySet(short[] arrNavigationDisplaySet)
	{
		/* Accept the Navigation Display Set in Array of short format of type US.
		 * the graphical representation may indicate either the number of slices displayed 
		 * or contained in the Reference Display Set(s).
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0072, 0x0216, arrNavigationDisplaySet,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072, 0x0216,DicomConstants.DCM_DT_US, arrNavigationDisplaySet);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Display Sets is indicated on or controlled by the Navigation Display Set.
	 * @return short Array - frames in a Multi-frame SOP Instance.
	 */
	public short[] getNavigationDisplaySet()
	{
		Object objValue = getValue(0x0072, 0x0216);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}

	public void setReferenceDisplaySets(short[] arrReferenceDisplaySets)
	{
		/* Accept the Navigation Display Set in Array of short format of type US.
		 * One or more Display Set Number (0072,0202) values.
		 * If Navigation Display Set is present, shall list those Display Sets that are controlled by or indicated on the Navigation Display Set.
		 * If Navigation Display Set is absent, shall indicate that all of the Reference Display Sets cross-reference each other.
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0072, 0x0218, arrReferenceDisplaySets,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072, 0x0218,DicomConstants.DCM_DT_US, arrReferenceDisplaySets);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Reference Display Sets is indicated on or controlled by the Navigation Display Set.
	 * @return short Array - frames in a Multi-frame SOP Instance.
	 */
	public short[] getReferenceDisplaySets()
	{
		Object objValue = getValue(0x0072, 0x0218);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}


}
