Coverage Report

Coverage Report - com.allanbank.mongodb.client.message.QueryVersionVisitor

Classes in this File

Line Coverage

Branch Coverage

Complexity

QueryVersionVisitor

100%

24/24

100%

16/16

2.6

 /*
  * #%L
  * QueryVersionVisitor.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.client.message;
 
 import com.allanbank.mongodb.Version;
 import com.allanbank.mongodb.bson.Document;
 import com.allanbank.mongodb.bson.VisitorAdapter;
 import com.allanbank.mongodb.builder.Find;
 import com.allanbank.mongodb.builder.GeospatialOperator;
 import com.allanbank.mongodb.builder.MiscellaneousOperator;
 import com.allanbank.mongodb.client.VersionRange;
 
 /**
  * QueryVersionVisitor provides the ability to inspect a query document for the
  * required server version.
  * 
  * @copyright 2013, Allanbank Consulting, Inc., All Rights Reserved
  */
 public class QueryVersionVisitor extends VisitorAdapter {
 
     /**
      * Helper to returns the required server version to support the query
      * operators.
      * 
      * @param query
      *            The query to inspect.
      * @return The version of the server that is required to support to support
      *         the query. May be {@code null}.
      */
     public static VersionRange version(final Document query) {
         final QueryVersionVisitor visitor = new QueryVersionVisitor();
 
         if (query != null) {
             query.accept(visitor);
         }
 
         return VersionRange.range(visitor.getRequiredServerVersion(),
                 visitor.getMaximumServerVersion());
     }
 
     /**
      * The version of the server that removed the ability to process the visited
      * query.
      */
     private Version myMaximumServerVersion;
 
     /** The required server version to support the query. */
     private Version myRequiredServerVersion;
 
     /**
      * Creates a new QueryVersionVisitor.
      */
     public QueryVersionVisitor() {
         myRequiredServerVersion = null;
     }
 
     /**
      * Returns the version of the server that removed the ability to process the
      * visited query.
      * 
      * @return The version of the server that removed the ability to process the
      *         visited query.
      */
     public Version getMaximumServerVersion() {
         return myMaximumServerVersion;
     }
 
     /**
      * Returns the required server version to support the visited query.
      * 
      * @return The required server version to support the visited query.
      */
     public Version getRequiredServerVersion() {
         return myRequiredServerVersion;
     }
 
     /**
      * <p>
      * Overridden to determine the version of the server required based on the
      * query operators.
      * </p>
      * {@inheritDoc}
      */
     @SuppressWarnings("deprecation")
     @Override
     protected void visitName(final String name) {
         if (GeospatialOperator.GEO_WITHIN.getToken().equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     GeospatialOperator.GEO_WITHIN.getVersion());
         }
         else if (GeospatialOperator.INTERSECT.getToken().equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     GeospatialOperator.INTERSECT.getVersion());
         }
         else if (GeospatialOperator.POLYGON.equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     GeospatialOperator.POLYGON_VERSION);
         }
         else if ("$maxTimeMS".equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     Find.MAX_TIMEOUT_VERSION);
         }
         else if (MiscellaneousOperator.COMMENT.getToken().equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     MiscellaneousOperator.COMMENT.getVersion());
         }
         else if (MiscellaneousOperator.TEXT.getToken().equals(name)) {
             myRequiredServerVersion = Version.later(myRequiredServerVersion,
                     MiscellaneousOperator.TEXT.getVersion());
         }
         else if (GeospatialOperator.UNIQUE_DOCS_MODIFIER.equals(name)) {
             myMaximumServerVersion = Version.earlier(myMaximumServerVersion,
                     GeospatialOperator.UNIQUE_DOCS_REMOVED_VERSION);
         }
     }
 }

