com.pagerduty.mapper

EntityMapping

trait EntityMapping[Id, Entity] extends AnyRef

Typed EntityMapping provides low level interface to write entities to mutation adapter and read them from result adapter.

Id
Entity

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EntityMapping
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getId(entity: Entity): Id

    Uses reflection to get id of a give entity.

    Uses reflection to get id of a give entity.

    Exceptions thrown
    EntityMapperException

    when @Id is no defined.

  2. abstract def isIdDefined: Boolean

    Checks if there is an @Id annotation field.

  3. abstract def read(targetId: Id, result: ResultAdapter): Option[Entity]

    Reads entity value from result.

    Reads entity value from result.

    Note that @Id field will not be set unless it is explicitly marked as @Column. You can use setId() method to manually set @Id field when desired.

    targetId

    entity id

    result

    query result

    returns

    Some(entity) when result contains at least one value needed by the mapping, None otherwise

  4. abstract def serializersByColName: Map[String, Any]

    Returns a map of serializers by column name.

  5. abstract def setId(entity: Entity, id: Id): Unit

    Uses reflection to set an id for a given entity.

    Uses reflection to set an id for a given entity.

    Exceptions thrown
    EntityMapperException

    when @Id is no defined.

  6. abstract def target: Class[Entity]

    Returns a class managed by this mapping.

  7. abstract def ttlSeconds: Option[Int]

    Returns an optional ttl for this mapping.

  8. abstract def write(targetId: Id, value: Option[Entity], mutation: MutationAdapter, ttlSeconds: Option[Int]): Unit

    Writes entity value into mutation batch.

    Writes entity value into mutation batch.

    Note that @Id field will not be written unless it is explicitly marked as @Column.

    targetId

    entity id

    value

    entity value

    mutation

    outgoing mutation

    ttlSeconds

    mutation TTL argument applied to the values represented by this mapping

Concrete 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. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped