Coverage Report

Coverage Report - com.allanbank.mongodb.builder.ParallelScan

Classes in this File

Line Coverage

Branch Coverage

Complexity

ParallelScan

100%

10/10

N/A

ParallelScan$Builder

100%

17/17

N/A

 /*
  * #%L
  * ParallelScan.java - mongodb-async-driver - Allanbank Consulting, Inc.
  * %%
  * Copyright (C) 2011 - 2014 Allanbank Consulting, 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.
  * #L%
  */
 
 package com.allanbank.mongodb.builder;
 
 import com.allanbank.mongodb.ReadPreference;
 import com.allanbank.mongodb.Version;
 
 /**
  * ParallelScan provides an immutable container for all of the options for a
  * {@code parallelCollectionScan}.
  * <p>
  * <b>Note</b>: The {@code parallelCollectionScan} does not work with sharded
  * clusters.
  * <p>
  * 
  * @see <a
  *      href="http://docs.mongodb.org/manual/reference/command/parallelCollectionScan/">parallelCollectionScan
  *      Command</a>
  * @api.yes This class is part of the driver's API. Public and protected members
  *          will be deprecated for at least 1 non-bugfix release (version
  *          numbers are &lt;major&gt;.&lt;minor&gt;.&lt;bugfix&gt;) before being
  *          removed or modified.
  * @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved
  */
 public class ParallelScan {
     /**
      * The first version of MongoDB to support the
      * {@code parallelCollectionScan} command.
      */
     public static final Version REQUIRED_VERSION = Version.parse("2.6.0");
 
     /**
      * Creates a new builder for a {@link ParallelScan}.
      * 
      * @return The builder to construct a {@link ParallelScan}.
      */
     public static Builder builder() {
         return new Builder();
     }
 
     /** The number of documents to be returned in each batch of results. */
     private final int myBatchSize;
 
     /** The preference for which servers to use to retrieve the results. */
     private final ReadPreference myReadPreference;
 
     /**
      * The requested number of iterators/cursors to create. The server may
      * return few than this number of iterators.
      * <p>
      * This value will be forced into the range [1, 10,000].
      * </p>
      */
     private final int myRequestedIteratorCount;
 
     /**
      * Creates a new ParallelScan.
      * 
      * @param builder
      *            The builder to copy the query fields from.
      */
     protected ParallelScan(final Builder builder) {
         myBatchSize = builder.myBatchSize;
         myReadPreference = builder.myReadPreference;
         myRequestedIteratorCount = builder.myRequestedIteratorCount;
     }
 
     /**
      * Returns the number of documents to be returned in each batch of results.
      * 
      * @return The number of documents to be returned in each batch of results.
      */
     public int getBatchSize() {
         return myBatchSize;
     }
 
     /**
      * Returns the preference for the servers to retrieve the results from. May
      * be <code>null</code> in which case the default read preference should be
      * used.
      * 
      * @return The preference for the servers to retrieve the results from.
      */
     public ReadPreference getReadPreference() {
         return myReadPreference;
     }
 
     /**
      * Returns the requested number of iterators/cursors to create. The server
      * may return few than this number of iterators.
      * <p>
      * This value will be forced into the range [1, 10,000].
      * </p>
      * 
      * @return The requested number of iterators/cursors to create.
      */
     public int getRequestedIteratorCount() {
         return myRequestedIteratorCount;
     }
 
     /**
      * Helper for creating immutable {@link ParallelScan} queries.
      * 
      * @api.yes This class is part of the driver's API. Public and protected
      *          members will be deprecated for at least 1 non-bugfix release
      *          (version numbers are &lt;major&gt;.&lt;minor&gt;.&lt;bugfix&gt;)
      *          before being removed or modified.
      * @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved
      */
     public static class Builder {
 
         /** The number of documents to be returned in each batch of results. */
         protected int myBatchSize;
 
         /** The preference for which servers to use to retrieve the results. */
         protected ReadPreference myReadPreference;
 
         /**
          * The desired number of iterators/cursors to create. The server may
          * return few than this number of iterators.
          * <p>
          * This value will be forced into the range [1, 10,000].
          * </p>
          */
         protected int myRequestedIteratorCount;
 
         /**
          * Creates a new Builder.
          */
         public Builder() {
             reset();
         }
 
         /**
          * Sets the value of the number of documents to be returned in each
          * batch.
          * <p>
          * This method delegates to {@link #setBatchSize(int)}.
          * </p>
          * 
          * @param batchSize
          *            The new value for the number of documents to be returned
          *            in each batch.
          * @return This builder for chaining method calls.
          */
         public Builder batchSize(final int batchSize) {
             return setBatchSize(batchSize);
         }
 
         /**
          * Constructs a new {@link ParallelScan} object from the state of the
          * builder.
          * 
          * @return The new {@link ParallelScan} object.
          */
         public ParallelScan build() {
             return new ParallelScan(this);
         }
 
         /**
          * Sets the preference for the set of servers to retrieve the results
          * from.
          * <p>
          * This method delegates to {@link #setReadPreference(ReadPreference)}.
          * </p>
          * 
          * @param readPreference
          *            The new value for the preference of which server to return
          *            the results from.
          * @return This builder for chaining method calls.
          */
         public Builder readPreference(final ReadPreference readPreference) {
             return setReadPreference(readPreference);
         }
 
         /**
          * Sets the requested number of iterators/cursors to create to the new
          * value.
          * <p>
          * This value will be forced into the range [1, 10,000].
          * </p>
          * <p>
          * This method delegates to {@link #setRequestedIteratorCount(int)}.
          * </p>
          * 
          * @param numberOfIterators
          *            The requested number of iterators/cursors to create.
          * @return This builder for chaining method calls.
          */
         public Builder requestedIteratorCount(final int numberOfIterators) {
             return setRequestedIteratorCount(numberOfIterators);
         }
 
         /**
          * Resets the builder back to its initial state for reuse.
          * 
          * @return This builder for chaining method calls.
          */
         public Builder reset() {
             myBatchSize = 0;
             myReadPreference = null;
             myRequestedIteratorCount = 1;
 
             return this;
         }
 
         /**
          * Sets the value of the number of documents to be returned in each
          * batch.
          * 
          * @param batchSize
          *            The new value for the number of documents to be returned
          *            in each batch.
          * @return This builder for chaining method calls.
          */
         public Builder setBatchSize(final int batchSize) {
             myBatchSize = batchSize;
             return this;
         }
 
         /**
          * Sets the preference for the set of servers to retrieve the results
          * from.
          * 
          * @param readPreference
          *            The new value for the preference of which server to return
          *            the results from.
          * @return This builder for chaining method calls.
          */
         public Builder setReadPreference(final ReadPreference readPreference) {
             myReadPreference = readPreference;
             return this;
         }
 
         /**
          * Sets the requested number of iterators/cursors to create to the new
          * value.
          * <p>
          * This value will be forced into the range [1, 10,000].
          * </p>
          * 
          * @param numberOfIterators
          *            The requested number of iterators/cursors to create.
          * @return This builder for chaining method calls.
          */
         public Builder setRequestedIteratorCount(final int numberOfIterators) {
             myRequestedIteratorCount = Math.min(Math.max(numberOfIterators, 1),
                     10000);
             return this;
         }
     }
 }

