Event refactoring
[aquarium] / src / main / scala / gr / grnet / aquarium / computation / data / LatestResourceEventsWorker.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 gr.grnet.aquarium.util.findAndRemoveFromMap
39 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
40 import gr.grnet.aquarium.event.model.resource.ResourceEventModel.FullMutableResourceTypeMap
41
42 /**
43  * This is the mutable cousin of [[gr.grnet.aquarium.computation.data.LatestResourceEventsSnapshot]].
44  *
45  * @param latestEventsMap
46  *
47  * @author Christos KK Loverdos <loverdos@gmail.com>
48  */
49 case class LatestResourceEventsWorker(latestEventsMap: FullMutableResourceTypeMap) {
50
51   /**
52    * The gateway to immutable state.
53    *
54    * @param snapshotTime The relevant snapshot time.
55    * @return A fresh instance of [[gr.grnet.aquarium.computation.data.LatestResourceEventsSnapshot]].
56    */
57   def toImmutableSnapshot(snapshotTime: Long) =
58     LatestResourceEventsSnapshot(latestEventsMap.valuesIterator.toList)
59
60   def updateResourceEvent(resourceEvent: ResourceEventModel): Unit = {
61     latestEventsMap((resourceEvent.resource, resourceEvent.instanceID)) = resourceEvent
62   }
63
64   def findResourceEvent(resource: String, instanceId: String): Option[ResourceEventModel] = {
65     latestEventsMap.get((resource, instanceId))
66   }
67
68   def findAndRemoveResourceEvent(resource: String, instanceId: String): Option[ResourceEventModel] = {
69     findAndRemoveFromMap(latestEventsMap, (resource, instanceId))
70   }
71
72   def size = latestEventsMap.size
73
74   def foreach[U](f: ResourceEventModel => U): Unit = {
75     latestEventsMap.valuesIterator.foreach(f)
76   }
77 }
78
79 object LatestResourceEventsWorker {
80   final val Empty = LatestResourceEventsWorker(scala.collection.mutable.Map())
81
82   /**
83    * Helper factory to construct a worker from a list of events.
84    */
85   def fromList(latestEventsList: List[ResourceEventModel]): LatestResourceEventsWorker = {
86     LatestResourceEventsSnapshot(latestEventsList).toMutableWorker
87   }
88 }
89