Trait/Object

com.pagerduty.mapper

EntityMapping

Related Docs: object EntityMapping | package mapper

Permalink

trait EntityMapping[Id, Entity] extends AnyRef

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

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

Abstract Value Members

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

    Permalink

    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

    Permalink

    Checks if there is an @Id annotation field.

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

    Permalink

    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]

    Permalink

    Returns a map of serializers by column name.

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

    Permalink

    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]

    Permalink

    Returns a class managed by this mapping.

  7. abstract def ttlSeconds: Option[Int]

    Permalink

    Returns an optional ttl for this mapping.

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

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped