com.ignition.frame

TextFileInput

case class TextFileInput(path: String, separator: Option[String] = scala.None, dataField: String = "content") extends FrameProducer with Product with Serializable

Reads the text file into a data frame with a single column. If the separator is specified, splits the file into multiple rows, otherwise the data frame will contain only one row.

Linear Supertypes
Product, Equals, FrameProducer, FrameStep, Producer[DataFrame, SparkRuntime], NoInputStep[DataFrame, SparkRuntime], SingleOutputStep[DataFrame, SparkRuntime], ConnectionSource[DataFrame, SparkRuntime], Step[DataFrame, SparkRuntime], JsonExport, XmlExport, AbstractStep, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TextFileInput
  2. Product
  3. Equals
  4. FrameProducer
  5. FrameStep
  6. Producer
  7. NoInputStep
  8. SingleOutputStep
  9. ConnectionSource
  10. Step
  11. JsonExport
  12. XmlExport
  13. AbstractStep
  14. Serializable
  15. Serializable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TextFileInput(path: String, separator: Option[String] = scala.None, dataField: String = "content")

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. def -->(targets: ConnectionTarget[DataFrame, SparkRuntime]*): Unit

    Definition Classes
    ConnectionSource

  5. def -->(tgt: MultiInputStep[DataFrame, SparkRuntime]): tgt.type

    Definition Classes
    ConnectionSource

  6. def -->(tgt: ConnectionTarget[DataFrame, SparkRuntime]): tgt.type

    Definition Classes
    ConnectionSource

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

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

    Registers a new listener.

    Registers a new listener.

    Definition Classes
    Step

  10. 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

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. 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
    Definition Classes
    TextFileInput → FrameStep

  13. def clone(): AnyRef

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

  14. def compute(implicit runtime: SparkRuntime): DataFrame

    Attributes
    protected
    Definition Classes
    TextFileInput → Producer

  15. 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
    Producer → Step

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

    Returns the implicit SQLContext.

    Returns the implicit SQLContext.

    Attributes
    protected
    Definition Classes
    FrameStep

  17. val dataField: String

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

    Definition Classes
    AnyRef

  19. 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] )

  20. def field(f: String): TextFileInput

  21. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  23. val index: Int

    Definition Classes
    SingleOutputStep → ConnectionSource

  24. val inputCount: Int

    The maximum number of input ports.

    The maximum number of input ports.

    Definition Classes
    NoInputStep → Step

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. 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
    Definition Classes
    FrameStep

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

    Returns the output schema of the step at index 0.

    Returns the output schema of the step at index 0.

    Definition Classes
    FrameStep

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

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

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

    Definition Classes
    FrameStep

  32. def outbounds(index: Int): SingleOutputStep[DataFrame, SparkRuntime]

    Definition Classes
    SingleOutputStep

  33. 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.

  34. 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.

  35. val outputCount: Int

    The number of output ports.

    The number of output ports.

    Definition Classes
    SingleOutputStep → Step

  36. val path: String

  37. val regex: Option[Regex]

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

    Unregisters a listener.

    Unregisters a listener.

    Definition Classes
    Step

  39. 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

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

    Returns the implicit SparkContext.

    Returns the implicit SparkContext.

    Attributes
    protected
    Definition Classes
    FrameStep

  41. val schema: StructType

  42. def separator(sep: String): TextFileInput

  43. val separator: Option[String]

  44. val step: SingleOutputStep[DataFrame, SparkRuntime]

    Definition Classes
    SingleOutputStep → ConnectionSource

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

    Definition Classes
    AnyRef

  46. def to(targets: ConnectionTarget[DataFrame, SparkRuntime]*): Unit

    Definition Classes
    ConnectionSource

  47. def to(tgt: MultiInputStep[DataFrame, SparkRuntime]): tgt.type

    Definition Classes
    ConnectionSource

  48. def to(tgt: ConnectionTarget[DataFrame, SparkRuntime]): tgt.type

    Definition Classes
    ConnectionSource

  49. def toJson: JValue

    Definition Classes
    TextFileInput → JsonExport

  50. def toXml: Elem

    Definition Classes
    TextFileInput → XmlExport

  51. def value(implicit runtime: SparkRuntime): DataFrame

    Definition Classes
    SingleOutputStep → ConnectionSource

  52. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Wraps exceptions into ExecutionException instances.

    Wraps exceptions into ExecutionException instances.

    Attributes
    protected
    Definition Classes
    AbstractStep

Inherited from Product

Inherited from Equals

Inherited from FrameProducer

Inherited from FrameStep

Inherited from Producer[DataFrame, SparkRuntime]

Inherited from NoInputStep[DataFrame, SparkRuntime]

Inherited from SingleOutputStep[DataFrame, SparkRuntime]

Inherited from ConnectionSource[DataFrame, SparkRuntime]

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