Class

core3.database.dals

DatabaseAbstractionLayer

Related Doc: package dals

Permalink

class DatabaseAbstractionLayer extends AnyRef

A wrapper class for sending requests to core3.database.dals.DatabaseAbstractionLayerComponent actors.

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

Instance Constructors

  1. new DatabaseAbstractionLayer(actor: ActorRef)(implicit ec: ExecutionContext, timeout: Timeout)

    Permalink

    actor

    the actor to be used for all requests

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 buildDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink

    Builds the the database structure.

    Builds the the database structure.

    Note: An empty database is expected.

    objectsType

    denotes which database/table to be created

    returns

    true, if the operation was successful

  6. def clearDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink

    Clears the database structure.

    Clears the database structure.

    Note: All data, tables, databases, etc, are destroyed.

    objectsType

    denotes which database/table to be removed

    returns

    true, if the operation was successful

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createObject(container: Container): Future[Boolean]

    Permalink

    Creates a new entry for the supplied object in the database.

    Creates a new entry for the supplied object in the database.

    container

    the object data

    returns

    true, if the operation was successful

  9. def deleteObject(objectType: ContainerType, objectID: ObjectID): Future[Boolean]

    Permalink

    Deletes the specified object form the database.

    Deletes the specified object form the database.

    objectType

    the type of the object to be deleted

    objectID

    the ID of the object

    returns

    true, if the operation was successful

  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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getDatabaseIdentifier: String

    Permalink

    Retrieves a database identification string, for information/debugging purposes.

    Retrieves a database identification string, for information/debugging purposes.

    returns

    the identifier string

  15. def getLayerType: LayerType

    Permalink

    Retrieves the type of the Database Abstraction Layer.

    Retrieves the type of the Database Abstraction Layer.

    returns

    the layer type

  16. def getObject(objectType: ContainerType, objectID: ObjectID): Future[Container]

    Permalink

    Retrieves the specified object.

    Retrieves the specified object.

    objectType

    the type of the object to be retrieved

    objectID

    the ID of the object to be retrieved

    returns

    the requested object

  17. def getRef: ActorRef

    Permalink

    Retrieves the underlying akka.actor.ActorRef.

    Retrieves the underlying akka.actor.ActorRef.

    returns

    the actor ref

  18. def getSupportedContainers: Vector[ContainerType]

    Permalink

    Retrieves a list of containers supported by the database.

    Retrieves a list of containers supported by the database.

    returns

    the list of supported containers

  19. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  21. def loadView(view: ContainerView)(implicit ec: ExecutionContext): Future[Unit]

    Permalink

    Performs all queries defined in the supplied view and loads the resulting data in it.

    Performs all queries defined in the supplied view and loads the resulting data in it.

    view

    the view to load

    returns

    nothing (the supplied object is updated)

  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. def queryDatabase(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]): Future[ContainerSet]

    Permalink

    Performs a custom database query.

    Performs a custom database query.

    objectsType

    the type of objects to be queried

    customQueryName

    the custom query name to be performed

    queryParams

    the query parameters

    returns

    a container set based on the query results

  26. def queryDatabase(objectsType: ContainerType): Future[ContainerSet]

    Permalink

    Performs a generic database query that retrieves all data.

    Performs a generic database query that retrieves all data.

    objectsType

    the type of objects to be queried

    returns

    a container set based on the query results

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. def updateObject(container: MutableContainer): Future[Boolean]

    Permalink

    Updates the existing entry for the supplied object in the database.

    Updates the existing entry for the supplied object in the database.

    Note: Immutable containers cannot be updated.

    container

    the object data

    returns

    true, if the operation was successful

  30. def verifyDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink

    Verifies the structure of the database.

    Verifies the structure of the database.

    objectsType

    denotes which database/table to be verified

    returns

    true, if the structure is valid

  31. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped