Type Members

1.  sealed trait Action[T] extends AnyRef

   An Action is something the user requests to be executed.

   An Action is something the user requests to be executed.

   They are translated to a Plan by the Planner.

2.  case class ActionMeta(name: Option[String] = None) extends Product with Serializable

   Meta Information about an action

3.  case class Algorithm(core: MantikItemCore[AlgorithmDefinition]) extends ApplicableMantikItem with BridgedMantikItem with Product with Serializable

   Some A => B Transformation Algorithm

4.  trait ApplicableMantikItem extends MantikItem

   A Mantik Item which can be applied to DataSets (e.g.

   A Mantik Item which can be applied to DataSets (e.g. Algorithms).

5.  trait BridgedMantikItem extends MantikItem
6.  class ConversionNotApplicableException extends IllegalArgumentException

   A DataSet cannot be automatically converted to an expected type.

7.  trait CoreComponents extends AnyRef

   Encapsulates access to the core components of Mantik.

   Encapsulates access to the core components of Mantik.

   Annotations

   @ImplementedBy()

8.  case class DataSet(core: MantikItemCore[DataSetDefinition]) extends BridgedMantikItem with Product with Serializable

   Represents a DataSet.

9.  sealed trait DefinitionSource extends AnyRef

   Represents the way MantikItem(s) get their Definition data from.

10.  case class DeploymentState(name: String, internalUrl: String, externalUrl: Option[String] = None, sub: Map[String, SubDeploymentState] = Map.empty) extends Product with Serializable

    Deployment information of one MantikItem.

11.  trait MantikItem extends AnyRef

    A single Item inside the Planner API.

    A single Item inside the Planner API. Can represent data or algorithms. Can be serialized to JSON.

12.  case class MantikItemCore[T <: MantikDefinition](source: Source, mantikHeader: MantikHeader[T], bridge: Option[Bridge], itemId: ItemId) extends Product with Serializable

    Contains the common base data for every MantikItem.

13.  case class MantikItemState(namedMantikItem: Option[NamedMantikId] = None, itemStored: Boolean = false, nameStored: Boolean = false, payloadFile: Option[String] = None, deployment: Option[DeploymentState] = None, cacheFile: Option[String] = None) extends Product with Serializable

    The current run time state of a Mantik Item.

    The current run time state of a Mantik Item.

    namedMantikItem

    the mantik id if the Item is stored/loaded inside the repository.

    itemStored

    the item itself is stored (this doesn't require that it has a mantik id)

    nameStored

    the name is stored (this also requires that the item is stored).

    deployment

    information about deployment

    cacheFile

    temporary cache file holding the result

14.  sealed trait Operation extends AnyRef

    Defines an operation.

15.  sealed trait PayloadSource extends AnyRef

    Represents the way MantikItem(s) gets their Payload Data from.

16.  case class Pipeline extends MantikItem with ApplicableMantikItem with Product with Serializable

    A Pipeline, like an algorithm but resembles the combination of multiple algorithms after each other.

    A Pipeline, like an algorithm but resembles the combination of multiple algorithms after each other.

    They can be stored independently in the Repository and can be deployed.

17.  case class Plan[T](op: PlanOp[T], files: List[PlanFile], cachedItems: Set[Vector[ItemId]], name: Option[String] = None) extends Product with Serializable

    A plan is something which can be executed.

    A plan is something which can be executed. They are created by the Planner and are executed by the PlanExecutor.

    They should be serializable in future (however this is tricky because of MantikItem references)

18.  trait PlanExecutor extends AnyRef

    Responsible for executing plans.

19.  case class PlanFile(ref: PlanFileReference, contentType: String, read: Boolean = false, write: Boolean = false, fileId: Option[String] = None, temporary: Boolean = false, cacheItemId: Option[ItemId] = None) extends Product with Serializable

    Defines a file which will be accessed within the plan.

20.  final case class PlanFileReference(id: Int) extends AnyVal with Product with Serializable

    An Id for a PlanFile

21.  sealed trait PlanNodeService extends AnyRef

    A node in a planning graph.

    A node in a planning graph. Node: this is not yet the "real" node, as resolving by the PlanExecutor is missing.

22.  sealed trait PlanOp[T] extends AnyRef

    An operation inside a plan.

23.  trait Planner extends AnyRef

    A Planner converts an Action into an executable Plan.

24.  class PlannerModule extends AbstractModule

    Registers Modules inside the planner package.

25.  trait PlanningContext extends AnyRef

    Main Interface for interacting and evaluating with MantikItems

26.  case class Source(definition: DefinitionSource, payload: PayloadSource) extends Product with Serializable

    Defines where a MantikItem comes from.

27.  case class SubDeploymentState(name: String, internalUrl: String) extends Product with Serializable

    Sub Deployment state (e.g.

    Sub Deployment state (e.g. Query Nodes)

28.  final case class TrainableAlgorithm(core: MantikItemCore[TrainableAlgorithmDefinition], trainedBridge: Bridge) extends BridgedMantikItem with Product with Serializable

    A trainable algorithm