First cut of the new policy configuration system
[aquarium] / src / main / scala / gr / grnet / aquarium / logic / accounting / algorithm / SimpleExecutableCostPolicyAlgorithm.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.logic.accounting.algorithm
37
38
39 import com.ckkloverdos.maybe.Maybe
40 import gr.grnet.aquarium.logic.accounting.dsl._
41 import gr.grnet.aquarium.AquariumException
42
43 /**
44  * An executable charging algorithm with some simple implementation.
45  *
46  * @author Christos KK Loverdos <loverdos@gmail.com>
47  */
48 object SimpleExecutableCostPolicyAlgorithm extends ExecutableCostPolicyAlgorithm {
49
50   @inline private[this]
51   def hrs(millis: Double) = millis / 1000 / 60 / 60
52
53   def apply(vars: Map[DSLCostPolicyVar, Any]): Double = {
54     vars.apply(DSLCostPolicyNameVar) match {
55       case DSLCostPolicyNames.continuous ⇒
56         val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
57         val oldTotalAmount = vars(DSLOldTotalAmountVar).asInstanceOf[Double]
58         val timeDelta = vars(DSLTimeDeltaVar).asInstanceOf[Double]
59
60         hrs(timeDelta) * oldTotalAmount * unitPrice
61
62       case DSLCostPolicyNames.discrete ⇒
63         val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
64         val currentValue = vars(DSLCurrentValueVar).asInstanceOf[Double]
65
66         currentValue * unitPrice
67
68       case DSLCostPolicyNames.onoff ⇒
69         val unitPrice = vars(DSLUnitPriceVar).asInstanceOf[Double]
70         val timeDelta = vars(DSLTimeDeltaVar).asInstanceOf[Double]
71
72         hrs(timeDelta) * unitPrice
73
74       case DSLCostPolicyNames.once ⇒
75         val currentValue = vars(DSLCurrentValueVar).asInstanceOf[Double]
76         currentValue
77
78       case name ⇒
79         throw new AquariumException("Unknown cost policy %s".format(name))
80     }
81   }
82
83   override def toString = "SimpleExecutableCostPolicyAlgorithm(%s)".format(
84     Map(
85       DSLCostPolicyNames.continuous -> "hrs(timeDelta) * oldTotalAmount * unitPrice",
86       DSLCostPolicyNames.discrete   -> "currentValue * unitPrice",
87       DSLCostPolicyNames.onoff      -> "hrs(timeDelta) * unitPrice",
88       DSLCostPolicyNames.once       -> "currentValue"))
89 }