Merge "Remove support for auto-paging of cursors." into oc-dev
am: 7f0d8c8076
Change-Id: Ice100c419ce6d53721d6bbec1147bb1cc1bb7b4d
This commit is contained in:
@@ -24,7 +24,6 @@ import android.database.Cursor;
|
||||
import android.database.CursorToBulkCursorAdaptor;
|
||||
import android.database.DatabaseUtils;
|
||||
import android.database.IContentObserver;
|
||||
import android.database.PageViewCursor;
|
||||
import android.net.Uri;
|
||||
import android.os.Binder;
|
||||
import android.os.Bundle;
|
||||
@@ -104,7 +103,6 @@ abstract public class ContentProviderNative extends Binder implements IContentPr
|
||||
if (cursor != null) {
|
||||
CursorToBulkCursorAdaptor adaptor = null;
|
||||
|
||||
cursor = PageViewCursor.wrap(cursor, queryArgs);
|
||||
try {
|
||||
adaptor = new CursorToBulkCursorAdaptor(cursor, observer,
|
||||
getProviderName());
|
||||
|
||||
@@ -1,308 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2017 The Android Open Source Project
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
package android.database;
|
||||
|
||||
import static com.android.internal.util.ArrayUtils.contains;
|
||||
import static com.android.internal.util.Preconditions.checkArgument;
|
||||
|
||||
import android.annotation.Nullable;
|
||||
import android.annotation.TestApi;
|
||||
import android.content.ContentResolver;
|
||||
import android.os.Build;
|
||||
import android.os.Bundle;
|
||||
import android.util.Log;
|
||||
import android.util.MathUtils;
|
||||
|
||||
import java.util.Arrays;
|
||||
|
||||
/**
|
||||
* Cursor wrapper that provides visibility into a subset of a wrapped cursor.
|
||||
*
|
||||
* The window is specified by offset and limit.
|
||||
*
|
||||
* @hide
|
||||
*/
|
||||
@TestApi
|
||||
public final class PageViewCursor extends CursorWrapper implements CrossProcessCursor {
|
||||
|
||||
/** An extra added to results that are auto-paged using the wrapper. */
|
||||
public static final String EXTRA_AUTO_PAGED = "android.content.extra.AUTO_PAGED";
|
||||
|
||||
private static final String[] EMPTY_ARGS = new String[0];
|
||||
private static final String TAG = "PageViewCursor";
|
||||
private static final boolean DEBUG = Build.IS_DEBUGGABLE;
|
||||
private static final boolean VERBOSE = Build.IS_DEBUGGABLE && Log.isLoggable(TAG, Log.VERBOSE);
|
||||
|
||||
private final int mOffset; // aka first index
|
||||
private final int mCount;
|
||||
private final Bundle mExtras;
|
||||
|
||||
private @Nullable CursorWindow mWindow;
|
||||
private int mPos = -1;
|
||||
private int mWindowFillCount = 0;
|
||||
|
||||
/**
|
||||
* @see PageViewCursor#wrap(Cursor, Bundle)
|
||||
*/
|
||||
public PageViewCursor(Cursor cursor, Bundle queryArgs) {
|
||||
super(cursor);
|
||||
|
||||
int offset = queryArgs.getInt(ContentResolver.QUERY_ARG_OFFSET, 0);
|
||||
int limit = queryArgs.getInt(ContentResolver.QUERY_ARG_LIMIT, Integer.MAX_VALUE);
|
||||
|
||||
checkArgument(offset > -1);
|
||||
checkArgument(limit > -1);
|
||||
|
||||
int count = mCursor.getCount();
|
||||
|
||||
mOffset = offset;
|
||||
|
||||
mExtras = new Bundle();
|
||||
Bundle extras = cursor.getExtras();
|
||||
if (extras != null) {
|
||||
mExtras.putAll(extras);
|
||||
}
|
||||
|
||||
// When we're wrapping another cursor, it should not already be "paged".
|
||||
checkArgument(!hasPagedResponseDetails(mExtras));
|
||||
|
||||
mExtras.putBoolean(EXTRA_AUTO_PAGED, true);
|
||||
mExtras.putInt(ContentResolver.EXTRA_TOTAL_SIZE, count);
|
||||
|
||||
// Ensure we retain any extra args supplied in cursor extras, and add
|
||||
// offset and/or limit.
|
||||
String[] existingArgs = mExtras.getStringArray(ContentResolver.EXTRA_HONORED_ARGS);
|
||||
existingArgs = existingArgs != null ? existingArgs : EMPTY_ARGS;
|
||||
|
||||
int size = existingArgs.length;
|
||||
|
||||
// copy the array with space for the extra query args we'll be adding.
|
||||
String[] newArgs = Arrays.copyOf(existingArgs, size + 2);
|
||||
|
||||
if (queryArgs.containsKey(ContentResolver.QUERY_ARG_OFFSET)) {
|
||||
newArgs[size++] = ContentResolver.QUERY_ARG_OFFSET;
|
||||
}
|
||||
if (queryArgs.containsKey(ContentResolver.QUERY_ARG_LIMIT)) {
|
||||
newArgs[size++] = ContentResolver.QUERY_ARG_LIMIT;
|
||||
}
|
||||
|
||||
assert(size > existingArgs.length); // must add at least one arg.
|
||||
|
||||
// At this point there may be a null element at the end of
|
||||
// the array because our pre-sizing didn't match the actualy
|
||||
// number of args we added. So we trim.
|
||||
if (size == newArgs.length - 1) {
|
||||
newArgs = Arrays.copyOf(newArgs, size);
|
||||
}
|
||||
mExtras.putStringArray(ContentResolver.EXTRA_HONORED_ARGS, newArgs);
|
||||
|
||||
mCount = MathUtils.constrain(count - offset, 0, limit);
|
||||
|
||||
if (DEBUG) Log.d(TAG, "Wrapped cursor"
|
||||
+ " offset: " + mOffset
|
||||
+ ", limit: " + limit
|
||||
+ ", delegate_size: " + count
|
||||
+ ", paged_count: " + mCount);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Bundle getExtras() {
|
||||
return mExtras;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getPosition() {
|
||||
return mPos;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isBeforeFirst() {
|
||||
if (mCount == 0) {
|
||||
return true;
|
||||
}
|
||||
return mPos == -1;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isAfterLast() {
|
||||
if (mCount == 0) {
|
||||
return true;
|
||||
}
|
||||
return mPos == mCount;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isFirst() {
|
||||
return mPos == 0;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isLast() {
|
||||
return mPos == mCount - 1;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean moveToFirst() {
|
||||
return moveToPosition(0);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean moveToLast() {
|
||||
return moveToPosition(mCount - 1);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean moveToNext() {
|
||||
return move(1);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean moveToPrevious() {
|
||||
return move(-1);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean move(int offset) {
|
||||
return moveToPosition(mPos + offset);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean moveToPosition(int position) {
|
||||
if (position >= mCount) {
|
||||
if (VERBOSE) Log.v(TAG, "Invalid Positon: " + position + " >= count: " + mCount
|
||||
+ ". Moving to last record.");
|
||||
mPos = mCount;
|
||||
super.moveToPosition(mOffset + mPos); // move into "after last" state.
|
||||
return false;
|
||||
}
|
||||
|
||||
// Make sure position isn't before the beginning of the cursor
|
||||
if (position < 0) {
|
||||
if (VERBOSE) Log.v(TAG, "Ignoring invalid move to position: " + position);
|
||||
mPos = -1;
|
||||
super.moveToPosition(mPos);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (position == mPos) {
|
||||
if (VERBOSE) Log.v(TAG, "Ignoring no-op move to position: " + position);
|
||||
return true;
|
||||
}
|
||||
|
||||
int delegatePosition = position + mOffset;
|
||||
if (VERBOSE) Log.v(TAG, "Moving delegate cursor to position: " + delegatePosition);
|
||||
if (super.moveToPosition(delegatePosition)) {
|
||||
mPos = position;
|
||||
return true;
|
||||
} else {
|
||||
mPos = -1;
|
||||
super.moveToPosition(-1);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean onMove(int oldPosition, int newPosition) {
|
||||
throw new UnsupportedOperationException("Not supported.");
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getCount() {
|
||||
return mCount;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean getWantsAllOnMoveCalls() {
|
||||
return false; // we want bulk cursor adapter to lift data into a CursorWindow.
|
||||
}
|
||||
|
||||
@Override
|
||||
public CursorWindow getWindow() {
|
||||
assert(mPos == -1 || mPos == 0);
|
||||
if (mWindow == null) {
|
||||
mWindow = new CursorWindow("PageViewCursorWindow");
|
||||
fillWindow(0, mWindow);
|
||||
}
|
||||
|
||||
return mWindow;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void fillWindow(int position, CursorWindow window) {
|
||||
assert(window == mWindow);
|
||||
|
||||
if (mWindowFillCount++ > 0) {
|
||||
Log.w(TAG, "Re-filling window on paged cursor! Reduce ContentResolver.QUERY_ARG_LIMIT");
|
||||
}
|
||||
|
||||
DatabaseUtils.cursorFillWindow(this, position, window);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps the cursor such that it will honor paging args (if present), AND if the cursor does
|
||||
* not report paging size.
|
||||
* <p>
|
||||
* No-op if cursor already contains paging or is less than specified page size.
|
||||
*/
|
||||
public static Cursor wrap(Cursor cursor, @Nullable Bundle queryArgs) {
|
||||
|
||||
boolean hasPagingArgs = queryArgs != null
|
||||
&& (queryArgs.containsKey(ContentResolver.QUERY_ARG_OFFSET)
|
||||
|| queryArgs.containsKey(ContentResolver.QUERY_ARG_LIMIT));
|
||||
|
||||
if (!hasPagingArgs) {
|
||||
if (VERBOSE) Log.v(TAG, "No-wrap: No paging args in request.");
|
||||
return cursor;
|
||||
}
|
||||
|
||||
if (hasPagedResponseDetails(cursor.getExtras())) {
|
||||
if (VERBOSE) Log.v(TAG, "No-wrap. Cursor has paging details.");
|
||||
return cursor;
|
||||
}
|
||||
|
||||
// Cursors that want all calls aren't compatible with our way
|
||||
// of doing business. TODO: Cover this case in CTS.
|
||||
if (cursor.getWantsAllOnMoveCalls()) {
|
||||
Log.w(TAG, "Unable to wrap cursor that wants to hear about move calls.");
|
||||
return cursor;
|
||||
}
|
||||
|
||||
return new PageViewCursor(cursor, queryArgs);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return true if the extras contains information indicating the associated cursor is
|
||||
* paged.
|
||||
*/
|
||||
private static boolean hasPagedResponseDetails(@Nullable Bundle extras) {
|
||||
if (extras == null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (extras.containsKey(ContentResolver.EXTRA_TOTAL_SIZE)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
String[] honoredArgs = extras.getStringArray(ContentResolver.EXTRA_HONORED_ARGS);
|
||||
if (honoredArgs != null
|
||||
&& (contains(honoredArgs, ContentResolver.QUERY_ARG_OFFSET)
|
||||
|| contains(honoredArgs, ContentResolver.QUERY_ARG_LIMIT))) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user