2 * Copyright 2011-2012 GRNET S.A. All rights reserved.
4 * Redistribution and use in source and binary forms, with or
5 * without modification, are permitted provided that the following
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
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.
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.
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.
36 package gr.grnet.aquarium.logic.accounting.dsl
39 import scala.collection.mutable
40 import annotation.tailrec
41 import gr.grnet.aquarium.util.date.MutableDateCalc
42 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
45 * A representation of a timeslot with a start and end date.
47 * @author Georgios Gousios <gousiosg@gmail.com>
49 final case class Timeslot(from: Date, to: Date)
50 extends DSLItem with Ordered[Timeslot] {
52 /* Preconditions to ensure correct object creations */
55 assert(start <= end, "from = %s, to = %s".format(new MutableDateCalc(from), new MutableDateCalc(to)))
57 def startsBefore(t: Timeslot) : Boolean = start < t.start
59 def startsAfter(t: Timeslot) : Boolean = start > t.start
61 def endsBefore(t: Timeslot) : Boolean = end < t.end
63 def endsAfter(t: Timeslot) : Boolean = end > t.end
65 def after(t: Timeslot): Boolean = start > t.end
67 def before(t: Timeslot): Boolean = end < t.start
69 def start : Long = this.from.getTime
71 def end : Long = this.to.getTime
74 * Check whether this time slot fully contains the provided one.
76 def contains(t: Timeslot) : Boolean = this.start <= t.start && this.end >= t.end
79 def containsTimeInMillis(millis: Long) = start <= millis && millis <= end
83 * Check whether this timeslot contains the provided time instant.
85 private[dsl] def includes(t: Date) : Boolean = start <= t.getTime && t.getTime <= end
89 * Check whether this timeslot overlaps with the provided one.
91 def overlaps(t: Timeslot) : Boolean =
92 contains(t) || t.contains(this) || this.includes(t.from) || this.includes(t.to)
96 * Merges this timeslot with the provided one. If the timeslots overlap,
97 * a list with the resulting merge is returned. If the timeslots do not
98 * overlap, the returned list contains both timeslots in increasing start
101 def merge(t: Timeslot) : Timeslot = {
102 assert(overlaps(t),this +" has no overlap with " + t)
103 val nfrom = if (start < t.start) from else t.from
104 val nto = if (end > t.end) to else t.to
109 * Split the timeslot in two parts at the provided timestamp, if the
110 * timestamp falls within the timeslot boundaries.
112 def slice(d: Date) : List[Timeslot] =
113 if (includes(d) && d.getTime != start && d.getTime != end)
114 List(Timeslot(from, d), Timeslot(d,to))
120 * Find and return the timeslots within which this Timeslot overrides
121 * with the provided list of timeslots. For example if:
123 * - `this == Timeslot(7,20)`
124 * - `list == List(Timeslot(1,3), Timeslot(6,8), Timeslot(11,15))`
126 * the result will be: `List(Timeslot(7,8), Timeslot(11,15))`
128 def overlappingTimeslots(list: List[Timeslot]) : List[Timeslot] =
129 list.foldLeft(List[Timeslot]()) { (ret,t) =>
130 if (t.contains(this)) this :: ret
131 else if (this.contains(t)) t :: ret
132 else if (t.overlaps(this) && t.startsBefore(this)) slice(t.to).head :: ret
133 else if (t.overlaps(this) && t.startsAfter(this)) slice(t.from).last :: ret
139 * Find and return the timeslots whithin which this Timeslot does not
140 * override with the provided list of timeslots. For example if:
142 * - `this == Timeslot(7,20)`
143 * - `list == List(Timeslot(1,3), Timeslot(6,8), Timeslot(11,15))`
145 * the result will be: `List(Timeslot(9,10), Timeslot(15,20))`
147 def nonOverlappingTimeslots(list: List[Timeslot]): List[Timeslot] =
148 overlappingTimeslots(list) sortWith {_.start < _.start} match {
149 case Nil => List(this)
151 val (head,last) = (over.head,over.last)
152 val hd = if (head.start > this.start) List(Timeslot(this.from, head.from)) else List()
153 val tl = if (last.end < this.end) List(Timeslot(last.to, this.to)) else List()
154 hd ++ over.tail.foldLeft((List[Timeslot](),over.head)) {
155 case ((l,x),y) => (l ++ List(Timeslot(x.to, y.from)),y)
160 * Align a list of consecutive timeslots to the boundaries
161 * defined by this timeslot. Elements that do not overlap
162 * with this timeslot are rejected, while elements not
163 * contained in the timeslot are trimmed to this timeslot's
164 * start and end time.
166 def align(l: List[Timeslot]): List[Timeslot] = {
167 if (l.isEmpty) return List()
169 val result : Option[Timeslot] =
170 if (!this.overlaps(l.head)) None
171 else if (l.head.contains(this)) Some(this)
172 else if (l.head.startsBefore(this)) Some(Timeslot(this.from, l.head.to))
173 else if (l.head.endsAfter(this)) Some(Timeslot(l.head.from, this.to))
177 case Some(x) => x :: align(l.tail)
178 case None => align(l.tail)
182 /* align a time slot in "bound_size" boundaries so that
183 * start0 <= start and end0 >= end */
184 def align(bound_size : Long) : Timeslot = {
185 val start0 = (start / bound_size) * bound_size
186 val add_one = if (end % bound_size == 0) 0 else 1
187 val end0 = (end / bound_size + add_one) * bound_size
188 Timeslot(start0,end0)
191 /* returns true when the start and end address are
192 * multiples of bound_size*/
193 def isAligned(bound_size : Long) : Boolean =
194 start % bound_size == 0 && end % bound_size == 0
198 * Compares the starting times of two timeslots.
200 def compare(that: Timeslot): Int = {
201 if (this.startsBefore(that)) -1
202 else if (this.startsAfter(that)) 1
207 * Converts the timeslot to the amount of hours it represents
209 def hours: Double = (to.getTime - from.getTime).toDouble / 1000.0 / 60.0 / 60.0
211 def deltaMillis = to.getTime - from.getTime
214 def myString : String = "Timeslot(" + this.start + "," + this.end + ")"
215 //override def toString() = myString
216 override def toString() =
219 def toDateString = "Timeslot(%s, %s)".format(new MutableDateCalc(from), new MutableDateCalc(to))
220 def toISODateString = "Timeslot(%s, %s)".format(new MutableDateCalc(from).toISOString, new MutableDateCalc(to).toISOString)
224 def apply(x: Long, y: Long): Timeslot =
225 new Timeslot(new Date(x), new Date(y))
227 def apply(x: Int, y: Int): Timeslot =
228 new Timeslot(new Date(x), new Date(y))
230 def mergeOverlaps(list: List[Timeslot]): List[Timeslot] = {
231 def sorter(x: Timeslot, y: Timeslot) : Boolean = y.from after x.from
232 (list sortWith sorter).foldLeft(List[Timeslot]()) {
236 if (hd overlaps b) (hd merge b)::Nil
238 case (a @ hd::tl,b) =>
239 if(hd overlaps b) (hd merge b)::tl