be.wegenenverkeer.atomium.server.slick

AbstractSlickFeedStore

Related Doc: package slick

abstract class AbstractSlickFeedStore[E] extends AbstractFeedStore[E, SlickJdbcContext]

An AbstractFeedStore implementation that stores feeds and pages in a SQL database. This implementation automatically manages the entries tables for each feed.

E

type of the elements in the feed

Linear Supertypes
AbstractFeedStore[E, SlickJdbcContext], FeedStore[E, SlickJdbcContext], AnyRef, Any
Known Subclasses
SlickFeedStore
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AbstractSlickFeedStore
  2. AbstractFeedStore
  3. FeedStore
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractSlickFeedStore(feedName: String, title: Option[String], ser: (E) ⇒ String, deser: (String) ⇒ E, url: Url)

    feedName

    the name of the feed

    title

    the optional title of the feed

    ser

    function to serialize an element to a String

    deser

    function to deserialize a String to an element

    url

    the base Url

Type Members

  1. case class FeedEntry(sequenceNr: Long, entry: Entry[E]) extends Product with Serializable

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

Abstract Value Members

  1. abstract val feedComponent: FeedComponent

  2. abstract def getEntryTableQuery: scala.slick.driver.JdbcProfile.SimpleQL.TableQuery[EntryTable]

    Attributes
    protected

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def close(): Unit

    This method is called when the be.wegenenverkeer.atomium.server.FeedService is stopped.

    This method is called when the be.wegenenverkeer.atomium.server.FeedService is stopped.

    Definition Classes
    FeedStore

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

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def feedLink(startId: Long, count: Int, forward: Boolean): Url

    Creates a link to a feed page.

    Creates a link to a feed page.

    startId

    the starting entry's id (non inclusive)

    count

    the number of entries in the page

    forward

    if true navigate to 'previous' elements in feed (towards head of feed) else navigate to 'next' elements in feed (towards last page of feed)

    returns

    the URL

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. def generateEntryID(): String

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def getFeed(start: Long, pageSize: Int, forward: Boolean)(implicit context: SlickJdbcContext): Option[Feed[E]]

    Retrieves a page of the feed.

    Retrieves a page of the feed.

    start

    the starting entry (exclusive), should not be returned in the feed page

    pageSize

    the number of entries

    forward

    if true navigate to 'previous' elements in feed (towards head of feed) else navigate to 'next' elements in feed (towards last page of feed)

    returns

    the feed page or None if the page is not found

    Definition Classes
    AbstractFeedStore → FeedStore

  14. def getFeedEntries(start: Long, count: Int, ascending: Boolean)(implicit context: SlickJdbcContext): List[FeedEntry]

    Retrieves entries with their sequence numbers from the feed

    Retrieves entries with their sequence numbers from the feed

    start

    the starting entry (inclusive), MUST be returned in the entries

    count

    the number of entries to return

    ascending

    if true return entries with sequence numbers >= start in ascending order else return entries with sequence numbers <= start in descending order

    returns

    the corresponding entries sorted accordingly

    Definition Classes
    AbstractSlickFeedStore → AbstractFeedStore

  15. def getHeadOfFeed(pageSize: Int)(implicit context: SlickJdbcContext): Option[Feed[E]]

    Retrieves the head of the feed.

    Retrieves the head of the feed. This is the first page containing the most recent entries

    pageSize

    the maximum number of feed entries to return. The page could contain less entries

    returns

    the head of the feed

    Definition Classes
    AbstractFeedStore → FeedStore

  16. def getMostRecentFeedEntries(count: Int)(implicit context: SlickJdbcContext): List[FeedEntry]

    retrieves the most recent entries from the feedstore sorted in descending order

    retrieves the most recent entries from the feedstore sorted in descending order

    count

    the amount of recent entries to return

    returns

    a list containing tuples of a sequence number and its corresponding entry and sorted by descending sequence number

    Definition Classes
    AbstractSlickFeedStore → AbstractFeedStore

  17. def getNextLink(id: Long, count: Int, next: Option[Long]): Option[Link]

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

  18. def getNumberOfEntriesLowerThan(sequenceNr: Long, inclusive: Boolean = true)(implicit context: SlickJdbcContext): Long

    sequenceNr

    sequence number to match

    inclusive

    if true include the specified sequence number

    returns

    the number of entries in the feed with sequence number lower than specified

    Definition Classes
    AbstractSlickFeedStore → AbstractFeedStore

  19. def getPreviousLink(id: Long, count: Int, previous: Option[Long]): Option[Link]

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. def link(l: String, start: Long, pageSize: Int, forward: Boolean): Link

    Attributes
    protected
    Definition Classes
    AbstractFeedStore

  23. def maxId(implicit context: SlickJdbcContext): Long

    returns

    the maximum sequence number used in this feed or minId if feed is empty

    Definition Classes
    AbstractSlickFeedStore → AbstractFeedStore

  24. def minId(implicit context: SlickJdbcContext): Long

    returns

    one less than the minimum sequence number used in this feed since SQL sequences start at 1 this is 0. If your DB sequences start with another number override this class and modify accordingly

    Definition Classes
    AbstractSlickFeedStore → AbstractFeedStore

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  28. def open(): Unit

    This method is called when the be.wegenenverkeer.atomium.server.FeedService is started.

    This method is called when the be.wegenenverkeer.atomium.server.FeedService is started. This can be used as a hook (to check consistency, for example)

    Definition Classes
    FeedStore

  29. def push(uuid: String, entry: E)(implicit context: SlickJdbcContext): Unit

    Definition Classes
    AbstractSlickFeedStore → FeedStore

  30. def push(entries: Iterable[E])(implicit context: SlickJdbcContext): Unit

    push a list of entries to the feed

    push a list of entries to the feed

    entries

    the entries to push to the feed

    Definition Classes
    AbstractSlickFeedStore → FeedStore

  31. def push(entry: E)(implicit context: SlickJdbcContext): Unit

    push a single entry to the feed

    push a single entry to the feed

    entry

    the entry to push to the feed

    Definition Classes
    FeedStore

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  33. def toString(): String

    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AbstractFeedStore[E, SlickJdbcContext]

Inherited from FeedStore[E, SlickJdbcContext]

Inherited from AnyRef

Inherited from Any

Ungrouped