Added Query.orderKey()

stickfigure · stickfigure · commit 27670c338090 · 2014-04-20T10:21:57.000-07:00
Also removed QueryWrapper.
diff --git a/src/main/java/com/googlecode/objectify/cmd/Query.java b/src/main/java/com/googlecode/objectify/cmd/Query.java
@@ -54,24 +54,30 @@ public interface Query<T> extends SimpleQuery<T>
 	 */
 	public Query<T> filter(Filter filter);
 
+	/* (non-Javadoc)
+	 * @see com.googlecode.objectify.cmd.SimpleQuery#filterKey(java.lang.String, java.lang.Object)
+	 */
+	@Override
+	public Query<T> filterKey(String condition, Object value);
+
 	/**
 	 * <p>Sorts based on a property.  Examples:</p>
-	 * 
+	 *
 	 * <ul>
 	 * <li>{@code order("age")}</li>
 	 * <li>{@code order("-age")} (descending sort)</li>
 	 * </ul>
-	 * 
+	 *
 	 * <p>You can <strong>not</strong> sort on @Id or @Parent properties. Sort by __key__ or -__key__ instead.</p>
 	 */
 	public Query<T> order(String condition);
-	
-	/* (non-Javadoc)
-	 * @see com.googlecode.objectify.cmd.SimpleQuery#filterKey(java.lang.String, java.lang.Object)
+
+	/**
+	 * Shorthand for {@code order("__key__")} or {@code order("-__key__")}
+	 * @param descending if true, specifies a descending (aka reverse) sort
 	 */
-	@Override
-	public Query<T> filterKey(String condition, Object value);
-	
+	public Query<T> orderKey(boolean descending);
+
 	/* (non-Javadoc)
 	 * @see com.googlecode.objectify.cmd.SimpleQuery#ancestor(java.lang.Object)
 	 */
diff --git a/src/main/java/com/googlecode/objectify/cmd/SimpleQuery.java b/src/main/java/com/googlecode/objectify/cmd/SimpleQuery.java
@@ -34,6 +34,12 @@ public interface SimpleQuery<T> extends QueryExecute<T>
 	 */
 	public SimpleQuery<T> filterKey(Object value);
 
+	/**
+	 * Orders results by the key.
+	 * @param descending if true, specifies a descending (aka reverse) sort
+	 */
+	public SimpleQuery<T> orderKey(boolean descending);
+
 	/**
 	 * Restricts result set only to objects which have the given ancestor
 	 * somewhere in the chain.  Doesn't need to be the immediate parent. The
diff --git a/src/main/java/com/googlecode/objectify/impl/SimpleQueryImpl.java b/src/main/java/com/googlecode/objectify/impl/SimpleQueryImpl.java
@@ -51,6 +51,15 @@ public QueryImpl<T> filterKey(Object value)
 		return filterKey("=", value);
 	}
 
+	@Override
+	public QueryImpl<T> orderKey(boolean descending) {
+		String prefix = descending ? "-" : "";
+
+		QueryImpl<T> q = createQuery();
+		q.addOrder(prefix + Entity.KEY_RESERVED_PROPERTY);
+		return q;
+	}
+
 	/* (non-Javadoc)
 	 * @see com.googlecode.objectify.cmd.Query#ancestor(java.lang.Object)
 	 */
diff --git a/src/main/java/com/googlecode/objectify/util/cmd/QueryResultIteratorWrapper.java b/src/main/java/com/googlecode/objectify/util/cmd/QueryResultIteratorWrapper.java
@@ -17,8 +17,7 @@ public class QueryResultIteratorWrapper<T> implements QueryResultIterator<T>
 	QueryResultIterator<T> base;
 	
 	/** */
-	public QueryResultIteratorWrapper(QueryResultIterator<T> base) 
-	{
+	public QueryResultIteratorWrapper(QueryResultIterator<T> base) {
 		this.base = base;
 	}
 
diff --git a/src/main/java/com/googlecode/objectify/util/cmd/QueryWrapper.java b/src/main/java/com/googlecode/objectify/util/cmd/QueryWrapper.java
diff --git a/src/main/java/com/googlecode/objectify/util/cmd/SimpleQueryWrapper.java b/src/main/java/com/googlecode/objectify/util/cmd/SimpleQueryWrapper.java
diff --git a/src/test/java/com/googlecode/objectify/test/QueryTests.java b/src/test/java/com/googlecode/objectify/test/QueryTests.java
@@ -117,6 +117,31 @@ public void testNormalReverseSorting() throws Exception {
 		assert t2.getId().equals(triv2.getId());
 	}
 
+	/** */
+	@Test
+	public void testKeySorting() throws Exception {
+		Iterator<Trivial> it = ofy().load().type(Trivial.class).orderKey(false).iterator();
+
+		Trivial t1 = it.next();
+		Trivial t2 = it.next();
+
+		assert t1.getId().equals(triv1.getId());
+		assert t2.getId().equals(triv2.getId());
+	}
+
+	/** */
+	@Test
+	public void testKeyReverseSorting() throws Exception {
+		Iterator<Trivial> it = ofy().load().type(Trivial.class).orderKey(true).iterator();
+
+		// t2 first
+		Trivial t2 = it.next();
+		Trivial t1 = it.next();
+
+		assert t1.getId().equals(triv1.getId());
+		assert t2.getId().equals(triv2.getId());
+	}
+
 	/** Unfortunately we can only test one way without custom index file */
 	@Test(expectedExceptions = IllegalArgumentException.class)
 	public void doNotAllowSortingByIdField() throws Exception {

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,7 @@ public class QueryResultIteratorWrapper<T> implements QueryResultIterator<T>`
`17`	`17`	`QueryResultIterator<T> base;`
`18`	`18`
`19`	`19`	`/** */`
`20`		`- public QueryResultIteratorWrapper(QueryResultIterator<T> base)`
`21`		`- {`
	`20`	`+ public QueryResultIteratorWrapper(QueryResultIterator<T> base) {`
`22`	`21`	`this.base = base;`
`23`	`22`	`}`
`24`	`23`