Class/Object

ml.combust.mleap.core.types

StructType

Related Docs: object StructType | package types

Permalink

case class StructType extends Serializable with Product

Class for storing structured type information.

This class is primarily used to define the schema of a 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
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink

    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

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

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef
  9. val fields: Seq[StructField]

    Permalink

    list of fields in this struct

  10. def finalize(): Unit

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

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

    Permalink

    Get optional field by name.

    Get optional field by name.

    name

    name of field

    returns

    optional field value

  13. def hasField(name: String): Boolean

    Permalink

    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

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

    Permalink

    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

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

    Permalink

    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)

  16. def indexedFields(names: String*): Try[Seq[(Int, StructField)]]

    Permalink

    Try to get the index and field for all field names.

    Try to get the index and field for all field names.

    names

    names of fields

    returns

    try (index of field, field definition)

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

    Permalink

    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

  18. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

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

    Permalink

    Print schema to a PrintStream.

    Print schema to a PrintStream.

    out

    print stream to write schema to

  23. def print(): Unit

    Permalink

    Print schema to standard out.

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

    Permalink

    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

  25. def selectFields(fieldNames: String*): Try[Seq[StructField]]

    Permalink

    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

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

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef
  28. final def wait(): Unit

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

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

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

    Permalink

    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

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

    Permalink

    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

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

    Permalink

    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

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

    Permalink

    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