Packages

package api

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package component
  2. package context
  3. package definition
  4. package editor
  5. package exception
  6. package generics
  7. package namespaces
  8. package process
  9. package runtimecontext
  10. package test
  11. package typed
  12. package validation

Type Members

  1. trait AdditionalVariable extends Annotation
    Annotations
    @Target() @Retention()
  2. trait AdditionalVariables extends Annotation
    Annotations
    @Target() @Retention()
  3. trait BranchParamName extends Annotation
    Annotations
    @Target() @Retention()
  4. case class Context(id: String, variables: Map[String, Any], parentContext: Option[Context]) extends Product with Serializable

    Context is container for variables used in expression evaluation

    Context is container for variables used in expression evaluation

    id

    correlation id/trace id used for tracing (logs, error presentation) and for tests mechanism, it should be always defined

    variables

    variables available in evaluation

    parentContext

    context used for scopes handling, mainly for fragment invocation purpose

  5. case class ContextId(value: String) extends Product with Serializable
  6. abstract class CustomStreamTransformer extends Component with AllProcessingModesComponent

    Hook for using Apache Flink API directly.

    Hook for using Apache Flink API directly. See examples in pl.touk.nussknacker.engine.example.custom

    IMPORTANT lifecycle notice: Implementations of this class *must not* allocate resources (connections, file handles etc.)

    To make implementation easier, by default, stream transformers handle all processing modes. If you have some processing mode specific component, you should override allowedProcessingModes method

  7. trait DefaultValue extends Annotation
    Annotations
    @Target() @Retention()
  8. trait Documentation extends Annotation
    Annotations
    @Target() @Retention()
  9. abstract class EagerService extends Service
  10. trait Hidden extends Annotation
    Annotations
    @Target() @Retention()
  11. trait HideToString extends AnyRef

    Implementing this interface results in hiding toString method in code completion

  12. trait LazyParameter[+T <: AnyRef] extends Serializable

    Lazy parameter is representation of parameter of custom node which should be evaluated for each record: def execute(@ParamName("groupBy") groupBy: LazyParameter[String], @ParamName ("length") length: String) In this case, length is computed as constant during process compilation, while groupBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate'), as evaluation may need lifecycle handling, to use it see LazyParameterInterpreter

    Lazy parameter is representation of parameter of custom node which should be evaluated for each record: def execute(@ParamName("groupBy") groupBy: LazyParameter[String], @ParamName ("length") length: String) In this case, length is computed as constant during process compilation, while groupBy is evaluated for each event Cannot be evaluated directly (no method like 'evaluate'), as evaluation may need lifecycle handling, to use it see LazyParameterInterpreter

    T

    type of evaluated parameter. It has upper bound AnyRef because currently we don't support correctly extraction of primitive types from generic parameters

  13. trait Lifecycle extends AutoCloseable
  14. trait MethodToInvoke extends Annotation
    Annotations
    @Target() @Retention()
  15. trait OutputVariableName extends Annotation
    Annotations
    @Target() @Retention()
  16. trait ParamName extends Annotation
    Annotations
    @Target() @Retention()
  17. final case class Params(nameToValueMap: Map[ParameterName, Any]) extends Product with Serializable
  18. abstract class Service extends Lifecycle with Component with AllProcessingModesComponent

    Interface of Enricher/Processor.

    Interface of Enricher/Processor. It has to have one method annotated with pl.touk.nussknacker.engine.api.MethodToInvoke. This method is called for every service invocation.

    This could be scala-trait, but we leave it as abstract class for now for java compatibility.

    TODO We should consider separate interfaces for java implementation, but right now we convert ProcessConfigCreator from java to scala one and is seems difficult to convert java CustomStreamTransformer, Service etc. into scala ones

    IMPORTANT lifecycle notice: Implementations of this class *must not* allocate resources (connections, file handles etc.) unless open() *or* appropriate @MethodToInvoke is called

  19. trait ServiceInvoker extends AnyRef
  20. trait ToEvaluateFunctionConverter extends AnyRef
  21. case class ValueWithContext[T](value: T, context: Context) extends Product with Serializable

Value Members

  1. object Context extends Serializable
  2. object LazyParameter extends Serializable
  3. object Params extends Serializable
  4. object VariableConstants

Ungrouped