Packages

final class TypeSig extends AnyRef

A type signature. This is a bit limited in what it supports right now, but can express a set of base types and a separate set of types that can be nested under the base types (child types). It can also express if a particular base type has to be a literal or not.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypeSig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: TypeSig): TypeSig

    Combine two type signatures together.

    Combine two type signatures together. Base types and child types will be the union of both as will limitations on literal values.

    other

    what to combine with.

    returns

    the new signature

  4. def -(other: TypeSig): TypeSig

    Remove a type signature.

    Remove a type signature. The reverse of +

    other

    what to remove

    returns

    the new signature

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def areAllSupportedByPlugin(types: Seq[DataType]): Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getSupportLevel(dataType: TypeEnum.Value, allowed: TypeSig): SupportLevel

    Get the level of support for a given type compared to what Spark supports.

    Get the level of support for a given type compared to what Spark supports. Used for documentation.

  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def intersect(other: TypeSig): TypeSig
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def isSupportedByPlugin(dataType: DataType): Boolean

    Check if this type is supported by the plugin or not.

    Check if this type is supported by the plugin or not.

    dataType

    the data type to be checked

    returns

    true if it is allowed else false.

  17. def isSupportedBySpark(dataType: DataType): Boolean
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def nested(): TypeSig

    Update this type signature to be nested with the initial types too.

    Update this type signature to be nested with the initial types too.

    returns

    the update type signature

  20. def nested(childTypes: TypeSig): TypeSig

    Add child types to this type signature.

    Add child types to this type signature. Note that these do not stack so if childTypes has child types too they are ignored.

    childTypes

    the basic types to add.

    returns

    the new type signature

  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def reasonNotSupported(dataType: DataType): Seq[String]
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def tagExprParam(meta: RapidsMeta[_, _, _], exprMeta: BaseExprMeta[_], name: String, willNotWork: (String) ⇒ Unit): Unit

    Given an expression tag the associated meta for it to be supported or not.

    Given an expression tag the associated meta for it to be supported or not.

    meta

    the meta that gets marked for support or not.

    exprMeta

    the meta of expression to check against.

    name

    the name of the expression (typically a parameter name)

  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withAllLit(): TypeSig

    All currently supported types can only be literal values.

    All currently supported types can only be literal values.

    returns

    the new signature.

  31. def withLit(dataTypes: TypeEnum.ValueSet): TypeSig

    Add a literal restriction to the signature

    Add a literal restriction to the signature

    dataTypes

    the types that have to be literal. Will be added if they do not already exist.

    returns

    the new signature.

  32. def withLit(dataType: TypeEnum.Value): TypeSig

    Add a literal restriction to the signature

    Add a literal restriction to the signature

    dataType

    the type that has to be literal. Will be added if it does not already exist.

    returns

    the new signature.

  33. def withPsNote(dataTypes: Seq[TypeEnum.Value], note: String): TypeSig

    Add a note about given types that marks them as partially supported.

    Add a note about given types that marks them as partially supported.

    dataTypes

    the types this note is for.

    note

    the note itself

    returns

    the updated TypeSignature.

  34. def withPsNote(dataType: TypeEnum.Value, note: String): TypeSig

    Add a note about a given type that marks it as partially supported.

    Add a note about a given type that marks it as partially supported.

    dataType

    the type this note is for.

    note

    the note itself

    returns

    the updated TypeSignature.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped