Trait/Object

com.datastax.spark.connector.mapper

ColumnMapper

Related Docs: object ColumnMapper | package mapper

Permalink

trait ColumnMapper[T] extends AnyRef

Produces ColumnMapForReading or ColumnMapForWriting objects that map class T properties to columns in a given Cassandra table.

You can associate a custom ColumnMapper object with any of your classes by providing an implicit ColumnMapper in the companion object of the mapped class:

CREATE TABLE kv(key int primary key, value text);
case class KeyValue(k: Int, v: String)

object KeyValue {
  implicit val columnMapper =
    new DefaultColumnMapper[KeyValue](Map("k" -> "key", "v" -> "value"))
}
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ColumnMapper
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def columnMapForReading(struct: StructDef, selectedColumns: IndexedSeq[ColumnRef]): ColumnMapForReading

    Permalink

    Provides a mapping between given table or UDT and properties of type T, useful for creating objects of type T.

    Provides a mapping between given table or UDT and properties of type T, useful for creating objects of type T. Throws IllegalArgumentException if selectedColumns does not provide some columns needed to instantiate object of type T

  2. abstract def columnMapForWriting(struct: StructDef, selectedColumns: IndexedSeq[ColumnRef]): ColumnMapForWriting

    Permalink

    Provides a mapping between given table or UDT and properties of type T, useful for reading property values of type T and writing them to Cassandra.

    Provides a mapping between given table or UDT and properties of type T, useful for reading property values of type T and writing them to Cassandra. Throws IllegalArgumentException if selectedColumns contains some columns that don't have matching getters.

  3. abstract def newTable(keyspaceName: String, tableName: String, protocolVersion: ProtocolVersion = ProtocolVersion.NEWEST_SUPPORTED): TableDef

    Permalink

    Provides a definition of the table that class T could be saved to.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to any2stringadd[ColumnMapper[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ColumnMapper[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to ArrowAssoc[ColumnMapper[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (ColumnMapper[T]) ⇒ Boolean, msg: ⇒ Any): ColumnMapper[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to Ensuring[ColumnMapper[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ColumnMapper[T]) ⇒ Boolean): ColumnMapper[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to Ensuring[ColumnMapper[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ColumnMapper[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to Ensuring[ColumnMapper[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ColumnMapper[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to Ensuring[ColumnMapper[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to StringFormat[ColumnMapper[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (ColumnMapper[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ColumnMapper[T] to ArrowAssoc[ColumnMapper[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ColumnMapper[T] to any2stringadd[ColumnMapper[T]]

Inherited by implicit conversion StringFormat from ColumnMapper[T] to StringFormat[ColumnMapper[T]]

Inherited by implicit conversion Ensuring from ColumnMapper[T] to Ensuring[ColumnMapper[T]]

Inherited by implicit conversion ArrowAssoc from ColumnMapper[T] to ArrowAssoc[ColumnMapper[T]]

Ungrouped