Packages

object SearchFacet

A facet definition for FacetSearchCollector.

Annotations
@Beta()
Since

4.7

See also

Facet definition

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchFacet
  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. def combineToBson(facets: Iterable[_ <: SearchFacet]): Bson

    Combines SearchFacets into a Bson.

    Combines SearchFacets into a Bson.

    This method may be useful when using SearchCollector.of.

    facets

    The non-empty facet definitions to combine.

    returns

    A Bson representing combined facets.

  7. def dateFacet(name: String, path: FieldSearchPath, boundaries: Iterable[Instant]): DateSearchFacet

    Returns a SearchFacet that allows determining the frequency of BSON Date values in the search results by breaking the results into separate ranges.

    Returns a SearchFacet that allows determining the frequency of BSON Date values in the search results by breaking the results into separate ranges.

    name

    The facet name.

    path

    The path to facet on.

    boundaries

    Bucket boundaries in ascending order. Must contain at least two boundaries.

    returns

    The requested SearchFacet.

    See also

    Date facet definition

    org.bson.codecs.jsr310.InstantCodec

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. def numberFacet(name: String, path: FieldSearchPath, boundaries: Iterable[Number]): NumberSearchFacet

    Returns a SearchFacet that allows determining the frequency of BSON 32-bit integer / 64-bit integer / Double values in the search results by breaking the results into separate ranges.

    Returns a SearchFacet that allows determining the frequency of BSON 32-bit integer / 64-bit integer / Double values in the search results by breaking the results into separate ranges.

    name

    The facet name.

    path

    The path to facet on.

    boundaries

    Bucket boundaries in ascending order. Must contain at least two boundaries.

    returns

    The requested SearchFacet.

    See also

    Numeric facet definition

  17. def of(facet: Bson): SearchFacet

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

    Creates a SearchFacet 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 SearchFacets, though they may not be equal.

    val facet1: SearchFacet = SearchFacet.stringFacet("facetName",
  SearchPath.fieldPath("fieldName"))
val facet2: SearchFacet = SearchFacet.of(Document("facetName" -> Document("type" -> "string",
  "path" -> SearchPath.fieldPath("fieldName").toValue)))
    facet

    A Bson representing the required SearchFacet.

    returns

    The requested SearchFacet.

  18. def stringFacet(name: String, path: FieldSearchPath): StringSearchFacet

    Returns a SearchFacet that allows narrowing down search results based on the most frequent BSON String values of the specified field.

    Returns a SearchFacet that allows narrowing down search results based on the most frequent BSON String values of the specified field.

    name

    The facet name.

    path

    The field to facet on.

    returns

    The requested SearchFacet.

    See also

    String facet definition

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. 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