Packages

o

org.mongodb.scala.model.search

SearchHighlight

object SearchHighlight

Highlighting options. You may use the $meta: "searchHighlights" expression, e.g., via Projections.metaSearchHighlights, to extract the results of highlighting.

Annotations
@Beta()
Since

4.7

See also

Highlighting

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

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def of(highlight: Bson): SearchHighlight

    Creates a SearchHighlight from a Bson in situations when there is no builder method that better satisfies your needs.

    Creates a SearchHighlight from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

    Example
    The following code creates two functionally equivalent SearchHighlights, though they may not be equal.

    val highlight1: SearchHighlight = SearchHighlight.paths(
  SearchPath.fieldPath("fieldName"),
  SearchPath.wildcardPath("wildc*rd"))
val highlight2: SearchHighlight = SearchHighlight.of(Document("path" -> Seq(
  SearchPath.fieldPath("fieldName").toBsonValue,
  SearchPath.wildcardPath("wildc*rd").toBsonValue)))
    highlight

    A Bson representing the required SearchHighlight.

    returns

    The requested SearchHighlight.

  15. def paths(paths: Iterable[_ <: SearchPath]): SearchHighlight

    Returns a SearchHighlight for the given paths.

    Returns a SearchHighlight for the given paths.

    paths

    The non-empty fields to be searched.

    returns

    The requested SearchHighlight.

  16. def paths(path: SearchPath, paths: SearchPath*): SearchHighlight

    Returns a SearchHighlight for the given paths.

    Returns a SearchHighlight for the given paths.

    path

    The field to be searched.

    paths

    More fields to be searched.

    returns

    The requested SearchHighlight.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped