| /* |
| * Copyright 2020 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.app.appsearch; |
| |
| import android.annotation.CallbackExecutor; |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.UserIdInt; |
| import android.os.Bundle; |
| import android.os.RemoteException; |
| import android.util.Log; |
| |
| import java.io.Closeable; |
| import java.util.List; |
| import java.util.Objects; |
| import java.util.concurrent.Executor; |
| import java.util.function.Consumer; |
| |
| /** |
| * SearchResults are a returned object from a query API. |
| * |
| * <p>Each {@link SearchResult} contains a document and may contain other fields like snippets |
| * based on request. |
| * |
| * <p>Should close this object after finish fetching results. |
| * |
| * <p>This class is not thread safe. |
| */ |
| public class SearchResults implements Closeable { |
| private static final String TAG = "SearchResults"; |
| |
| private final IAppSearchManager mService; |
| |
| // The database name to search over. If null, this will search over all database names. |
| @Nullable |
| private final String mDatabaseName; |
| |
| private final String mQueryExpression; |
| |
| private final SearchSpec mSearchSpec; |
| |
| @UserIdInt |
| private final int mUserId; |
| |
| private final Executor mExecutor; |
| |
| private long mNextPageToken; |
| |
| private boolean mIsFirstLoad = true; |
| |
| SearchResults( |
| @NonNull IAppSearchManager service, |
| @Nullable String databaseName, |
| @NonNull String queryExpression, |
| @NonNull SearchSpec searchSpec, |
| @UserIdInt int userId, |
| @NonNull @CallbackExecutor Executor executor) { |
| mService = Objects.requireNonNull(service); |
| mDatabaseName = databaseName; |
| mQueryExpression = Objects.requireNonNull(queryExpression); |
| mSearchSpec = Objects.requireNonNull(searchSpec); |
| mUserId = userId; |
| mExecutor = Objects.requireNonNull(executor); |
| } |
| |
| /** |
| * Gets a whole page of {@link SearchResult}s. |
| * |
| * <p>Re-call this method to get next page of {@link SearchResult}, until it returns an |
| * empty list. |
| * |
| * <p>The page size is set by {@link SearchSpec.Builder#setResultCountPerPage}. |
| * |
| * @param callback Callback to receive the pending result of performing this operation. |
| */ |
| public void getNextPage(@NonNull Consumer<AppSearchResult<List<SearchResult>>> callback) { |
| try { |
| if (mIsFirstLoad) { |
| mIsFirstLoad = false; |
| if (mDatabaseName == null) { |
| // Global query, there's no one package-database combination to check. |
| mService.globalQuery(mQueryExpression, mSearchSpec.getBundle(), mUserId, |
| wrapCallback(callback)); |
| } else { |
| // Normal local query, pass in specified database. |
| mService.query( |
| mDatabaseName, mQueryExpression, mSearchSpec.getBundle(), mUserId, |
| wrapCallback(callback)); |
| } |
| } else { |
| mService.getNextPage(mNextPageToken, mUserId, wrapCallback(callback)); |
| } |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| @Override |
| public void close() { |
| try { |
| mService.invalidateNextPageToken(mNextPageToken, mUserId); |
| } catch (RemoteException e) { |
| Log.d(TAG, "Unable to close the SearchResults", e); |
| } |
| } |
| |
| private IAppSearchResultCallback wrapCallback( |
| @NonNull Consumer<AppSearchResult<List<SearchResult>>> callback) { |
| return new IAppSearchResultCallback.Stub() { |
| public void onResult(AppSearchResult result) { |
| mExecutor.execute(() -> invokeCallback(result, callback)); |
| } |
| }; |
| } |
| |
| private void invokeCallback(AppSearchResult result, |
| @NonNull Consumer<AppSearchResult<List<SearchResult>>> callback) { |
| if (result.isSuccess()) { |
| try { |
| SearchResultPage searchResultPage = |
| new SearchResultPage((Bundle) result.getResultValue()); |
| mNextPageToken = searchResultPage.getNextPageToken(); |
| callback.accept(AppSearchResult.newSuccessfulResult( |
| searchResultPage.getResults())); |
| } catch (Throwable t) { |
| callback.accept(AppSearchResult.throwableToFailedResult(t)); |
| } |
| } else { |
| callback.accept(result); |
| } |
| } |
| } |