com.ignition.frame

FrameStep

trait FrameStep extends AbstractStep with Step[DataFrame, SparkRuntime] with XmlExport with JsonExport

Workflow step that emits DataFrame as the output.

Linear Supertypes
Step[DataFrame, SparkRuntime], JsonExport, XmlExport, AbstractStep, Serializable, Serializable, AnyRef, Any
Known Subclasses
AbstractAggregate, AddFields, BasicStats, CassandraInput, CassandraOutput, ColumnStats, Correlation, CsvFileInput, DataGrid, DebugOutput, Filter, Formula, FrameFlow, FrameMerger, FrameModule, FrameProducer, FrameSplitter, FrameSubFlow, FrameSubMerger, FrameSubModule, FrameSubProducer, FrameSubSplitter, FrameSubTransformer, FrameTransformer, Intersection, Invoke, Join, JsonFileInput, KafkaInput, KafkaOutput, MongoInput, MongoOutput, Pass, Reduce, Regression, RestClient, SQLQuery, SelectValues, SetVariables, TextFileInput, TextFileOutput, TextFolderInput, Union
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FrameStep
  2. Step
  3. JsonExport
  4. XmlExport
  5. AbstractStep
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def compute(index: Int)(implicit runtime: SparkRuntime): DataFrame

    Computes a step output value at the specified index.

    Computes a step output value at the specified index. This method is invoked from output() and can safely throw any exception, which will be wrapped into ExecutionException.

    index

    the output value index.

    Attributes
    protected
    Definition Classes
    Step

  2. abstract def inputCount: Int

    The maximum number of input ports.

    The maximum number of input ports.

    Definition Classes
    Step

  3. abstract def outputCount: Int

    The number of output ports.

    The number of output ports.

    Definition Classes
    Step

  4. abstract def toJson: JValue

    Definition Classes
    JsonExport

  5. abstract def toXml: Elem

    Definition Classes
    XmlExport

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def addStepListener(listener: StepListener[DataFrame, SparkRuntime]): Unit

    Registers a new listener.

    Registers a new listener.

    Definition Classes
    Step

  7. def allInputsRequired: Boolean

    Specifies if the step should throw an error if one of the inputs is not connected.

    Specifies if the step should throw an error if one of the inputs is not connected.

    Definition Classes
    Step

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def buildSchema(index: Int)(implicit runtime: SparkRuntime): StructType

    Returns the output schema of the step at a given index by calling output() in preview mode and retrieving the schema from the DataFrame.

    Returns the output schema of the step at a given index by calling output() in preview mode and retrieving the schema from the DataFrame. Since the default implementation of this method calls output(), invoking it from output() directly or indirectly will result in infinite cycle.

    Attributes
    protected

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def ctx(implicit runtime: SparkRuntime): SQLContext

    Returns the implicit SQLContext.

    Returns the implicit SQLContext.

    Attributes
    protected

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. final def evaluate(implicit runtime: SparkRuntime): IndexedSeq[DataFrame]

    Evaluates all step's outputs and returns a list of results.

    Evaluates all step's outputs and returns a list of results.

    Definition Classes
    Step
    Annotations
    @throws( classOf[ExecutionException] )

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. def optLimit(df: DataFrame, preview: Boolean): DataFrame

    Takes one row from the data frame is preview is true.

    Takes one row from the data frame is preview is true.

    Attributes
    protected

  23. final def outSchema(implicit runtime: SparkRuntime): StructType

    Returns the output schema of the step at index 0.

  24. final def outSchema(index: Int)(implicit runtime: SparkRuntime): StructType

    Returns the output schema of the step at a given index.

  25. final def output(implicit runtime: SparkRuntime): DataFrame

    Shortcut for output(0).

    Shortcut for output(0). Computes a step output at index 0.

    Definition Classes
    Step
    Annotations
    @throws( classOf[ExecutionException] )
    Exceptions thrown
    ExecutionException

    in case of an error, or if the step is not connected.

  26. final def output(index: Int)(implicit runtime: SparkRuntime): DataFrame

    Computes a step output value at the specified index.

    Computes a step output value at the specified index.

    index

    the output value index.

    Definition Classes
    Step
    Annotations
    @throws( classOf[ExecutionException] )
    Exceptions thrown
    ExecutionException

    in case of an error, or if the step is not connected.

  27. def removeStepListener(listener: StepListener[DataFrame, SparkRuntime]): Unit

    Unregisters a listener.

    Unregisters a listener.

    Definition Classes
    Step

  28. def resetCache(predecessors: Boolean, descendants: Boolean): Unit

    Clears the cache of this step and optionally that of its predecessors and descendants.

    Clears the cache of this step and optionally that of its predecessors and descendants.

    Definition Classes
    Step

  29. def sc(implicit runtime: SparkRuntime): SparkContext

    Returns the implicit SparkContext.

    Returns the implicit SparkContext.

    Attributes
    protected

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  31. def toString(): String

    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wrap[U](body: ⇒ U): U

    Wraps exceptions into ExecutionException instances.

    Wraps exceptions into ExecutionException instances.

    Attributes
    protected
    Definition Classes
    AbstractStep

Inherited from Step[DataFrame, SparkRuntime]

Inherited from JsonExport

Inherited from XmlExport

Inherited from AbstractStep

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped