package net.sourceforge.finmodel.rules;
   
   import java.math.BigDecimal;
   import java.util.ArrayList;
   import java.util.Calendar;
   import java.util.List;
   
   import org.jfin.date.Frequency;
   import org.jfin.date.Period;
  import org.jfin.date.ScheduleException;
  import org.jfin.date.ScheduleGenerator;
  import org.jfin.date.StubType;
  
  public class PeriodicRule extends RuleImpl implements Rule {
  	public static final long serialVersionUID = 1L;
  	private String freq;
  	private Frequency frequency;
  	private StubType stubType = StubType.SHORT_FIRST;
  	private Period period;
  	private List<Calendar> schedule;
  	
  	public PeriodicRule() {
  		super();
  	}
  	
  	public void setFrequency(Frequency frequency) {
  		Frequency oldFreq = this.frequency;
  		this.frequency = frequency;
  		if (oldFreq != frequency) {
  			notifyScheduleChange();
  			schedule = null;
  		}
  		
  		this.freq = frequency.getTenorDescriptor();
  	}
  
  	public Frequency getFrequency() {
  		return frequency;
  	}
  
  	public void setAmount(BigDecimal amount) {
  		this.amount = amount;
  	}
  	
  	public BigDecimal getAmount() {
  		return this.amount;
  	}
  	
  	/**
  	 * @param freq the freq to set
  	 */
  	protected void setFreq(String freq) {
  		this.freq = freq;
  		setFrequency( Frequency.valueOf(freq) );
  	}
  
  	/**
  	 * @return the freq
  	 */
  	protected String getFreq() {
  		return freq;
  	}
  	public void setStubType(StubType stubType) {
  		StubType oldStubType = this.stubType;
  		this.stubType = stubType;
  		if (oldStubType != stubType) {
  			notifyScheduleChange();
  			schedule = null;
  		}
  	}
  
  	public StubType getStubType() {
  		return stubType;
  	}
  
  	public void setPeriod(Period period) {
  		this.period = period;
  		notifyScheduleChange();
  		schedule = null;
  	}
  
  	public Period getPeriod() {
  		return this.period;
  	}
  	
  	/**
  	 * Returns a list of days for which this rule can generate a Transaction.
  	 */
  	public List<Calendar> getSchedule() throws ScheduleException {
  		if (schedule == null) {
  			List<Period> periods = ScheduleGenerator.generateSchedule(period.getStartCalendar(), period.getEndCalendar(), 
  					getFrequency(), getStubType());
  			schedule = new ArrayList<Calendar>();
  			for (Period period: periods) {
  				schedule.add(period.getStartCalendar());
  			}
  		} 
  		return schedule;
  	}
 }