/*
 Copyright (C) 2011 Tim Blackler

 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.indexes;

import org.jquantlib.QL;
import org.jquantlib.Settings;
import org.jquantlib.currencies.Currency;
import org.jquantlib.lang.annotation.Rate;
import org.jquantlib.lang.annotation.Real;
import org.jquantlib.quotes.Handle;
import org.jquantlib.termstructures.InflationTermStructure;
import org.jquantlib.termstructures.YoYInflationTermStructure;
import org.jquantlib.time.Date;
import org.jquantlib.time.Frequency;
import org.jquantlib.time.Period;
import org.jquantlib.time.TimeUnit;
import org.jquantlib.util.Pair;

/**
 * Base class for year-on-year inflation indices.
 *
 * These may be genuine indices published on, say, Bloomberg, or
 * "fake" indices that are defined as the ratio of an index at
 * different time points. 
 * 
 * @author Tim Blackler
 *
 */
// TODO: code review :: please verify against QL/C++ code
// TODO: code review :: license, class comments, comments for access modifiers, comments for @Override
public abstract class YoYInflationIndex extends InflationIndex {
    
    private Handle yoyInflation;
    private boolean ratio;
    
    public YoYInflationIndex(final String familyName,
			 final Region region,
			 final boolean revised,
			 final boolean interpolated,
			 final boolean ratio, // is this one a genuine index or a ratio?
			 final Frequency frequency,
			 final Period availabilityLag,
			 final Currency currency) {
    	this(familyName, region, revised, interpolated, ratio, frequency, availabilityLag, currency, new Handle());
  	
    }
    
    public YoYInflationIndex(final String familyName,
            				 final Region region,
            				 final boolean revised,
            				 final boolean interpolated,
            				 final boolean ratio, // is this one a genuine index or a ratio?
            				 final Frequency frequency,
            				 final Period availabilityLag,
            				 final Currency currency,
            				 final Handle yoyInflation) {
    	super(familyName, region, revised, interpolated, frequency, availabilityLag, currency);
    	this.ratio = ratio;
    	this.yoyInflation = yoyInflation;
    	this.yoyInflation.addObserver(this);	
    }
 
    @Override
    public double fixing(Date fixingDate) {
    	return this.fixing(fixingDate, false);
    }	
    
    @Override
    public double fixing(Date fixingDate, boolean forecastTodaysFixing) {
    	Date today = new Settings().evaluationDate();
    	Date todayMinusLag = today.sub(availabilityLag);
    	
    	Pair lim = InflationTermStructure.inflationPeriod(todayMinusLag, frequency);
    	todayMinusLag = lim.second().inc();
    	
    	if ((fixingDate.lt(todayMinusLag)) ||
    		(fixingDate.eq(todayMinusLag) && !forecastTodaysFixing)) {
    		
    		@Real double pastFixing = IndexManager.getInstance().getHistory(name()).get(fixingDate);
    		QL.require(!(Double.isNaN(pastFixing)) , "Missing " + name() + " fixing for " + fixingDate);
    		
    		Date previousDate = fixingDate.sub(new Period(1,TimeUnit.Years));
    		@Rate double previousFixing = IndexManager.getInstance().getHistory(name()).get(previousDate);
    		QL.require(!(Double.isNaN(pastFixing)) , "Missing " + name() + " fixing for " + previousFixing);

    		return pastFixing/previousFixing - 1.0;
    		
    	} else {
    		return forecastFixing(fixingDate);
    	}
    }    
    
    public Handle yoyInflationTermStructure() {
    	return yoyInflation;
    }
    
    public boolean ratio() {
        return ratio;
    }
    
    private /* @Rate */ double forecastFixing(final Date fixingDate) {
        // if the value is not interpolated get the value for
        // half way along the period.
        Date d = fixingDate;
        
        if (!interpolated()) {
            Pair lim = InflationTermStructure.inflationPeriod(fixingDate, frequency);
            int n = (int)(lim.second().sub(lim.first())) / 2;
    		d = lim.first().add(n);
        }

        return yoyInflation.currentLink().yoyRate(d);
    }
       
}