Class

demesne.index

Index

Related Doc: package index

Permalink

abstract class Index[K, I, V] extends AnyRef

Created by damonrolfs on 11/5/14.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Index
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Index()

    Permalink

Abstract Value Members

  1. implicit abstract val ec: ExecutionContext

    Permalink
  2. abstract def futureGetIndexedValue(key: K): Future[Option[IndexedValue[I, V]]]

    Permalink
  3. abstract def futureIndexedValueEntries: Future[Map[K, IndexedValue[I, V]]]

    Permalink
  4. abstract def getIndexedValue(key: K): Option[IndexedValue[I, V]]

    Permalink
  5. abstract def indexedValueEntries: Map[K, IndexedValue[I, V]]

    Permalink

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. def apply(key: K): V

    Permalink

    Retrieves the value which is associated with the given key.

    Retrieves the value which is associated with the given key. This method invokes the default method of the index if there is no mapping from the given key to an id. Unless overridden, the default method throws a NoSuchElementException.

    key

    the key

    returns

    the value associated with the given key, or the result of the map's default method, if none exists.

  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contains(key: K): Boolean

    Permalink

    Tests whether this index contains a binding for a key.

    Tests whether this index contains a binding for a key.

    key

    the key

    returns

    true if there is a binding for key in this index, false otherwise.

  8. def default(key: K): V

    Permalink

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    key

    the given key value for which a binding is missing.

    Annotations
    @throws( classOf[NoSuchElementException] )
  9. def entries: Map[K, V]

    Permalink

    Returns all of the current aggregate id key entries.

    Returns all of the current aggregate id key entries.

    returns

    a map containing the aggregate ids and associated keys.

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def future(key: K): Future[V]

    Permalink
  14. def futureEntries: Future[Map[K, V]]

    Permalink
  15. def futureGet(key: K): Future[Option[V]]

    Permalink
  16. def get(key: K): Option[V]

    Permalink

    Optionally returns the aggregate id associated with a key.

    Optionally returns the aggregate id associated with a key.

    key

    the key aggregate id

    returns

    an option value containing the aggregate id associated with key in this map, or None if none exists.

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def getOrElse(key: K, default: ⇒ V): V

    Permalink

    [use case]

    [use case]
    key

    the key.

    default

    a computation that yields a default aggregate id in case no binding for key is found in the index.

    returns

    the aggregate value associated with key if it exists, otherwise the result of the default computation.

    Full Signature

    def getOrElse[V1 >: V](key: K, default: ⇒ V1): V1

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. def isDefinedAt(key: K): Boolean

    Permalink

    Tests whether this index contains a binding for a key.

    Tests whether this index contains a binding for a key. This method, which implements an abstract method of trait PartialFunction, is equivalent to contains.

    key

    the key

    returns

    true if there is a binding for key in this map, false otherwise.

  21. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped