tools/src/main/scala/BuiltInEngines.scala

/** Copyright 2014 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.tools

import io.prediction.core.BuildInfo

case class EngineInstanceTemplate(
  val engineId: String,
  val version: String,
  val name: String,
  val engineFactory: String,
  val dataSourceJson: Any,
  val preparatorJson: Any,
  val algorithmsJson: Any,
  val servingJson: Any) {

  lazy val template = Map(
    "engine.json" ->
        templates.scala.txt.engineJson(engineId, version, name, engineFactory),
    Console.joinFile(Seq("params", "datasource.json")) -> dataSourceJson,
    Console.joinFile(Seq("params", "preparator.json")) -> preparatorJson,
    Console.joinFile(Seq("params", "algorithms.json")) -> algorithmsJson,
    Console.joinFile(Seq("params", "serving.json")) -> servingJson)
}

object BuiltInEngine {
  // This variable defines all built-in engines. Append new engines to this list.
  val instances: Seq[EngineInstanceTemplate] = Seq(
    EngineInstanceTemplate(
      engineId = "io.prediction.engines.itemrank",
      version = BuildInfo.version,
      name = "PredictionIO ItemRank Engine",
      engineFactory = "io.prediction.engines.itemrank.ItemRankEngine",
      dataSourceJson = templates.itemrank.params.txt.datasourceJson(),
      preparatorJson = templates.itemrank.params.txt.preparatorJson(),
      algorithmsJson = templates.itemrank.params.txt.algorithmsJson(),
      servingJson = templates.itemrank.params.txt.servingJson()),
    EngineInstanceTemplate(
      engineId = "io.prediction.engines.itemrec",
      version = BuildInfo.version,
      name = "PredictionIO ItemRecommendation Engine",
      engineFactory = "io.prediction.engines.itemrec.ItemRecEngine",
      dataSourceJson = templates.itemrec.params.txt.datasourceJson(),
      preparatorJson = templates.itemrec.params.txt.preparatorJson(),
      algorithmsJson = templates.itemrec.params.txt.algorithmsJson(),
      servingJson = templates.itemrec.params.txt.servingJson())
  )

  // TODO: Check if engineFactory actuall exists.
  val idInstanceMap: Map[String, EngineInstanceTemplate] = instances
    .map { eit => (eit.engineId -> eit) }
    .toMap
}