1		/*
2		* #%L
3		* QueryVersionVisitor.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		package com.allanbank.mongodb.client.message;
21
22		import com.allanbank.mongodb.Version;
23		import com.allanbank.mongodb.bson.Document;
24		import com.allanbank.mongodb.bson.VisitorAdapter;
25		import com.allanbank.mongodb.builder.Find;
26		import com.allanbank.mongodb.builder.GeospatialOperator;
27		import com.allanbank.mongodb.builder.MiscellaneousOperator;
28		import com.allanbank.mongodb.client.VersionRange;
29
30		/**
31		* QueryVersionVisitor provides the ability to inspect a query document for the
32		* required server version.
33		*
34		* @copyright 2013, Allanbank Consulting, Inc., All Rights Reserved
35		*/
36		public class QueryVersionVisitor extends VisitorAdapter {
37
38		/**
39		* Helper to returns the required server version to support the query
40		* operators.
41		*
42		* @param query
43		* The query to inspect.
44		* @return The version of the server that is required to support to support
45		* the query. May be {@code null}.
46		*/
47		public static VersionRange version(final Document query) {
48	2339	final QueryVersionVisitor visitor = new QueryVersionVisitor();
49
50	2339	if (query != null) {
51	2335	query.accept(visitor);
52		}
53
54	2339	return VersionRange.range(visitor.getRequiredServerVersion(),
55		visitor.getMaximumServerVersion());
56		}
57
58		/**
59		* The version of the server that removed the ability to process the visited
60		* query.
61		*/
62		private Version myMaximumServerVersion;
63
64		/** The required server version to support the query. */
65		private Version myRequiredServerVersion;
66
67		/**
68		* Creates a new QueryVersionVisitor.
69		*/
70	2339	public QueryVersionVisitor() {
71	2339	myRequiredServerVersion = null;
72	2339	}
73
74		/**
75		* Returns the version of the server that removed the ability to process the
76		* visited query.
77		*
78		* @return The version of the server that removed the ability to process the
79		* visited query.
80		*/
81		public Version getMaximumServerVersion() {
82	2339	return myMaximumServerVersion;
83		}
84
85		/**
86		* Returns the required server version to support the visited query.
87		*
88		* @return The required server version to support the visited query.
89		*/
90		public Version getRequiredServerVersion() {
91	2339	return myRequiredServerVersion;
92		}
93
94		/**
95		* <p>
96		* Overridden to determine the version of the server required based on the
97		* query operators.
98		* </p>
99		* {@inheritDoc}
100		*/
101		@SuppressWarnings("deprecation")
102		@Override
103		protected void visitName(final String name) {
104	2557	if (GeospatialOperator.GEO_WITHIN.getToken().equals(name)) {
105	2	myRequiredServerVersion = Version.later(myRequiredServerVersion,
106		GeospatialOperator.GEO_WITHIN.getVersion());
107		}
108	2555	else if (GeospatialOperator.INTERSECT.getToken().equals(name)) {
109	1	myRequiredServerVersion = Version.later(myRequiredServerVersion,
110		GeospatialOperator.INTERSECT.getVersion());
111		}
112	2554	else if (GeospatialOperator.POLYGON.equals(name)) {
113	1	myRequiredServerVersion = Version.later(myRequiredServerVersion,
114		GeospatialOperator.POLYGON_VERSION);
115		}
116	2553	else if ("$maxTimeMS".equals(name)) {
117	1	myRequiredServerVersion = Version.later(myRequiredServerVersion,
118		Find.MAX_TIMEOUT_VERSION);
119		}
120	2552	else if (MiscellaneousOperator.COMMENT.getToken().equals(name)) {
121	1	myRequiredServerVersion = Version.later(myRequiredServerVersion,
122		MiscellaneousOperator.COMMENT.getVersion());
123		}
124	2551	else if (MiscellaneousOperator.TEXT.getToken().equals(name)) {
125	1	myRequiredServerVersion = Version.later(myRequiredServerVersion,
126		MiscellaneousOperator.TEXT.getVersion());
127		}
128	2550	else if (GeospatialOperator.UNIQUE_DOCS_MODIFIER.equals(name)) {
129	1	myMaximumServerVersion = Version.earlier(myMaximumServerVersion,
130		GeospatialOperator.UNIQUE_DOCS_REMOVED_VERSION);
131		}
132	2557	}
133		}