You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2026/09/06 22:08:09 UTC
(cayenne) 02/03: Cleanup: removing IteratedQueryDecorator - a private query wrapper
This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne.git
commit c6fa09518138cbc4735289c714486f899725a4dd
Author: Andrus Adamchik <an...@objectstyle.com>
AuthorDate: Sun Sep 6 18:05:20 2026 -0400
Cleanup: removing IteratedQueryDecorator - a private query wrapper
---
UPGRADE.md | 17 ++++++
.../relationship/ObjectIdRelationshipFilter.java | 5 +-
.../main/java/org/apache/cayenne/DataChannel.java | 7 ++-
.../org/apache/cayenne/DataChannelQueryFilter.java | 8 +--
.../cayenne/DataChannelQueryFilterChain.java | 2 +-
.../org/apache/cayenne/access/DataContext.java | 40 +++-----------
.../cayenne/access/DataContextQueryAction.java | 10 ++--
.../java/org/apache/cayenne/access/DataDomain.java | 14 ++---
.../cayenne/access/DataDomainQueryAction.java | 12 ++---
.../org/apache/cayenne/access/ObjectStore.java | 4 +-
.../flush/operation/GraphBasedDbRowOpSorter.java | 2 +-
.../cayenne/ashwood/AshwoodEntitySorter.java | 2 +-
.../cayenne/commitlog/DeletedDiffProcessor.java | 2 +-
.../org/apache/cayenne/graph/ChildDiffLoader.java | 2 +-
.../cayenne/query/IteratedQueryDecorator.java | 61 ----------------------
.../java/org/apache/cayenne/MockDataChannel.java | 2 +-
.../access/DataContextDecoratedStackIT.java | 4 +-
.../cayenne/access/DataContextIteratedQueryIT.java | 34 +++---------
.../cayenne/access/DataContextSQLTemplateIT.java | 7 ++-
.../apache/cayenne/access/DataDomainFiltersIT.java | 21 ++++----
.../cayenne/access/DataDomainQueryActionIT.java | 2 +-
.../runtime/DataDomainProviderIT.java | 4 +-
22 files changed, 92 insertions(+), 170 deletions(-)
diff --git a/UPGRADE.md b/UPGRADE.md
index ac753d152..219860c4c 100644
--- a/UPGRADE.md
+++ b/UPGRADE.md
@@ -104,6 +104,23 @@ Expression caseWhenExp = caseWhen(
</dependency>
```
+* `DataChannel.onQuery(..)`, `DataChannelQueryFilter.onQuery(..)` and `DataChannelQueryFilterChain.onQuery(..)`
+ take an extra `boolean iteratedResult` parameter, which is `true` when the caller expects a `ResultIterator` (via
+ `ObjectContext.iterator(..)` and friends) rather than a list. It replaces the internal `IteratedQueryDecorator`
+ wrapper, so query filters now see the actual query instead of the wrapper. Custom `DataChannel` implementations and
+ query filters need to add the parameter and pass it down the chain:
+
+ ```java
+ public QueryResponse onQuery(ObjectContext context, Query query, boolean iteratedResult,
+ DataChannelQueryFilterChain chain) {
+ return chain.onQuery(context, query, iteratedResult);
+ }
+ ```
+
+* `DataContext.performIteratedQuery(Query)` (deprecated earlier in 5.0) was removed. Use `ObjectContext.iterator(Select)`
+ instead; to iterate over `DataRow`s, pass a `DataRow` query, e.g. `ObjectSelect.dataRowQuery(Artist.class)` or
+ `SQLSelect.dataRowQuery(sql)`.
+
## Upgrading to 5.0-M3
diff --git a/cayenne-lifecycle/src/main/java/org/apache/cayenne/lifecycle/relationship/ObjectIdRelationshipFilter.java b/cayenne-lifecycle/src/main/java/org/apache/cayenne/lifecycle/relationship/ObjectIdRelationshipFilter.java
index 508020ba6..dfa4ac1fb 100644
--- a/cayenne-lifecycle/src/main/java/org/apache/cayenne/lifecycle/relationship/ObjectIdRelationshipFilter.java
+++ b/cayenne-lifecycle/src/main/java/org/apache/cayenne/lifecycle/relationship/ObjectIdRelationshipFilter.java
@@ -45,9 +45,10 @@ public class ObjectIdRelationshipFilter implements DataChannelQueryFilter {
return new ObjectIdRelationshipBatchFaultingStrategy();
}
- public QueryResponse onQuery(ObjectContext context, Query query, DataChannelQueryFilterChain chain) {
+ public QueryResponse onQuery(ObjectContext context, Query query, boolean iteratedResult,
+ DataChannelQueryFilterChain chain) {
try {
- return chain.onQuery(context, query);
+ return chain.onQuery(context, query, iteratedResult);
} finally {
faultingStrategy.afterQuery();
}
diff --git a/cayenne/src/main/java/org/apache/cayenne/DataChannel.java b/cayenne/src/main/java/org/apache/cayenne/DataChannel.java
index d244ad20c..52d85205f 100644
--- a/cayenne/src/main/java/org/apache/cayenne/DataChannel.java
+++ b/cayenne/src/main/java/org/apache/cayenne/DataChannel.java
@@ -91,9 +91,14 @@ public interface DataChannel {
*
* @param originatingContext an ObjectContext that originated the query, used to
* register result objects.
+ * @param query a query to execute.
+ * @param iteratedResult if true, the result is returned as a {@link ResultIterator} accessible via
+ * {@link QueryResponse#firstIterator()}, and the caller is responsible for closing
+ * it. If false, the result is fully read into a list.
* @return a generic response object that encapsulates result of the execution.
+ * @since 5.0
*/
- QueryResponse onQuery(ObjectContext originatingContext, Query query);
+ QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult);
/**
* Processes synchronization request from a child ObjectContext, returning a GraphDiff
diff --git a/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilter.java b/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilter.java
index d52e4e382..423f28963 100644
--- a/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilter.java
+++ b/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilter.java
@@ -27,11 +27,11 @@ import org.apache.cayenne.query.Query;
* <p>
* Example: <pre>{@code
* public class MyQueryFilter implements DataChannelQueryFilter {
- * public QueryResponse onQuery(ObjectContext originatingContext, Query query,
+ * public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult,
* DataChannelQueryFilterChain filterChain) {
* System.out.println("Do something before query");
* // process query or return some custom response
- * QueryResponse response = filterChain.onQuery(originatingContext, query);
+ * QueryResponse response = filterChain.onQuery(originatingContext, query, iteratedResult);
* System.out.println("Do something after query");
* return response;
* }
@@ -48,9 +48,11 @@ public interface DataChannelQueryFilter {
/**
* @param originatingContext originating context of query
* @param query that is processed
+ * @param iteratedResult whether the result should be returned as a {@link ResultIterator} instead of a list
* @param filterChain chain of query filters to invoke after this filter
* @return query response
*/
- QueryResponse onQuery(ObjectContext originatingContext, Query query, DataChannelQueryFilterChain filterChain);
+ QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult,
+ DataChannelQueryFilterChain filterChain);
}
diff --git a/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilterChain.java b/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilterChain.java
index 255391042..02d0cfdcd 100644
--- a/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilterChain.java
+++ b/cayenne/src/main/java/org/apache/cayenne/DataChannelQueryFilterChain.java
@@ -28,6 +28,6 @@ import org.apache.cayenne.query.Query;
*/
public interface DataChannelQueryFilterChain {
- QueryResponse onQuery(ObjectContext originatingContext, Query query);
+ QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult);
}
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/DataContext.java b/cayenne/src/main/java/org/apache/cayenne/access/DataContext.java
index 7e2b5aab1..a81176a7e 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/DataContext.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/DataContext.java
@@ -46,7 +46,6 @@ import org.apache.cayenne.graph.GraphManager;
import org.apache.cayenne.map.EntityResolver;
import org.apache.cayenne.map.LifecycleEvent;
import org.apache.cayenne.map.ObjEntity;
-import org.apache.cayenne.query.IteratedQueryDecorator;
import org.apache.cayenne.query.MappedExec;
import org.apache.cayenne.query.MappedSelect;
import org.apache.cayenne.query.ObjectIdQuery;
@@ -1089,35 +1088,10 @@ public class DataContext implements ObjectContext {
* <p>
*/
@Override
- public <T> ResultIterator<T> iterator(Select<T> query) {
- return performIteratedQueryInternal(query, false);
- }
-
- /**
- * Performs a single database select query returning result as a {@link ResultIterator}.
- * <p>
- * It is caller's responsibility to explicitly close the {@link ResultIterator}.
- * A failure to do so will result in a <b>database connection not being released</b>.
- * Another side effect of an open {@link ResultIterator} is that an internal Cayenne transaction
- * that originated in this method stays open until the iterator is closed.
- * So users should normally close the iterator within the same thread that opened it.
- * <p>
- * Note that {@code performIteratedQuery} always returns {@link ResultIterator} over DataRows.
- * <p>
- *
- * @deprecated in favor of {@link #iterator(Select)}.
- */
- @Deprecated(since = "5.0", forRemoval = true)
- @SuppressWarnings({"rawtypes"})
- public ResultIterator performIteratedQuery(Query query) {
- return performIteratedQueryInternal(query, true);
- }
-
@SuppressWarnings("unchecked")
- private <T> ResultIterator<T> performIteratedQueryInternal(Query query, boolean fetchDataRows) {
- IteratedQueryDecorator queryDecorator = new IteratedQueryDecorator(query, fetchDataRows);
- Query queryToRun = nonNullDelegate().willPerformQuery(this, queryDecorator);
- QueryResponse queryResponse = onQuery(this, queryToRun);
+ public <T> ResultIterator<T> iterator(Select<T> query) {
+ Query queryToRun = nonNullDelegate().willPerformQuery(this, query);
+ QueryResponse queryResponse = onQuery(this, queryToRun, true);
return (ResultIterator<T>) queryResponse.firstIterator();
}
@@ -1138,7 +1112,7 @@ public class DataContext implements ObjectContext {
throw new CayenneRuntimeException("Can't run query - parent DataChannel is not set.");
}
- return onQuery(this, query);
+ return onQuery(this, query, false);
}
/**
@@ -1168,7 +1142,7 @@ public class DataContext implements ObjectContext {
return new ArrayList<>(1);
}
- List<?> result = onQuery(this, query).firstList();
+ List<?> result = onQuery(this, query, false).firstList();
return result != null ? result : new ArrayList<>(1);
}
@@ -1178,8 +1152,8 @@ public class DataContext implements ObjectContext {
*
* @since 1.2
*/
- public QueryResponse onQuery(ObjectContext context, Query query) {
- return new DataContextQueryAction(this, context, query).execute();
+ public QueryResponse onQuery(ObjectContext context, Query query, boolean iteratedResult) {
+ return new DataContextQueryAction(this, context, query, iteratedResult).execute();
}
@Override
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/DataContextQueryAction.java b/cayenne/src/main/java/org/apache/cayenne/access/DataContextQueryAction.java
index 5b0dd0cd3..d84bddb85 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/DataContextQueryAction.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/DataContextQueryAction.java
@@ -29,7 +29,6 @@ import org.apache.cayenne.cache.QueryCacheEntryFactory;
import org.apache.cayenne.map.DbEntity;
import org.apache.cayenne.map.EntityInheritanceTree;
import org.apache.cayenne.query.EntityResultSegment;
-import org.apache.cayenne.query.IteratedQueryDecorator;
import org.apache.cayenne.query.ObjectIdQuery;
import org.apache.cayenne.query.Query;
import org.apache.cayenne.query.QueryCacheStrategy;
@@ -61,14 +60,17 @@ class DataContextQueryAction {
private final Query query;
private final QueryMetadata metadata;
private final boolean queryOriginator;
+ private final boolean iteratedResult;
private transient QueryResponse response;
- public DataContextQueryAction(DataContext actingContext, ObjectContext targetContext, Query query) {
+ public DataContextQueryAction(DataContext actingContext, ObjectContext targetContext, Query query,
+ boolean iteratedResult) {
this.actingContext = actingContext;
this.actingDataContext = actingContext;
this.query = query;
+ this.iteratedResult = iteratedResult;
// this means that a caller must pass self as both acting context and target
// context to indicate that a query originated here... null (ROP) or differing
@@ -103,7 +105,7 @@ class DataContextQueryAction {
}
private boolean interceptIteratedQuery() {
- if (query instanceof IteratedQueryDecorator) {
+ if (iteratedResult) {
runQuery();
return DONE;
}
@@ -521,6 +523,6 @@ class DataContextQueryAction {
* Fetches data from the channel.
*/
protected void runQuery() {
- this.response = actingContext.getParent().onQuery(actingContext, query);
+ this.response = actingContext.getParent().onQuery(actingContext, query, iteratedResult);
}
}
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/DataDomain.java b/cayenne/src/main/java/org/apache/cayenne/access/DataDomain.java
index eaf7a4c20..a43345ea2 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/DataDomain.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/DataDomain.java
@@ -347,17 +347,17 @@ public class DataDomain implements DataChannel {
* @since 1.2
*/
@Override
- public QueryResponse onQuery(ObjectContext originatingContext, Query query) {
+ public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult) {
checkStopped();
- return new DataDomainQueryFilterChain().onQuery(originatingContext, query);
+ return new DataDomainQueryFilterChain().onQuery(originatingContext, query, iteratedResult);
}
- QueryResponse onQueryNoFilters(ObjectContext originatingContext, Query query) {
+ QueryResponse onQueryNoFilters(ObjectContext originatingContext, Query query, boolean iteratedResult) {
// transaction note:
// we don't wrap this code in transaction to reduce transaction scope to
// just the DB operation for better performance ... query action will
// start a transaction itself when and if needed
- return new DataDomainQueryAction(originatingContext, DataDomain.this, query).execute();
+ return new DataDomainQueryAction(originatingContext, DataDomain.this, query, iteratedResult).execute();
}
/**
@@ -520,10 +520,10 @@ public class DataDomain implements DataChannel {
}
@Override
- public QueryResponse onQuery(ObjectContext originatingContext, Query query) {
+ public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult) {
return --idx >= 0
- ? queryFilters.get(idx).onQuery(originatingContext, query, this)
- : onQueryNoFilters(originatingContext, query);
+ ? queryFilters.get(idx).onQuery(originatingContext, query, iteratedResult, this)
+ : onQueryNoFilters(originatingContext, query, iteratedResult);
}
}
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/DataDomainQueryAction.java b/cayenne/src/main/java/org/apache/cayenne/access/DataDomainQueryAction.java
index 4f6343cf4..bd664bb2f 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/DataDomainQueryAction.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/DataDomainQueryAction.java
@@ -42,7 +42,6 @@ import org.apache.cayenne.map.LifecycleEvent;
import org.apache.cayenne.map.ObjRelationship;
import org.apache.cayenne.query.EmbeddableResultSegment;
import org.apache.cayenne.query.EntityResultSegment;
-import org.apache.cayenne.query.IteratedQueryDecorator;
import org.apache.cayenne.query.ObjectIdQuery;
import org.apache.cayenne.query.PrefetchSelectQuery;
import org.apache.cayenne.query.PrefetchTreeNode;
@@ -99,6 +98,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
private QueryResponse response;
private GenericResponse fullResponse;
+ private final boolean iteratedResult;
private boolean iteratorExclusiveConnection;
private Map<CayennePath, List<?>> prefetchResultsByPath;
private Map<DataNode, Collection<Query>> queriesByNode;
@@ -116,7 +116,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
* A constructor for the "new" way of performing a query via 'execute' with
* QueryResponse created internally.
*/
- DataDomainQueryAction(ObjectContext context, DataDomain domain, Query query) {
+ DataDomainQueryAction(ObjectContext context, DataDomain domain, Query query, boolean iteratedResult) {
if (context != null && !(context instanceof DataContext)) {
throw new IllegalArgumentException("DataDomain can only work with DataContext. "
+ "Unsupported context type: " + context);
@@ -124,6 +124,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
this.domain = domain;
this.query = query;
+ this.iteratedResult = iteratedResult;
this.metadata = query.getMetaData(domain.getEntityResolver());
this.context = (DataContext) context;
this.objectFactory = domain.getObjectFactory();
@@ -155,8 +156,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
}
private boolean interceptIteratedQuery() {
- if (query instanceof IteratedQueryDecorator iteratedQueryDecorator) {
- noObjectConversion = iteratedQueryDecorator.isFetchingDataRows();
+ if (iteratedResult) {
validateIteratedQuery();
performIteratedQuery();
return DONE;
@@ -414,7 +414,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
String cacheKey = cachedQuery.getMetaData(context.getEntityResolver()).getCacheKey();
context.getQueryCache().remove(cacheKey);
- this.response = domain.onQuery(context, cachedQuery);
+ this.response = domain.onQuery(context, cachedQuery, false);
return DONE;
}
@@ -722,7 +722,7 @@ class DataDomainQueryAction implements QueryRouter, OperationObserver {
@Override
public boolean isIteratedResult() {
- return (query instanceof IteratedQueryDecorator);
+ return iteratedResult;
}
@Override
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/ObjectStore.java b/cayenne/src/main/java/org/apache/cayenne/access/ObjectStore.java
index 08ef52f99..182902fbc 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/ObjectStore.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/ObjectStore.java
@@ -450,7 +450,7 @@ public class ObjectStore implements Serializable, SnapshotEventListener, GraphMa
if (context != null && context.getParent() != null) {
ObjectIdQuery query = new ObjectIdQuery(oid, true, ObjectIdQuery.CACHE_NOREFRESH);
- List<?> results = context.getParent().onQuery(context, query).firstList();
+ List<?> results = context.getParent().onQuery(context, query, false).firstList();
return results.isEmpty() ? null : (DataRow) results.get(0);
}
else {
@@ -470,7 +470,7 @@ public class ObjectStore implements Serializable, SnapshotEventListener, GraphMa
if (context != null && context.getParent() != null) {
ObjectIdQuery query = new ObjectIdQuery(oid, true, ObjectIdQuery.CACHE);
- List<?> results = context.getParent().onQuery(context, query).firstList();
+ List<?> results = context.getParent().onQuery(context, query, false).firstList();
return results.isEmpty() ? null : (DataRow) results.get(0);
}
else {
diff --git a/cayenne/src/main/java/org/apache/cayenne/access/flush/operation/GraphBasedDbRowOpSorter.java b/cayenne/src/main/java/org/apache/cayenne/access/flush/operation/GraphBasedDbRowOpSorter.java
index 42c910677..54ef05ca7 100644
--- a/cayenne/src/main/java/org/apache/cayenne/access/flush/operation/GraphBasedDbRowOpSorter.java
+++ b/cayenne/src/main/java/org/apache/cayenne/access/flush/operation/GraphBasedDbRowOpSorter.java
@@ -272,7 +272,7 @@ public class GraphBasedDbRowOpSorter implements DbRowOpSorter {
private Map<String, Object> getCachedSnapshot(Persistent object) {
ObjectIdQuery query = new ObjectIdQuery(object.getObjectId(), true, ObjectIdQuery.CACHE);
- QueryResponse response = object.getObjectContext().getParent().onQuery(null, query);
+ QueryResponse response = object.getObjectContext().getParent().onQuery(null, query, false);
@SuppressWarnings("unchecked")
List<DataRow> result = (List<DataRow>) response.firstList();
if (result == null || result.isEmpty()) {
diff --git a/cayenne/src/main/java/org/apache/cayenne/ashwood/AshwoodEntitySorter.java b/cayenne/src/main/java/org/apache/cayenne/ashwood/AshwoodEntitySorter.java
index 7e206e83f..6e8b3d59b 100644
--- a/cayenne/src/main/java/org/apache/cayenne/ashwood/AshwoodEntitySorter.java
+++ b/cayenne/src/main/java/org/apache/cayenne/ashwood/AshwoodEntitySorter.java
@@ -283,7 +283,7 @@ public class AshwoodEntitySorter implements EntitySorter {
}
ObjectIdQuery query = new ObjectIdQuery(object.getObjectId(), true, ObjectIdQuery.CACHE);
- QueryResponse response = context.getParent().onQuery(null, query);
+ QueryResponse response = context.getParent().onQuery(null, query, false);
List<?> result = response.firstList();
if (result == null || result.isEmpty()) {
return null;
diff --git a/cayenne/src/main/java/org/apache/cayenne/commitlog/DeletedDiffProcessor.java b/cayenne/src/main/java/org/apache/cayenne/commitlog/DeletedDiffProcessor.java
index 4ffa7ddcb..437bda677 100644
--- a/cayenne/src/main/java/org/apache/cayenne/commitlog/DeletedDiffProcessor.java
+++ b/cayenne/src/main/java/org/apache/cayenne/commitlog/DeletedDiffProcessor.java
@@ -57,7 +57,7 @@ class DeletedDiffProcessor implements GraphChangeHandler {
final MutableObjectChange objectChangeSet = changeSet.getOrCreate(id, ObjectChangeType.DELETE);
ObjectIdQuery query = new ObjectIdQuery(id, true, ObjectIdQuery.CACHE);
- QueryResponse result = channel.onQuery(null, query);
+ QueryResponse result = channel.onQuery(null, query, false);
@SuppressWarnings("unchecked")
List<DataRow> rows = (List<DataRow>)result.firstList();
diff --git a/cayenne/src/main/java/org/apache/cayenne/graph/ChildDiffLoader.java b/cayenne/src/main/java/org/apache/cayenne/graph/ChildDiffLoader.java
index 6d6ff8a17..bac1687bb 100644
--- a/cayenne/src/main/java/org/apache/cayenne/graph/ChildDiffLoader.java
+++ b/cayenne/src/main/java/org/apache/cayenne/graph/ChildDiffLoader.java
@@ -263,7 +263,7 @@ public class ChildDiffLoader implements GraphChangeHandler {
// skip context cache lookup, go directly to its channel
Query query = new ObjectIdQuery((ObjectId) nodeId);
- QueryResponse response = context.getParent().onQuery(context, query);
+ QueryResponse response = context.getParent().onQuery(context, query, false);
List<?> objects = response.firstList();
if (objects.size() == 0) {
diff --git a/cayenne/src/main/java/org/apache/cayenne/query/IteratedQueryDecorator.java b/cayenne/src/main/java/org/apache/cayenne/query/IteratedQueryDecorator.java
deleted file mode 100644
index 47d505ac4..000000000
--- a/cayenne/src/main/java/org/apache/cayenne/query/IteratedQueryDecorator.java
+++ /dev/null
@@ -1,61 +0,0 @@
-/*****************************************************************
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you 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
- *
- * https://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.apache.cayenne.query;
-
-import org.apache.cayenne.map.EntityResolver;
-
-/**
- * A simple decorator for an iterated query.
- *
- * @since 5.0
- */
-public class IteratedQueryDecorator implements Query {
-
- private final Query query;
- private final boolean fetchDataRows;
-
- public IteratedQueryDecorator(Query query, boolean fetchDataRows) {
- this.query = query;
- this.fetchDataRows = fetchDataRows;
- }
-
- @Override
- public QueryMetadata getMetaData(EntityResolver resolver) {
- return query.getMetaData(resolver);
- }
-
- @Override
- public void route(QueryRouter router, EntityResolver resolver, Query substitutedQuery) {
- query.route(router, resolver, substitutedQuery);
- }
-
- @Override
- public SQLAction createSQLAction(SQLActionVisitor visitor) {
- return query.createSQLAction(visitor);
- }
-
- public Query getQuery() {
- return query;
- }
-
- public boolean isFetchingDataRows() {
- return fetchDataRows;
- }
-}
diff --git a/cayenne/src/test/java/org/apache/cayenne/MockDataChannel.java b/cayenne/src/test/java/org/apache/cayenne/MockDataChannel.java
index d41be474c..26daf5ab6 100644
--- a/cayenne/src/test/java/org/apache/cayenne/MockDataChannel.java
+++ b/cayenne/src/test/java/org/apache/cayenne/MockDataChannel.java
@@ -89,7 +89,7 @@ public class MockDataChannel implements DataChannel {
return commitResponse;
}
- public QueryResponse onQuery(ObjectContext context, Query query) {
+ public QueryResponse onQuery(ObjectContext context, Query query, boolean iteratedResult) {
requestObjects.add(query);
return response;
}
diff --git a/cayenne/src/test/java/org/apache/cayenne/access/DataContextDecoratedStackIT.java b/cayenne/src/test/java/org/apache/cayenne/access/DataContextDecoratedStackIT.java
index 9fad357c0..a352e0d02 100644
--- a/cayenne/src/test/java/org/apache/cayenne/access/DataContextDecoratedStackIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/access/DataContextDecoratedStackIT.java
@@ -100,8 +100,8 @@ public class DataContextDecoratedStackIT {
return channel.getEventManager();
}
- public QueryResponse onQuery(ObjectContext originatingContext, Query query) {
- return channel.onQuery(originatingContext, query);
+ public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult) {
+ return channel.onQuery(originatingContext, query, iteratedResult);
}
public GraphDiff onSync(
diff --git a/cayenne/src/test/java/org/apache/cayenne/access/DataContextIteratedQueryIT.java b/cayenne/src/test/java/org/apache/cayenne/access/DataContextIteratedQueryIT.java
index d7c70c7bb..f4be1902c 100644
--- a/cayenne/src/test/java/org/apache/cayenne/access/DataContextIteratedQueryIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/access/DataContextIteratedQueryIT.java
@@ -164,31 +164,13 @@ public class DataContextIteratedQueryIT {
}
}
-
- @Deprecated
@Test
- public void performIteratedQuery_Count() throws Exception {
- createArtistsDataSet();
-
- try (ResultIterator<?> it = context.performIteratedQuery(ObjectSelect.query(Artist.class))) {
- int count = 0;
- while (it.hasNextRow()) {
- it.nextRow();
- count++;
- }
-
- assertEquals(7, count);
- }
- }
-
- @Deprecated
- @Test
- public void performIteratedQuery_resolve() throws Exception {
+ public void iterator_DataRows_Resolve() throws Exception {
createArtistsAndPaintingsDataSet();
- try (ResultIterator<?> it = context.performIteratedQuery(ObjectSelect.query(Artist.class))) {
+ try (ResultIterator<DataRow> it = context.iterator(ObjectSelect.dataRowQuery(Artist.class))) {
while (it.hasNextRow()) {
- DataRow row = (DataRow) it.nextRow();
+ DataRow row = it.nextRow();
// try instantiating an object and fetching its relationships
Artist artist = context.objectFromDataRow(Artist.class, row);
@@ -257,14 +239,14 @@ public class DataContextIteratedQueryIT {
}
@Test
- public void performIteratedQuery_CommitWithinIterator() throws Exception {
+ public void iterator_DataRows_CommitWithinIterator() throws Exception {
createArtistsAndPaintingsDataSet();
assertEquals(7, tPainting.getRowCount());
- try (ResultIterator<?> it = context.performIteratedQuery(ObjectSelect.query(Artist.class))) {
+ try (ResultIterator<DataRow> it = context.iterator(ObjectSelect.dataRowQuery(Artist.class))) {
while (it.hasNextRow()) {
- DataRow row = (DataRow) it.nextRow();
+ DataRow row = it.nextRow();
Artist artist = context.objectFromDataRow(Artist.class, row);
@@ -279,10 +261,10 @@ public class DataContextIteratedQueryIT {
}
@Test
- public void performIteratedQuery_Transaction() throws Exception {
+ public void iterator_Transaction() throws Exception {
createArtistsDataSet();
- try (ResultIterator<?> it = context.performIteratedQuery(ObjectSelect.query(Artist.class))) {
+ try (ResultIterator<Artist> it = context.iterator(ObjectSelect.query(Artist.class))) {
assertNull(BaseTransaction.getThreadTransaction(), "Iterator transaction was not unbound from thread");
}
diff --git a/cayenne/src/test/java/org/apache/cayenne/access/DataContextSQLTemplateIT.java b/cayenne/src/test/java/org/apache/cayenne/access/DataContextSQLTemplateIT.java
index 6e4392546..dae34878c 100644
--- a/cayenne/src/test/java/org/apache/cayenne/access/DataContextSQLTemplateIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/access/DataContextSQLTemplateIT.java
@@ -545,16 +545,15 @@ public class DataContextSQLTemplateIT {
public void iteratedQuery() throws Exception {
createFourArtists();
- String template = "SELECT * FROM ARTIST ORDER BY ARTIST_ID";
- SQLTemplate query = sqlTemplateCustomizer.createSQLTemplate(Artist.class, template);
+ SQLSelect<DataRow> query = SQLSelect.dataRowQuery("SELECT * FROM ARTIST ORDER BY ARTIST_ID");
- try (ResultIterator<?> it = context.performIteratedQuery(query);) {
+ try (ResultIterator<DataRow> it = context.iterator(query)) {
long i = 0;
while (it.hasNextRow()) {
i++;
- DataRow row = (DataRow) it.nextRow();
+ DataRow row = it.nextRow();
assertEquals(3, row.size());
assertEquals("artist" + (1 + i), row.get("ARTIST_NAME"));
}
diff --git a/cayenne/src/test/java/org/apache/cayenne/access/DataDomainFiltersIT.java b/cayenne/src/test/java/org/apache/cayenne/access/DataDomainFiltersIT.java
index aa1bcb244..abba0dbc1 100644
--- a/cayenne/src/test/java/org/apache/cayenne/access/DataDomainFiltersIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/access/DataDomainFiltersIT.java
@@ -60,16 +60,16 @@ public class DataDomainFiltersIT {
DataDomain domain = env.runtime().getDataDomain();
List<String> results = new ArrayList<>();
- DataChannelQueryFilter f1 = (originatingContext, query, filterChain) -> {
+ DataChannelQueryFilter f1 = (originatingContext, query, iteratedResult, filterChain) -> {
results.add("f1start");
- QueryResponse response = filterChain.onQuery(originatingContext, query);
+ QueryResponse response = filterChain.onQuery(originatingContext, query, iteratedResult);
results.add("f1end");
return response;
};
- DataChannelQueryFilter f2 = (originatingContext, query, filterChain) -> {
+ DataChannelQueryFilter f2 = (originatingContext, query, iteratedResult, filterChain) -> {
results.add("f2start");
- QueryResponse response = filterChain.onQuery(originatingContext, query);
+ QueryResponse response = filterChain.onQuery(originatingContext, query, iteratedResult);
results.add("f2end");
return response;
};
@@ -78,7 +78,7 @@ public class DataDomainFiltersIT {
domain.queryFilters.add(f2);
ObjectSelect<Artist> query = ObjectSelect.query(Artist.class);
- QueryResponse response = domain.onQuery(env.context(), query);
+ QueryResponse response = domain.onQuery(env.context(), query, false);
assertNotNull(response);
assertEquals(4, results.size());
assertEquals("f2start", results.get(0));
@@ -131,14 +131,14 @@ public class DataDomainFiltersIT {
QueryResponse r1 = new ListResponse();
QueryResponse r2 = new ListResponse();
- DataChannelQueryFilter f1 = (originatingContext, query, filterChain) -> r1;
- DataChannelQueryFilter f2 = (originatingContext, query, filterChain) -> r2;
+ DataChannelQueryFilter f1 = (originatingContext, query, iteratedResult, filterChain) -> r1;
+ DataChannelQueryFilter f2 = (originatingContext, query, iteratedResult, filterChain) -> r2;
domain.queryFilters.add(f1);
domain.queryFilters.add(f2);
ObjectSelect<Artist> query = ObjectSelect.query(Artist.class);
- QueryResponse response = domain.onQuery(env.context(), query);
+ QueryResponse response = domain.onQuery(env.context(), query, false);
assertSame(r2, response);
}
@@ -167,9 +167,10 @@ public class DataDomainFiltersIT {
private List<String> results = new ArrayList<>();
@Override
- public QueryResponse onQuery(ObjectContext originatingContext, Query query, DataChannelQueryFilterChain filterChain) {
+ public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult,
+ DataChannelQueryFilterChain filterChain) {
results.add("onQuery");
- return filterChain.onQuery(originatingContext, query);
+ return filterChain.onQuery(originatingContext, query, iteratedResult);
}
@Override
diff --git a/cayenne/src/test/java/org/apache/cayenne/access/DataDomainQueryActionIT.java b/cayenne/src/test/java/org/apache/cayenne/access/DataDomainQueryActionIT.java
index f101a3773..530f46954 100644
--- a/cayenne/src/test/java/org/apache/cayenne/access/DataDomainQueryActionIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/access/DataDomainQueryActionIT.java
@@ -75,7 +75,7 @@ public class DataDomainQueryActionIT {
.pageSize(5);
- new DataDomainQueryAction(env.context(), domain, query).execute();
+ new DataDomainQueryAction(env.context(), domain, query, false).execute();
}
}
diff --git a/cayenne/src/test/java/org/apache/cayenne/configuration/runtime/DataDomainProviderIT.java b/cayenne/src/test/java/org/apache/cayenne/configuration/runtime/DataDomainProviderIT.java
index 8a8c41936..8244e6303 100644
--- a/cayenne/src/test/java/org/apache/cayenne/configuration/runtime/DataDomainProviderIT.java
+++ b/cayenne/src/test/java/org/apache/cayenne/configuration/runtime/DataDomainProviderIT.java
@@ -249,9 +249,9 @@ public class DataDomainProviderIT {
static class NoopQueryFilter implements DataChannelQueryFilter {
@Override
- public QueryResponse onQuery(ObjectContext originatingContext, Query query,
+ public QueryResponse onQuery(ObjectContext originatingContext, Query query, boolean iteratedResult,
DataChannelQueryFilterChain filterChain) {
- return filterChain.onQuery(originatingContext, query);
+ return filterChain.onQuery(originatingContext, query, iteratedResult);
}
}