Trait

core3.database.containers

SearchContainerCompanion

Related Doc: package containers

Permalink

trait SearchContainerCompanion extends JSONContainerCompanion

Implementation & usage trait for containers supporting search (Solr & ElasticSearch) data handling.

Linear Supertypes
JSONContainerCompanion, BasicContainerCompanion, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchContainerCompanion
  2. JSONContainerCompanion
  3. BasicContainerCompanion
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fromJsonData(data: JsValue): Container

    Permalink

    Converts the supplied JSON value to a container.

    Converts the supplied JSON value to a container.

    data

    the JSON value to be converted

    returns

    the converted container

    Definition Classes
    JSONContainerCompanion

  2. abstract def getDatabaseName(dataType: DataType): String

    Permalink

    Retrieves the container's database name for the specified data type, if supported.

    Retrieves the container's database name for the specified data type, if supported.

    dataType

    the data type

    returns

    the requested database name

    Definition Classes
    BasicContainerCompanion
    Exceptions thrown

    IllegalArgumentException if the data type is not supported

  3. abstract def getSearchFields: Map[String, String]

    Permalink

    Retrieves the container's supported search field and their corresponding data types.

    Retrieves the container's supported search field and their corresponding data types.

    returns

    the requested search field

  4. abstract def matchCustomQuery(queryName: String, queryParams: Map[String, String], container: Container): Boolean

    Permalink

    Checks if the supplied container matches the specified query name and parameters.

    Checks if the supplied container matches the specified query name and parameters.

    queryName

    the name of the query to use for the check

    queryParams

    the parameters to use for the check

    container

    the container to work with

    returns

    true, if the container matches the query

    Definition Classes
    BasicContainerCompanion
    Exceptions thrown

    IllegalArgumentException if an invalid query name is specified

    NotImplementedError if the container does not support custom query matching

  5. abstract def toJsonData(container: Container, format: JsonDataFormat): JsValue

    Permalink

    Converts the supplied container to a JSON value.

    Converts the supplied container to a JSON value.

    container

    the container to be converted

    format

    the JSON data format to use

    returns

    the container as a JSON value

    Definition Classes
    JSONContainerCompanion

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 JSONContainerCompanion

Inherited from BasicContainerCompanion

Inherited from AnyRef

Inherited from Any

Ungrouped