1		/*
2		* #%L
3		* ParallelScan.java - mongodb-async-driver - Allanbank Consulting, Inc.
4		* %%
5		* Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6		* %%
7		* Licensed under the Apache License, Version 2.0 (the "License");
8		* you may not use this file except in compliance with the License.
9		* You may obtain a copy of the License at
10		*
11		* http://www.apache.org/licenses/LICENSE-2.0
12		*
13		* Unless required by applicable law or agreed to in writing, software
14		* distributed under the License is distributed on an "AS IS" BASIS,
15		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16		* See the License for the specific language governing permissions and
17		* limitations under the License.
18		* #L%
19		*/
20
21		package com.allanbank.mongodb.builder;
22
23		import com.allanbank.mongodb.ReadPreference;
24		import com.allanbank.mongodb.Version;
25
26		/**
27		* ParallelScan provides an immutable container for all of the options for a
28		* {@code parallelCollectionScan}.
29		* <p>
30		* <b>Note</b>: The {@code parallelCollectionScan} does not work with sharded
31		* clusters.
32		* <p>
33		*
34		* @see <a
35		* href="http://docs.mongodb.org/manual/reference/command/parallelCollectionScan/">parallelCollectionScan
36		* Command</a>
37		* @api.yes This class is part of the driver's API. Public and protected members
38		* will be deprecated for at least 1 non-bugfix release (version
39		* numbers are <major>.<minor>.<bugfix>) before being
40		* removed or modified.
41		* @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved
42		*/
43		public class ParallelScan {
44		/**
45		* The first version of MongoDB to support the
46		* {@code parallelCollectionScan} command.
47		*/
48	1	public static final Version REQUIRED_VERSION = Version.parse("2.6.0");
49
50		/**
51		* Creates a new builder for a {@link ParallelScan}.
52		*
53		* @return The builder to construct a {@link ParallelScan}.
54		*/
55		public static Builder builder() {
56	7	return new Builder();
57		}
58
59		/** The number of documents to be returned in each batch of results. */
60		private final int myBatchSize;
61
62		/** The preference for which servers to use to retrieve the results. */
63		private final ReadPreference myReadPreference;
64
65		/**
66		* The requested number of iterators/cursors to create. The server may
67		* return few than this number of iterators.
68		* <p>
69		* This value will be forced into the range [1, 10,000].
70		* </p>
71		*/
72		private final int myRequestedIteratorCount;
73
74		/**
75		* Creates a new ParallelScan.
76		*
77		* @param builder
78		* The builder to copy the query fields from.
79		*/
80	13	protected ParallelScan(final Builder builder) {
81	13	myBatchSize = builder.myBatchSize;
82	13	myReadPreference = builder.myReadPreference;
83	13	myRequestedIteratorCount = builder.myRequestedIteratorCount;
84	13	}
85
86		/**
87		* Returns the number of documents to be returned in each batch of results.
88		*
89		* @return The number of documents to be returned in each batch of results.
90		*/
91		public int getBatchSize() {
92	7	return myBatchSize;
93		}
94
95		/**
96		* Returns the preference for the servers to retrieve the results from. May
97		* be <code>null</code> in which case the default read preference should be
98		* used.
99		*
100		* @return The preference for the servers to retrieve the results from.
101		*/
102		public ReadPreference getReadPreference() {
103	6	return myReadPreference;
104		}
105
106		/**
107		* Returns the requested number of iterators/cursors to create. The server
108		* may return few than this number of iterators.
109		* <p>
110		* This value will be forced into the range [1, 10,000].
111		* </p>
112		*
113		* @return The requested number of iterators/cursors to create.
114		*/
115		public int getRequestedIteratorCount() {
116	6	return myRequestedIteratorCount;
117		}
118
119		/**
120		* Helper for creating immutable {@link ParallelScan} queries.
121		*
122		* @api.yes This class is part of the driver's API. Public and protected
123		* members will be deprecated for at least 1 non-bugfix release
124		* (version numbers are <major>.<minor>.<bugfix>)
125		* before being removed or modified.
126		* @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved
127		*/
128		public static class Builder {
129
130		/** The number of documents to be returned in each batch of results. */
131		protected int myBatchSize;
132
133		/** The preference for which servers to use to retrieve the results. */
134		protected ReadPreference myReadPreference;
135
136		/**
137		* The desired number of iterators/cursors to create. The server may
138		* return few than this number of iterators.
139		* <p>
140		* This value will be forced into the range [1, 10,000].
141		* </p>
142		*/
143		protected int myRequestedIteratorCount;
144
145		/**
146		* Creates a new Builder.
147		*/
148	9	public Builder() {
149	9	reset();
150	9	}
151
152		/**
153		* Sets the value of the number of documents to be returned in each
154		* batch.
155		* <p>
156		* This method delegates to {@link #setBatchSize(int)}.
157		* </p>
158		*
159		* @param batchSize
160		* The new value for the number of documents to be returned
161		* in each batch.
162		* @return This builder for chaining method calls.
163		*/
164		public Builder batchSize(final int batchSize) {
165	1	return setBatchSize(batchSize);
166		}
167
168		/**
169		* Constructs a new {@link ParallelScan} object from the state of the
170		* builder.
171		*
172		* @return The new {@link ParallelScan} object.
173		*/
174		public ParallelScan build() {
175	13	return new ParallelScan(this);
176		}
177
178		/**
179		* Sets the preference for the set of servers to retrieve the results
180		* from.
181		* <p>
182		* This method delegates to {@link #setReadPreference(ReadPreference)}.
183		* </p>
184		*
185		* @param readPreference
186		* The new value for the preference of which server to return
187		* the results from.
188		* @return This builder for chaining method calls.
189		*/
190		public Builder readPreference(final ReadPreference readPreference) {
191	3	return setReadPreference(readPreference);
192		}
193
194		/**
195		* Sets the requested number of iterators/cursors to create to the new
196		* value.
197		* <p>
198		* This value will be forced into the range [1, 10,000].
199		* </p>
200		* <p>
201		* This method delegates to {@link #setRequestedIteratorCount(int)}.
202		* </p>
203		*
204		* @param numberOfIterators
205		* The requested number of iterators/cursors to create.
206		* @return This builder for chaining method calls.
207		*/
208		public Builder requestedIteratorCount(final int numberOfIterators) {
209	7	return setRequestedIteratorCount(numberOfIterators);
210		}
211
212		/**
213		* Resets the builder back to its initial state for reuse.
214		*
215		* @return This builder for chaining method calls.
216		*/
217		public Builder reset() {
218	9	myBatchSize = 0;
219	9	myReadPreference = null;
220	9	myRequestedIteratorCount = 1;
221
222	9	return this;
223		}
224
225		/**
226		* Sets the value of the number of documents to be returned in each
227		* batch.
228		*
229		* @param batchSize
230		* The new value for the number of documents to be returned
231		* in each batch.
232		* @return This builder for chaining method calls.
233		*/
234		public Builder setBatchSize(final int batchSize) {
235	2	myBatchSize = batchSize;
236	2	return this;
237		}
238
239		/**
240		* Sets the preference for the set of servers to retrieve the results
241		* from.
242		*
243		* @param readPreference
244		* The new value for the preference of which server to return
245		* the results from.
246		* @return This builder for chaining method calls.
247		*/
248		public Builder setReadPreference(final ReadPreference readPreference) {
249	5	myReadPreference = readPreference;
250	5	return this;
251		}
252
253		/**
254		* Sets the requested number of iterators/cursors to create to the new
255		* value.
256		* <p>
257		* This value will be forced into the range [1, 10,000].
258		* </p>
259		*
260		* @param numberOfIterators
261		* The requested number of iterators/cursors to create.
262		* @return This builder for chaining method calls.
263		*/
264		public Builder setRequestedIteratorCount(final int numberOfIterators) {
265	9	myRequestedIteratorCount = Math.min(Math.max(numberOfIterators, 1),
266		10000);
267	9	return this;
268		}
269		}
270		}