code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/util/CollectionUtils.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.util
  37
  38 import java.util.{Map => JMap,
  39                   List => JList,
  40                   HashMap => JHashMap,
  41                   ArrayList => JArrayList}
  42
  43 /**
  44  * Utility functions for Collections, including recursive conversion to Java
  45  * for Maps and Lists
  46  *
  47  * @author Georgios Gousios <gousiosg@gmail.com>
  48  */
  49 trait CollectionUtils {
  50
  51   /**Merge input maps on a field by field basis. In case of duplicate keys
  52    *  values from the first map are prefered.
  53    */
  54   private def mergeMaps[A, B](a: Map[A, B], b: Map[A, B]): Map[A, B] = {
  55     a ++ b.map {
  56       case (k, v) => k -> (a.getOrElse(k, v))
  57     }
  58   }
  59
  60   /**Merge input maps on a field by field basis. In case of duplicate keys,
  61    *  the provided function is used to determine which value to keep in the
  62    *  merged map.
  63    */
  64   private def mergeMaps[A, B](ms: List[Map[A, B]])(f: (B, B) => B): Map[A, B] =
  65     (Map[A, B]() /: (for (m <- ms; kv <- m) yield kv)) {
  66       (a, kv) =>
  67         a + (if (a.contains(kv._1))
  68           kv._1 -> f(a(kv._1), kv._2)
  69         else kv)
  70     }
  71
  72
  73   /**
  74    * Recursively convert a Scala[String, Any] map to a Java equivalent.
  75    * It will also convert values that are Scala Maps or Lists or Seqs
  76    * to Java equivalents.
  77    */
  78   def mapToJavaMap(map: Map[String, Any]): JMap[String, Object] = {
  79     val result = new JHashMap[String, Object]
  80
  81     map.foreach(kv => result.put(kv._1, transformValue(kv._2)))
  82     result
  83   }
  84
  85   /**
  86    * Recursively convert a Scala List[Any] map to a Java equivalent
  87    * List[Object]. If the list's items are of type List[_]
  88    * and/or Map[String, Any] those will also be converted to
  89    * Java equivalents.
  90    */
  91   def listToJavaList(seq: List[Any]): JList[Object] = {
  92     val list = new JArrayList[Object]
  93     seq.foreach(a => list.add(transformValue(a)))
  94     list
  95   }
  96
  97   private def transformValue(v: Any) = {
  98     val v2  = v match {
  99       case l: List[_]     => listToJavaList(l)
 100       case s: Seq[_]      => listToJavaList(s.toList)
 101       case i: Iterator[_] => listToJavaList(i.toList)
 102       case m: Map[String, Any] => mapToJavaMap(m)
 103       case _              => v
 104     }
 105
 106     v2.asInstanceOf[Object]
 107   }
 108 }