io.prediction.data.storage.EngineManifests.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of data_2.10 Show documentation
data
The newest version!
/** Copyright 2015 TappingStone, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

package io.prediction.data.storage

import io.prediction.annotation.DeveloperApi
import org.json4s._

/** :: DeveloperApi ::
  * Provides a way to discover engines by ID and version in a distributed
  * environment
  *
  * @param id Unique identifier of an engine.
  * @param version Engine version string.
  * @param name A short and descriptive name for the engine.
  * @param description A long description of the engine.
  * @param files Paths to engine files.
  * @param engineFactory Engine's factory class name.
  * @group Meta Data
  */
@DeveloperApi
case class EngineManifest(
  id: String,
  version: String,
  name: String,
  description: Option[String],
  files: Seq[String],
  engineFactory: String)

/** :: DeveloperApi ::
  * Base trait of the [[EngineManifest]] data access object
  *
  * @group Meta Data
  */
@DeveloperApi
trait EngineManifests {
  /** Inserts an [[EngineManifest]] */
  def insert(engineManifest: EngineManifest): Unit

  /** Get an [[EngineManifest]] by its ID */
  def get(id: String, version: String): Option[EngineManifest]

  /** Get all [[EngineManifest]] */
  def getAll(): Seq[EngineManifest]

  /** Updates an [[EngineManifest]] */
  def update(engineInfo: EngineManifest, upsert: Boolean = false): Unit

  /** Delete an [[EngineManifest]] by its ID */
  def delete(id: String, version: String): Unit
}

/** :: DeveloperApi ::
  * JSON4S serializer for [[EngineManifest]]
  *
  * @group Meta Data
  */
@DeveloperApi
class EngineManifestSerializer
    extends CustomSerializer[EngineManifest](format => (
  {
    case JObject(fields) =>
      val seed = EngineManifest(
        id = "",
        version = "",
        name = "",
        description = None,
        files = Nil,
        engineFactory = "")
      fields.foldLeft(seed) { case (enginemanifest, field) =>
        field match {
          case JField("id", JString(id)) => enginemanifest.copy(id = id)
          case JField("version", JString(version)) =>
            enginemanifest.copy(version = version)
          case JField("name", JString(name)) => enginemanifest.copy(name = name)
          case JField("description", JString(description)) =>
            enginemanifest.copy(description = Some(description))
          case JField("files", JArray(s)) =>
            enginemanifest.copy(files = s.map(t =>
              t match {
                case JString(file) => file
                case _ => ""
              }
            ))
          case JField("engineFactory", JString(engineFactory)) =>
            enginemanifest.copy(engineFactory = engineFactory)
          case _ => enginemanifest
        }
      }
  },
  {
    case enginemanifest: EngineManifest =>
      JObject(
        JField("id", JString(enginemanifest.id)) ::
        JField("version", JString(enginemanifest.version)) ::
        JField("name", JString(enginemanifest.name)) ::
        JField("description",
          enginemanifest.description.map(
            x => JString(x)).getOrElse(JNothing)) ::
        JField("files",
          JArray(enginemanifest.files.map(x => JString(x)).toList)) ::
        JField("engineFactory", JString(enginemanifest.engineFactory)) ::
        Nil)
  }
))