ml.combust.mleap.runtime.types

StructType

case class StructType extends Serializable with Product

Class for storing structured type information.

This class is primarily used to define the schema of a ml.combust.mleap.runtime.LeapFrame. In the future, it could be used to define the structure of fields stored in the LeapFrame itself.

Linear Supertypes
Product, Equals, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StructType
  2. Product
  3. Equals
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def dropField(name: String): Try[StructType]

    Try to drop a field from the struct.

    Try to drop a field from the struct.

    name

    name of field to drop

    returns

    try new struct without field

  9. def dropIndex(index: Int): Try[StructType]

    Try to drop an index from the struct.

    Try to drop an index from the struct.

    index

    index of field to drop

    returns

    try new struct without index

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

    Definition Classes
    AnyRef
  11. val fields: Seq[StructField]

    list of fields in this struct

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def getField(name: String): Option[StructField]

    Get optional field by name.

    Get optional field by name.

    name

    name of field

    returns

    optional field value

  15. def hasField(name: String): Boolean

    If the struct contains field or not.

    If the struct contains field or not.

    name

    name of field

    returns

    true if this contains the field name, false otherwise

  16. def indexOf(name: String): Try[Int]

    Try to get the index of a field.

    Try to get the index of a field.

    name

    name of field

    returns

    try index of field

  17. def indexedField(name: String): Try[(Int, StructField)]

    Try to get the index and field for a field name.

    Try to get the index and field for a field name.

    name

    name of field

    returns

    try (index of field, field definition)

  18. def indicesOf(fieldNames: String*): Try[Seq[Int]]

    Try to get indices for a list of field names.

    Try to get indices for a list of field names.

    fieldNames

    names of fields

    returns

    try list of indices for fields

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def print(out: PrintStream): Unit

    Print schema to a PrintStream.

    Print schema to a PrintStream.

    out

    print stream to write schema to

  24. def print(): Unit

    Print schema to standard out.

  25. def rowReader(format: String = BuiltinFormats.json): RowReader

  26. def rowWriter(format: String = BuiltinFormats.json): RowWriter

  27. def select(fieldNames: String*): Try[StructType]

    Try to select fields to create a new struct.

    Try to select fields to create a new struct.

    fieldNames

    names of fields to go into new struct

    returns

    try new struct with selected fields

  28. def selectIndices(indices: Int*): Try[StructType]

    Try to select fields by index to create a new struct.

    Try to select fields by index to create a new struct.

    indices

    indices of the fields to select

    returns

    try new struct with selected indices

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

    Definition Classes
    AnyRef
  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def withField(field: StructField): Try[StructType]

    Try to add a field to this struct.

    Try to add a field to this struct.

    field

    field to add

    returns

    try new struct with field added

  34. def withField(name: String, dataType: DataType): Try[StructType]

    Try to add a field to this struct.

    Try to add a field to this struct.

    name

    name of field

    dataType

    data type of field

    returns

    try new struct with field added

  35. def withFields(fields: Seq[StructField]): Try[StructType]

    Try to add multiple fields to this struct.

    Try to add multiple fields to this struct.

    fields

    fields to add

    returns

    try new struct with fields added

  36. def withFields(field: StructField, fields: StructField*): Try[StructType]

    Try to add multiple fields to this struct.

    Try to add multiple fields to this struct.

    field

    first field to add

    fields

    fields to add

    returns

    try new struct with fields added

Inherited from Product

Inherited from Equals

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped