/*
Copyright (c) 2011+, HL7, Inc
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this 
   list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.
 * Neither the name of HL7 nor the names of its contributors may be used to 
   endorse or promote products derived from this software without specific 
   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.

*/

package org.hl7.fhir.dstu3.model;

/**
 * Primitive type "date" in FHIR: any day in a gregorian calendar
 */
import java.util.*;

import org.apache.commons.lang3.Validate;

import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.api.annotation.DatatypeDef;

/**
 * Represents a FHIR date datatype. Valid precisions values for this type are:
 * <ul>
 * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#YEAR}
 * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#MONTH}
 * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#DAY}
 * </ul>
 */
@DatatypeDef(name = "date")
public class DateType extends BaseDateTimeType {

        private static final long serialVersionUID = 3L;
        
        /**
         * The default precision for this type
         */
        public static final TemporalPrecisionEnum DEFAULT_PRECISION = TemporalPrecisionEnum.DAY;

        /**
         * Constructor
         */
        public DateType() {
                super();
        }

        /**
         * Constructor which accepts a date value and uses the {@link #DEFAULT_PRECISION} for this type
         */
        public DateType(Date theDate) {
                super(theDate, DEFAULT_PRECISION);
        }

        /**
         * Constructor which accepts a date value and a precision value. Valid precisions values for this type are:
         * <ul>
         * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#YEAR}
         * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#MONTH}
         * <li>{@link ca.uhn.fhir.model.api.TemporalPrecisionEnum#DAY}
         * </ul>
         *
         * @throws ca.uhn.fhir.parser.DataFormatException
         *             If the specified precision is not allowed for this type
         */
        public DateType(Date theDate, TemporalPrecisionEnum thePrecision) {
                super(theDate, thePrecision);
        }

        /**
         * Constructor which accepts a date as a string in FHIR format
         *
         * @throws ca.uhn.fhir.parser.DataFormatException
         *             If the precision in the date string is not allowed for this type
         */
        public DateType(String theDate) {
                super(theDate);
        }

        /**
         * Constructor which accepts a date value and uses the {@link #DEFAULT_PRECISION} for this type.
         */
        public DateType(Calendar theCalendar) {
                super(theCalendar.getTime(), DEFAULT_PRECISION);
                setTimeZone(theCalendar.getTimeZone());
        }

        /**
         * Constructor which accepts a date value and uses the {@link #DEFAULT_PRECISION} for this type.
         * <p>
         * <b>Use caution when using this constructor</b>: The month is 0-indexed but the day is 1-indexed 
         * in order to match the bahaviour of the Java {@link Calendar} type.
         * </p>
         * 
         * @param theYear The year, e.g. 2015
         * @param theMonth The month, e.g. 0 for January
         * @param theDay The day (1 indexed) e.g. 1 for the first day of the month
         */
        public DateType(int theYear, int theMonth, int theDay) {
                this(toCalendarZulu(theYear, theMonth, theDay));
        }

        private static GregorianCalendar toCalendarZulu(int theYear, int theMonth, int theDay) {
                Validate.isTrue(theMonth >= 0, "theMonth must be between 0 and 11");
                Validate.isTrue(theMonth <= 11, "theMonth must be between 0 and 11");
                Validate.isTrue(theDay >= 1, "theMonth must be between 0 and 11");
                Validate.isTrue(theDay <= 31, "theMonth must be between 0 and 11");
                
                GregorianCalendar retVal = new GregorianCalendar(TimeZone.getTimeZone("GMT"));
                retVal.set(Calendar.YEAR, theYear);
                retVal.set(Calendar.MONTH, theMonth);
                retVal.set(Calendar.DATE, theDay);
                return retVal;
        }

        @Override
        boolean isPrecisionAllowed(TemporalPrecisionEnum thePrecision) {
                switch (thePrecision) {
                        case YEAR:
                        case MONTH:
                        case DAY:
                                return true;
                        default:
                                return false;
                }
        }

        /**
         * Returns the default precision for this datatype
         *
         * @see #DEFAULT_PRECISION
         */
        @Override
        protected TemporalPrecisionEnum getDefaultPrecisionForDatatype() {
                return DEFAULT_PRECISION;
        }

        @Override
        public DateType copy() {
                return new DateType(getValueAsString());
        }
        
        public static InstantType today() {
                return new InstantType(new Date(), TemporalPrecisionEnum.DAY, TimeZone.getDefault());
        }

        /**
         * Creates a new instance by parsing an HL7 v3 format date time string
         */
        public static DateType parseV3(String theV3String) {
                DateType retVal = new DateType();
                retVal.setValueAsV3String(theV3String);
                return retVal;
        }

        @Override
        public String fhirType() {
                return "date";          
        }
}