/*
 Copyright (C) 2008 Srinivas Hasti

 This source code is release under the BSD License.

 This file is part of JQuantLib, a free-software/open-source library
 for financial quantitative analysts and developers - http://jquantlib.org/

 JQuantLib is free software: you can redistribute it and/or modify it
 under the terms of the JQuantLib license.  You should have received a
 copy of the license along with this program; if not, please email
 . The license is also available online at
 .

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the license for more details.

 JQuantLib is based on QuantLib. http://quantlib.org/
 When applicable, the original copyright notice follows this notice.
 */

package org.jquantlib.time.calendars;

import static org.jquantlib.time.Month.April;
import static org.jquantlib.time.Month.August;
import static org.jquantlib.time.Month.December;
import static org.jquantlib.time.Month.January;
import static org.jquantlib.time.Month.June;
import static org.jquantlib.time.Month.May;
import static org.jquantlib.time.Month.November;

import org.jquantlib.lang.annotation.QualityAssurance;
import org.jquantlib.lang.annotation.QualityAssurance.Quality;
import org.jquantlib.lang.annotation.QualityAssurance.Version;
import org.jquantlib.lang.exceptions.LibraryException;
import org.jquantlib.time.Calendar;
import org.jquantlib.time.Date;
import org.jquantlib.time.Month;
import org.jquantlib.time.Weekday;

/**
 *
 * Italian calendars Public holidays:
 * 

 * 
Saturdays
 * 
Sundays
 * 
New Year's Day, JANUARY 1st
 * 
Epiphany, JANUARY 6th
 * 
Easter Monday
 * 
Liberation Day, April 25th
 * 
Labour Day, May 1st
 * 
Republic Day, June 2nd (since 2000)
 * 
Assumption, August 15th
 * 
All Saint's Day, November 1st
 * 
Immaculate Conception Day, December 8th
 * 
Christmas Day, December 25th
 * 
St. Stephen's Day, December 26th
 * 
 *
 * Holidays for the stock exchange (data from http://www.borsaitalia.it):
 * 

 * 
Saturdays
 * 
Sundays
 * 
New Year's Day, JANUARY 1st
 * 
Good Friday
 * 
Easter Monday
 * 
Labour Day, May 1st
 * 
Assumption, August 15th
 * 
Christmas' Eve, December 24th
 * 
Christmas, December 25th
 * 
St. Stephen, December 26th
 * 
New Year's Eve, December 31st
 * 
 *
 * @test the correctness of the returned results is tested against a list of known holidays.
 *
 * @category calendars
 * @see Borsa Italiana
 *
 * @author Srinivas Hasti
 * @author Zahid Hussain
 */

@QualityAssurance(quality = Quality.Q3_DOCUMENTATION, version = Version.V097, reviewers = { "Zahid Hussain" })
public class Italy extends Calendar {

    public static enum Market {
        /**
         * Generic settlement calendar
         */
        Settlement,

        /**
         * Milan stock-exchange calendar
         */
        Exchange
    }


    //
    // public constructors
    //

    public Italy() {
        this(Market.Settlement);
    }

    public Italy(final Market market) {
        switch (market) {
        case Settlement:
            impl = new SettlementImpl();
            break;
        case Exchange:
            impl = new ExchangeImpl();
            break;
        default:
            throw new LibraryException(UNKNOWN_MARKET);
        }
    }


    //
    // private final inner classes
    //

    private final class SettlementImpl extends WesternImpl {
        @Override
        public String name() {
            return "Italian settlement";
        }

        @Override
        public boolean isBusinessDay(final Date date) {
            final Weekday w = date.weekday();
            final int d = date.dayOfMonth(), dd = date.dayOfYear();
            final Month m = date.month();
            final int y = date.year();
            final int em = easterMonday(y);
            if (isWeekend(w)
            // New Year's Day
                    || (d == 1 && m == January)
                    // Epiphany
                    || (d == 6 && m == January)
                    // Easter Monday
                    || (dd == em)
                    // Liberation Day
                    || (d == 25 && m == April)
                    // Labour Day
                    || (d == 1 && m == May)
                    // Republic Day
                    || (d == 2 && m == June && y >= 2000)
                    // Assumption
                    || (d == 15 && m == August)
                    // All Saints' Day
                    || (d == 1 && m == November)
                    // Immaculate Conception
                    || (d == 8 && m == December)
                    // Christmas
                    || (d == 25 && m == December)
                    // St. Stephen
                    || (d == 26 && m == December)
                    // DECEMBER 31st, 1999 only
                    || (d == 31 && m == December && y == 1999)) {
                return false;
            }
            return true;
        }
    }

    private final class ExchangeImpl extends WesternImpl {
        @Override
        public String name() {
            return "Milan stock exchange";
        }

        @Override
        public boolean isBusinessDay(final Date date) {
            final Weekday w = date.weekday();
            final int d = date.dayOfMonth(), dd = date.dayOfYear();
            final Month m = date.month();
            final int y = date.year();
            final int em = easterMonday(y);
            if (isWeekend(w)
            // New Year's Day
                    || (d == 1 && m == January)
                    // Good Friday
                    || (dd == em - 3)
                    // Easter Monday
                    || (dd == em)
                    // Labour Day
                    || (d == 1 && m == May)
                    // Assumption
                    || (d == 15 && m == August)
                    // Christmas' Eve
                    || (d == 24 && m == December)
                    // Christmas
                    || (d == 25 && m == December)
                    // St. Stephen
                    || (d == 26 && m == December)
                    // New Year's Eve
                    || (d == 31 && m == December)) {
                return false;
            }
            return true;
        }
    }
}