[Scala] Add additional SearchOperator helper methods for the rest of the Atlas Search operators (#121)

* helper methods

* content

* ref link

* wip

* wip

* Update whats-new.txt

* WIP

---------

Co-authored-by: Rea Rustagi <[email protected]>
Co-authored-by: rustagir <[email protected]>

Author: rachel-mack

source/aggregation.txt

@@ -195,7 +195,7 @@ plan:
       ...}
 
 Run an Atlas Full-Text Search
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------
 
 .. tip:: Only Available on Atlas for MongoDB v4.2 and later
 
@@ -244,6 +244,34 @@ This example creates pipeline stages to perform the following actions:
     placeholder with the name of the index. To learn more about Atlas Search indexes, see
     the :ref:`scala-atlas-search-index` guide.
 
+.. _scala-atlas-search-helper-methods:
+
+Search Operator Helper Methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. sharedinclude:: dbx/jvm/atlas-search-operator-helpers.rst
+
+   .. replacement:: as-idx-link
+
+      the :ref:`scala-atlas-search-index` guide
+
+   .. replacement:: atlas-query-operators-example
+
+      .. io-code-block::
+
+         .. input:: /includes/aggregation.scala
+            :language: scala
+            :start-after: // start-atlas-helper-methods
+            :end-before: // end-atlas-helper-methods
+            :dedent:
+
+         .. output::
+            :language: console
+            :visible: false
+
+            {"_id": ..., "genres": ["Comedy", "Romance"], "title": "Love at First Bite", "year": 1979}
+            {"_id": ..., "genres": ["Comedy", "Drama"], "title": "Love Affair", "year": 1994}
+
 Additional Information
 ----------------------
 
@@ -282,4 +310,3 @@ following API documentation:
 - `aggregate() <{+driver-api+}/MongoCollection.html#aggregate[C](pipeline:Seq[org.mongodb.scala.bson.conversions.Bson])(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[C,TResult],implicitct:scala.reflect.ClassTag[C]):org.mongodb.scala.AggregateObservable[C]>`__
 - `Aggregates <{+driver-api+}/model/Aggregates$.html>`__
 - `explain() <{+driver-api+}/AggregateObservable.html#explain[ExplainResult](verbosity:com.mongodb.ExplainVerbosity)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[ExplainResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[ExplainResult]):org.mongodb.scala.SingleObservable[ExplainResult]>`__
-

source/includes/aggregation.scala

@@ -5,6 +5,8 @@ import com.mongodb.ExplainVerbosity
 import org.mongodb.scala.model.Projections
 import org.mongodb.scala.model.search._
 import org.mongodb.scala.model.search.SearchOptions.searchOptions
+import org.mongodb.scala.model.search.SearchPath.fieldPath
+import scala.jdk.CollectionConverters._
 
 object Aggregation {
 
@@ -50,6 +52,29 @@ object Aggregation {
                         (e: Throwable) => println(s"There was an error: $e"))
     // end-atlas-search
 
+    // start-atlas-helper-methods
+    val searchStage = Aggregates.search(
+      SearchOperator.compound()
+        .must(
+          Iterable(
+            SearchOperator.in(fieldPath("genres"), List("Comedy")),
+            SearchOperator.phrase(fieldPath("fullplot"), "new york"),
+            SearchOperator.numberRange(fieldPath("year")).gtLt(1950, 2000),
+            SearchOperator.wildcard("Love *", fieldPath("title")),
+          ).asJava
+        )
+    )
+
+    val projectStage = Aggregates.project(
+      Projections.include("title", "year", "genres"))
+
+    val aggregatePipelineStages = Seq(searchStage, projectStage)
+
+    collection.aggregate(aggregatePipelineStages)
+      .subscribe((doc: Document) => println(doc.toJson()),
+        (e: Throwable) => println(s"There was an error: $e"))
+    // end-atlas-helper-methods
+
     Thread.sleep(1000)
     mongoClient.close()
   }

source/whats-new.txt

@@ -62,8 +62,8 @@ and features:
 
    .. replacement:: atlas-query-operators
 
-      the `SearchOperator <{+core-api+}/client/model/search/SearchOperator.html>`__
-      interface API documentation
+      the :ref:`scala-atlas-search-helper-methods` section of the
+      Aggregation guide
 
 .. _scala-version-5.3: