Fix all serialization to YAML issues
[aquarium] / src / main / scala / gr / grnet / aquarium / logic / accounting / dsl / DSLResource.scala
1 /*
2  * Copyright 2011 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.dsl
37
38 /**
39  * Represents a chargable resource.
40  *
41  * @author Georgios Gousios <gousiosg@gmail.com>
42  */
43 sealed abstract class DSLResource (
44   /** Name of resource */
45   val name: String,
46
47   /** Informative name for resource charging unit*/
48   val unit: String,
49
50   /** Algorithm used to calculate costs */
51   val costpolicy: DSLCostPolicy
52 ) extends DSLItem {
53   def isComplex: Boolean
54   
55   override def toMap(): Map[String, Any] =
56     Map(Vocabulary.name -> name) ++
57     Map(Vocabulary.unit -> unit) ++
58     Map(Vocabulary.costpolicy -> costpolicy.name) ++
59     Map(Vocabulary.complex -> isComplex)
60 }
61
62 /**
63  * A complex resource can have many chargable instances, separated through
64  * a descriminator field.
65  */
66 case class DSLComplexResource (
67   /**Name of resource */
68   override val name: String,
69
70   /**Informative name for resource charging unit*/
71   override val unit: String,
72
73   /**Algorithm used to calculate costs */
74   override val costpolicy: DSLCostPolicy,
75
76   /**Name of field used to describe a unique instance of the resource*/
77   descriminatorField: String
78 ) extends DSLResource(name, unit, costpolicy) {
79   override def isComplex = true
80
81   override def toMap(): Map[String, Any] =
82     super.toMap ++ Map(Vocabulary.descriminatorfield -> descriminatorField)
83 }
84
85 /**
86  * A simple resource can only have a single chargable instance.
87  */
88 case class DSLSimpleResource (
89   /**Name of resource */
90   override val name: String,
91
92   /**Informative name for resource charging unit*/
93   override val unit: String,
94
95   /**Algorithm used to calculate costs */
96   override val costpolicy: DSLCostPolicy
97 ) extends DSLResource(name, unit, costpolicy) {
98   override def isComplex = false
99 }
100