code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/computation/data/AgreementHistory.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.computation.data
  37
  38 import java.util.Date
  39
  40 import gr.grnet.aquarium.logic.accounting.dsl.{DSLAgreement, Timeslot}
  41 import gr.grnet.aquarium.logic.accounting.Policy
  42 import scala.collection.immutable.{SortedMap, TreeMap}
  43
  44 /**
  45  * User agreement data that will be part of UserState.
  46  * The provided list of agreements cannot have time gaps. This is checked at object creation type.
  47  *
  48  * @author Christos KK Loverdos <loverdos@gmail.com>
  49  */
  50
  51 case class AgreementHistory(agreements: List[AgreementHistoryItem]) {
  52   ensureNoGaps(agreements.sortWith((a,b) => if (b.validFrom > a.validFrom) true else false))
  53
  54   def ensureNoGaps(agreements: List[AgreementHistoryItem]): Unit = agreements match {
  55     case ha :: (t @ (hb :: tail)) =>
  56       assert(ha.validTo - hb.validFrom == 1);
  57       ensureNoGaps(t)
  58     case h :: Nil =>
  59       assert(h.validTo == Long.MaxValue)
  60     case Nil => ()
  61   }
  62
  63   def agreementNamesByTimeslot: SortedMap[Timeslot, String] = {
  64     TreeMap(agreements.map(ag ⇒ (ag.timeslot, ag.name)): _*)
  65   }
  66
  67   def agreementsByTimeslot: SortedMap[Timeslot, AgreementHistoryItem] = {
  68     TreeMap(agreements.map(ag ⇒ (ag.timeslot, ag)): _*)
  69   }
  70
  71   /**
  72    * Get the user agreement at the specified timestamp
  73    */
  74   def findForTime(at: Long): Option[DSLAgreement] = {
  75     // FIXME: Refactor and do not make this static call to Policy
  76     agreements.find{ x => x.validFrom < at && x.validTo > at} match {
  77       case Some(x) => Policy.policy(new Date(at)).findAgreement(x.name)
  78       case None => None
  79     }
  80   }
  81
  82   /**
  83    * Returns the first, chronologically, agreement.
  84    */
  85   def firstAgreement: Option[AgreementHistoryItem] = {
  86     agreementsByTimeslot.valuesIterator.toList.lastOption
  87   }
  88
  89   /**
  90    * Returns the name of the first, chronologically, agreement.
  91    */
  92   def firstAgreementName: Option[String] = {
  93     agreementNamesByTimeslot.valuesIterator.toList.lastOption
  94   }
  95
  96   /**
  97    * Returns the last, chronologically, agreement.
  98    */
  99   def lastAgreement: Option[AgreementHistoryItem] = {
 100     agreementsByTimeslot.valuesIterator.toList.headOption
 101   }
 102
 103   /**
 104    * Returns the name of the last, chronologically, agreement.
 105    */
 106   def lastAgreementName: Option[String] = {
 107     agreementNamesByTimeslot.valuesIterator.toList.headOption
 108   }
 109 }
 110
 111 object AgreementHistory {
 112   final val Empty = AgreementHistory(Nil)
 113
 114   def initial(agreement: String, validFrom: Long): AgreementHistory ={
 115     AgreementHistory(AgreementHistoryItem(agreement, validFrom) :: Nil)
 116   }
 117 }