commons/src/main/scala/io/prediction/commons/settings/OfflineEvals.scala

package io.prediction.commons.settings

import io.prediction.commons.Common

import com.github.nscala_time.time.Imports._
import org.json4s._
import org.json4s.native.Serialization

/**
 * OfflineEval object
 *
 * @param id ID.
 * @param engineid The id of Engine object which owns this OfflineEval.
 * @param name The name of the this Offline Evaluation.
 * @param tuneid The OfflineTune ID
 * @param createtime The Creation time of the evaluation
 * @param starttime The Starting time of the evaluation
 * @param endtime The End time of the the evaluation. It's still running if it's None.
 * @param iterations Number of iterations. Default to 1.
 */
case class OfflineEval(
  id: Int,
  engineid: Int,
  name: String,
  iterations: Int = 1,
  tuneid: Option[Int],
  createtime: Option[DateTime],
  starttime: Option[DateTime],
  endtime: Option[DateTime])

trait OfflineEvals extends Common {

  /**
   * Insert an OfflineEval and return id
   *
   * NOTE: can't use id of the offlineEval parameter
   */
  def insert(offlineEval: OfflineEval): Int

  /** Get OfflineEval by its id */
  def get(id: Int): Option[OfflineEval]

  /** Get all OfflineEvals. */
  def getAll(): Iterator[OfflineEval]

  /** Get OfflineEval by engine id */
  def getByEngineid(engineid: Int): Iterator[OfflineEval]

  /** Get OfflineEval by offline tune id */
  def getByTuneid(tuneid: Int): Iterator[OfflineEval]

  /** Get OfflineEval by its ID and engine ID */
  def getByIdAndEngineid(id: Int, engineid: Int): Option[OfflineEval]

  /** Update OfflineEval (create new one if the it doesn't exist) */
  def update(offlineEval: OfflineEval, upsert: Boolean = false)

  /** delete OfflineEval by it's id) */
  def delete(id: Int)

  implicit val formats = Serialization.formats(NoTypeHints) ++ org.json4s.ext.JodaTimeSerializers.all

  /** Backup all data as a byte array. */
  def backup(): Array[Byte] = Serialization.write(getAll().toSeq).getBytes("UTF-8")

  /** Restore data from a byte array backup created by the current or the immediate previous version of commons. */
  def restore(bytes: Array[Byte], inplace: Boolean = false, upgrade: Boolean = false): Option[Seq[OfflineEval]] = {
    try {
      val rdata = Serialization.read[Seq[OfflineEval]](new String(bytes, "UTF-8"))
      if (inplace) rdata foreach { update(_, true) }
      Some(rdata)
    } catch {
      case e: MappingException => None
    }
  }
}