Trait

org.apache.predictionio.data.storage

LEvents

Related Doc: package storage

Permalink

trait LEvents extends AnyRef

:: DeveloperApi :: Base trait of a data access object that directly returns Event without going through Spark's parallelization. Engine developers should use org.apache.predictionio.data.store.LEventStore instead of using this directly.

Annotations
@DeveloperApi()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LEvents
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit

    Permalink

    :: DeveloperApi :: Close this Event Store interface object, e.g.

    :: DeveloperApi :: Close this Event Store interface object, e.g. close connection, release resources, etc.

    Annotations
    @DeveloperApi()
  2. abstract def futureDelete(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Boolean]

    Permalink

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    channelId

    Optional channel ID that contains the Event

    Annotations
    @DeveloperApi()
  3. abstract def futureFind(appId: Int, channelId: Option[Int] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, entityType: Option[String] = None, entityId: Option[String] = None, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, limit: Option[Int] = None, reversed: Option[Boolean] = None)(implicit ec: ExecutionContext): Future[Iterator[Event]]

    Permalink

    :: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.

    :: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.

    appId

    return events of this app ID

    channelId

    return events of this channel ID (default channel if it's None)

    startTime

    return events with eventTime >= startTime

    untilTime

    return events with eventTime < untilTime

    entityType

    return events of this entityType

    entityId

    return events of this entityId

    eventNames

    return events with any of these event names.

    targetEntityType

    return events of this targetEntityType:

    • None means no restriction on targetEntityType
    • Some(None) means no targetEntityType for this event
    • Some(Some(x)) means targetEntityType should match x.
    targetEntityId

    return events of this targetEntityId

    • None means no restriction on targetEntityId
    • Some(None) means no targetEntityId for this event
    • Some(Some(x)) means targetEntityId should match x.
    limit

    Limit number of events. Get all events if None or Some(-1)

    reversed

    Reverse the order.

    • return oldest events first if None or Some(false) (default)
    • return latest events first if Some(true)
    ec

    ExecutionContext

    returns

    Future[Iterator[Event]]

    Annotations
    @DeveloperApi()
  4. abstract def futureGet(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Option[Event]]

    Permalink

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    channelId

    Optional channel ID that contains the Event

    Annotations
    @DeveloperApi()
  5. abstract def futureInsert(event: Event, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[String]

    Permalink

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    event

    An Event to be inserted

    appId

    App ID for the Event to be inserted to

    channelId

    Optional channel ID for the Event to be inserted to

    Annotations
    @DeveloperApi()
  6. abstract def init(appId: Int, channelId: Option[Int] = None): Boolean

    Permalink

    :: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID.

    :: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID. This routine is to be called when an app is first created.

    appId

    App ID

    channelId

    Optional channel ID

    returns

    true if initialization was successful; false otherwise.

    Annotations
    @DeveloperApi()
  7. abstract def remove(appId: Int, channelId: Option[Int] = None): Boolean

    Permalink

    :: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.

    :: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.

    appId

    App ID

    channelId

    Optional channel ID

    returns

    true if removal was successful; false otherwise.

    Annotations
    @DeveloperApi()

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. val defaultTimeout: FiniteDuration

    Permalink

    Default timeout for asynchronous operations that is set to 1 minute

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def futureDelete(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Boolean]

    Permalink

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    :: DeveloperApi :: Delete an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    Annotations
    @DeveloperApi()
  11. def futureGet(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Option[Event]]

    Permalink

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    :: DeveloperApi :: Get an Event in a non-blocking fashion.

    eventId

    ID of the Event

    appId

    ID of the app that contains the Event

    Annotations
    @DeveloperApi()
  12. def futureInsert(event: Event, appId: Int)(implicit ec: ExecutionContext): Future[String]

    Permalink

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    :: DeveloperApi :: Insert an Event in a non-blocking fashion.

    event

    An Event to be inserted

    appId

    App ID for the Event to be inserted to

    Annotations
    @DeveloperApi()
  13. def futureInsertBatch(events: Seq[Event], appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Seq[String]]

    Permalink

    :: DeveloperApi :: Insert Events in a non-blocking fashion.

    :: DeveloperApi :: Insert Events in a non-blocking fashion.

    Default implementation of this method is calling Int, Option[Int]) per event. Override in the storage implementation if the storage has a better way to insert multiple data at once.

    events

    Events to be inserted

    appId

    App ID for the Events to be inserted to

    channelId

    Optional channel ID for the Events to be inserted to

    Annotations
    @DeveloperApi()
  14. final def getClass(): Class[_]

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

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

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

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

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

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

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

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

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

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

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

Deprecated Value Members

  1. def findSingleEntity(appId: Int, channelId: Option[Int] = None, entityType: String, entityId: String, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, limit: Option[Int] = None, latest: Boolean = true, timeout: Duration = defaultTimeout)(implicit ec: ExecutionContext): Either[StorageError, Iterator[Event]]

    Permalink

    reads events of the specified entity.

    reads events of the specified entity.

    appId

    return events of this app ID

    channelId

    return events of this channel ID (default channel if it's None)

    entityType

    return events of this entityType

    entityId

    return events of this entityId

    eventNames

    return events with any of these event names.

    targetEntityType

    return events of this targetEntityType:

    • None means no restriction on targetEntityType
    • Some(None) means no targetEntityType for this event
    • Some(Some(x)) means targetEntityType should match x.
    targetEntityId

    return events of this targetEntityId

    • None means no restriction on targetEntityId
    • Some(None) means no targetEntityId for this event
    • Some(Some(x)) means targetEntityId should match x.
    startTime

    return events with eventTime >= startTime

    untilTime

    return events with eventTime < untilTime

    limit

    Limit number of events. Get all events if None or Some(-1)

    latest

    Return latest event first (default true)

    ec

    ExecutionContext

    returns

    Either[StorageError, Iterator[Event]]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.2) Use LEventStore.findByEntity() instead.

Inherited from AnyRef

Inherited from Any

Ungrouped