/*****************************************************************
* 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
*
* 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.apache.cayenne.remote;
import org.apache.cayenne.map.DataMap;
import org.apache.cayenne.map.DbEntity;
import org.apache.cayenne.map.EntityResolver;
import org.apache.cayenne.map.ObjEntity;
import org.apache.cayenne.map.Procedure;
import org.apache.cayenne.query.PrefetchTreeNode;
import org.apache.cayenne.query.Query;
import org.apache.cayenne.query.QueryMetadata;
import org.apache.cayenne.query.QueryRouter;
import org.apache.cayenne.query.SQLAction;
import org.apache.cayenne.query.SQLActionVisitor;
/**
* A client wrapper for the incremental query that overrides the metadata to ensure that
* query result is cached on the server, so that subranges could be retrieved at a later
* time.
*
* @since 1.2
* @author Andrus Adamchik
*/
class IncrementalQuery implements Query {
private Query query;
private String cacheKey;
IncrementalQuery(Query query, String cacheKey) {
this.query = query;
this.cacheKey = cacheKey;
}
public QueryMetadata getMetaData(EntityResolver resolver) {
final QueryMetadata metadata = query.getMetaData(resolver);
// the way paginated queries work on the server is that they are never cached
// (IncrementalFaultList interception happens before cache interception). So
// overriding caching settings in the metadata will only affect
// ClientServerChannel behavior
return new QueryMetadata() {
public String getCacheKey() {
return cacheKey;
}
public String getCachePolicy() {
return metadata.getCachePolicy();
}
public DataMap getDataMap() {
return metadata.getDataMap();
}
public DbEntity getDbEntity() {
return metadata.getDbEntity();
}
public int getFetchLimit() {
return metadata.getFetchLimit();
}
public int getFetchStartIndex() {
return metadata.getFetchStartIndex();
}
public ObjEntity getObjEntity() {
return metadata.getObjEntity();
}
public int getPageSize() {
return metadata.getPageSize();
}
public PrefetchTreeNode getPrefetchTree() {
return metadata.getPrefetchTree();
}
public Procedure getProcedure() {
return metadata.getProcedure();
}
public boolean isFetchingDataRows() {
return metadata.isFetchingDataRows();
}
public boolean isRefreshingObjects() {
return metadata.isRefreshingObjects();
}
public boolean isResolvingInherited() {
return metadata.isResolvingInherited();
}
};
}
public void route(QueryRouter router, EntityResolver resolver, Query substitutedQuery) {
query.route(router, resolver, substitutedQuery);
}
public SQLAction createSQLAction(SQLActionVisitor visitor) {
return query.createSQLAction(visitor);
}
public String getName() {
return query.getName();
}
/**
* @deprecated since 1.2 as super is deprecated.
*/
public void setName(String name) {
this.query.setName(name);
}
/**
* @deprecated since 1.2 as super is deprecated.
*/
public Object getRoot() {
return query.getRoot();
}
/**
* @deprecated since 1.2 as super is deprecated.
*/
public void setRoot(Object root) {
query.setRoot(root);
}
}