From b72be062506c22cb79dd904bd032aa45fe738604 Mon Sep 17 00:00:00 2001 From: gustavodegeus Date: Sun, 26 Mar 2017 19:43:57 -0400 Subject: [PATCH 1/4] DATAMONGO-1325 - Added $sample Aggregation Operator --- .../mongodb/core/aggregation/Aggregation.java | 10 ++++ .../core/aggregation/SampleOperation.java | 54 ++++++++++++++++++ .../aggregation/SampleOperationUnitTests.java | 56 +++++++++++++++++++ 3 files changed, 120 insertions(+) create mode 100644 spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java create mode 100644 spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java index 4798d1e1fc..c7bba6c761 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java @@ -384,6 +384,16 @@ public static LimitOperation limit(long maxElements) { return new LimitOperation(maxElements); } + /** + * Creates a new {@link SampleOperation} to selects the specified number of documents from its input randomly. + * + * @param maxElements must not be less than zero. + * @return + */ + public static SampleOperation sample(long sampleSize) { + return new SampleOperation(sampleSize); + } + /** * Creates a new {@link MatchOperation} using the given {@link Criteria}. * diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java new file mode 100644 index 0000000000..6fc484ef40 --- /dev/null +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2017 the original author or authors. + * + * 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 org.springframework.data.mongodb.core.aggregation; + +import org.springframework.util.Assert; + +import com.mongodb.BasicDBObject; +import com.mongodb.DBObject; + +/** + * Encapsulates the {@code $sample}-operation. + *

+ * We recommend to use the static factory method {@link Aggregation#sample(long)} instead of creating instances of this + * class directly. + * + * @author Gustavo de Geus + * @since 2.0 + * @see MongoDB Aggregation Framework: $sample + */ +public class SampleOperation implements AggregationOperation { + + private final long sampleSize; + + /** + * @param sampleSize Number of documents to consider. + */ + public SampleOperation(long sampleSize) { + + Assert.isTrue(sampleSize > 0, "Sample size must be greater than zero!"); + this.sampleSize = sampleSize; + } + + /* + * (non-Javadoc) + * @see org.springframework.data.mongodb.core.aggregation.AggregationOperation#toDBObject(org.springframework.data.mongodb.core.aggregation.AggregationOperationContext) + */ + @Override + public DBObject toDBObject(AggregationOperationContext context) { + return new BasicDBObject("$sample", new BasicDBObject("size", this.sampleSize)); + } +} diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java new file mode 100644 index 0000000000..b0d5fd8e27 --- /dev/null +++ b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java @@ -0,0 +1,56 @@ +/* + * Copyright 2013 the original author or authors. + * + * 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 org.springframework.data.mongodb.core.aggregation; + +import static org.hamcrest.CoreMatchers.*; +import static org.junit.Assert.*; + +import org.junit.Test; + +import com.mongodb.BasicDBObject; +import com.mongodb.DBObject; + +/** + * Unit tests for {@link SampleOperation}. + * + * @author Gustavo de Geus + */ +public class SampleOperationUnitTests { + + private static final String SIZE = "size"; + private static final String OP = "$sample"; + + @Test(expected = IllegalArgumentException.class) + public void rejectsNegativeSample() { + new SampleOperation(-1L); + } + + @Test(expected = IllegalArgumentException.class) + public void rejectsZeroSample() { + new SampleOperation(0L); + } + + @Test + public void rendersSampleOperation() { + long sampleSize = 5L; + SampleOperation sampleOperation = Aggregation.sample(sampleSize); + DBObject sampleOperationDbObject = sampleOperation.toDBObject(Aggregation.DEFAULT_CONTEXT); + assertNotNull(sampleOperationDbObject.get(OP)); + assertThat(sampleOperationDbObject.get(OP), is(instanceOf(BasicDBObject.class))); + BasicDBObject sampleSizeDbObject = (BasicDBObject) sampleOperationDbObject.get(OP); + assertEquals(sampleSize, sampleSizeDbObject.get(SIZE)); + } +} From 4f50d763f62b3abc961533e4ea13691e656a30f5 Mon Sep 17 00:00:00 2001 From: gustavodegeus Date: Sun, 26 Mar 2017 19:46:20 -0400 Subject: [PATCH 2/4] Adjusting javadoc --- .../data/mongodb/core/aggregation/Aggregation.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java index c7bba6c761..8543c5d421 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java @@ -53,6 +53,7 @@ * @author Alessio Fachechi * @author Christoph Strobl * @author Nikolay Bogdanov + * @author Gustavo de Geus * @since 1.3 */ public class Aggregation { @@ -387,7 +388,7 @@ public static LimitOperation limit(long maxElements) { /** * Creates a new {@link SampleOperation} to selects the specified number of documents from its input randomly. * - * @param maxElements must not be less than zero. + * @param sampleSize must not be less than zero. * @return */ public static SampleOperation sample(long sampleSize) { From 757d8d5a1132e656ba6498f2d37279cd6d2ffda2 Mon Sep 17 00:00:00 2001 From: gustavodegeus Date: Sun, 26 Mar 2017 19:48:56 -0400 Subject: [PATCH 3/4] Adding parameter doc --- .../data/mongodb/core/aggregation/SampleOperation.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java index 6fc484ef40..d49ae75720 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SampleOperation.java @@ -35,7 +35,7 @@ public class SampleOperation implements AggregationOperation { private final long sampleSize; /** - * @param sampleSize Number of documents to consider. + * @param sampleSize number of documents to be randomly selected from its input. */ public SampleOperation(long sampleSize) { From b6c1c7e25cf7df7effdc5831bb04d5fd3c11f87e Mon Sep 17 00:00:00 2001 From: gustavodegeus Date: Sun, 26 Mar 2017 19:51:55 -0400 Subject: [PATCH 4/4] Adjusting license date --- .../data/mongodb/core/aggregation/SampleOperationUnitTests.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java index b0d5fd8e27..749304a2cf 100644 --- a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java +++ b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SampleOperationUnitTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2013 the original author or authors. + * Copyright 2017 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.