JAVA-2232, JAVA-2255, JAVA-2256, JAVA-2275, JAVA-2277 new pipeline stages

Author: Justin Lee

driver-core/src/main/com/mongodb/client/model/Aggregates.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2016 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.client.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+/**
+ * The options for a $bucketAuto aggregation pipeline stage
+ *
+ * @mongodb.driver.manual reference/operator/aggregation/bucketAuto/ $bucketAuto
+ * @mongodb.server.release 3.4
+ * @since 3.4
+ */
+public class BucketAutoOptions {
+    private List<BsonField> output;
+    private BucketGranularity granularity;
+
+    /**
+     * @return the granularity of the bucket definitions
+     */
+    public BucketGranularity getGranularity() {
+        return granularity;
+    }
+
+    /**
+     * @return the output document definition
+     */
+    public List<BsonField> getOutput() {
+        return output == null ? null : new ArrayList<BsonField>(output);
+    }
+
+    /**
+     * Specifies the granularity of the bucket definitions.
+     *
+     * @param granularity the granularity of the bucket definitions
+     * @return this
+     * @link the <a href="https://en.wikipedia.org/wiki/Preferred_number">wiki page</a> on preferred numbers
+     * @see BucketGranularity
+     */
+    public BucketAutoOptions granularity(final BucketGranularity granularity) {
+        this.granularity = granularity;
+        return this;
+    }
+
+    /**
+     * The definition of the output document in each bucket
+     *
+     * @param output the output document definition
+     * @return this
+     */
+    public BucketAutoOptions output(final BsonField... output) {
+        this.output = asList(output);
+        return this;
+    }
+
+    /**
+     * The definition of the output document in each bucket
+     *
+     * @param output the output document definition
+     * @return this
+     */
+    public BucketAutoOptions output(final List<BsonField> output) {
+        this.output = output;
+        return this;
+    }
+
+}

driver-core/src/main/com/mongodb/client/model/BucketAutoOptions.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2016 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.client.model;
+
+/**
+ * Granularity values for automatic bucketing.
+ *
+ * @mongodb.driver.manual reference/operator/aggregation/bucketAuto/ $bucketAuto
+ * @mongodb.server.release 3.4
+ * @link <a href="https://en.wikipedia.org/wiki/Preferred_number">Preferred numbers</a>
+ * @since 3.4
+ */
+public enum BucketGranularity {
+    R5,
+    R10,
+    R20,
+    R40,
+    R80,
+    SERIES_125("1-2-5"),
+    E6,
+    E12,
+    E24,
+    E48,
+    E96,
+    E192,
+    POWERSOF2;
+
+    private final String value;
+
+    BucketGranularity() {
+        value = name();
+    }
+
+    BucketGranularity(final String name) {
+        value = name;
+    }
+
+    /**
+     * Tries find the enum instance for the given value
+     *
+     * @param value the value to search for
+     * @return the enum instance
+     */
+    public static BucketGranularity fromString(final String value) {
+        for (BucketGranularity granularity : BucketGranularity.values()) {
+            if (granularity.getValue().equals(value)) {
+                return granularity;
+            }
+        }
+        throw new IllegalArgumentException("No Granularity exists for the value " + value);
+    }
+
+    /**
+     * Returns the display as defined in the preferred number article
+     *
+     * @return the display name
+     */
+    public String getValue() {
+        return value;
+    }
+}

driver-core/src/main/com/mongodb/client/model/BucketGranularity.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2016 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.client.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+/**
+ * The options for a $bucket aggregation pipeline stage
+ *
+ * @mongodb.driver.manual reference/operator/aggregation/bucketAuto/ $bucket
+ * @mongodb.server.release 3.4
+ * @since 3.4
+ */
+public class BucketOptions {
+    private Object defaultBucket;
+    private List<BsonField> output;
+
+    /**
+     * The name of the default bucket for values outside the defined buckets
+     *
+     * @param name the bucket value
+     * @return this
+     */
+    public BucketOptions defaultBucket(final Object name) {
+        defaultBucket = name;
+        return this;
+    }
+
+    /**
+     * @return the default bucket value
+     */
+    public Object getDefaultBucket() {
+        return defaultBucket;
+    }
+
+    /**
+     * @return the output document definition
+     */
+    public List<BsonField> getOutput() {
+        return output == null ? null : new ArrayList<BsonField>(output);
+    }
+
+    /**
+     * The definition of the output document in each bucket
+     *
+     * @param output the output document definition
+     * @return this
+     */
+    public BucketOptions output(final BsonField... output) {
+        this.output = asList(output);
+        return this;
+    }
+
+    /**
+     * The definition of the output document in each bucket
+     *
+     * @param output the output document definition
+     * @return this
+     */
+    public BucketOptions output(final List<BsonField> output) {
+        this.output = output;
+        return this;
+    }
+
+}

driver-core/src/main/com/mongodb/client/model/BucketOptions.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2016 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.mongodb.client.model;
+
+import org.bson.conversions.Bson;
+
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+/**
+ * Defines a Facet for use in $facet pipeline stages.
+ *
+ * @mongodb.driver.manual reference/operator/aggregation/facet/ $facet
+ * @mongodb.server.release 3.4
+ * @since 3.4
+ */
+public class Facet {
+    private final String name;
+    private final List<? extends Bson> pipeline;
+
+    /**
+     * @param name     the name of this facet
+     * @param pipeline the facet definition pipeline
+     */
+    public Facet(final String name, final List<? extends Bson> pipeline) {
+        this.name = name;
+        this.pipeline = pipeline;
+    }
+
+    /**
+     * @param name     the name of this facet
+     * @param pipeline the facet definition pipeline
+     */
+    public Facet(final String name, final Bson... pipeline) {
+        this(name, asList(pipeline));
+    }
+
+    /**
+     * @return the facet name
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * @return the pipeline definition
+     */
+    public List<? extends Bson> getPipeline() {
+        return pipeline;
+    }
+}