1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
* 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 com.android.settings.intelligence.search;
import android.content.Context;
import android.util.Pair;
import android.view.View;
import com.android.settings.intelligence.search.indexing.DatabaseIndexingManager;
import com.android.settings.intelligence.search.indexing.IndexingCallback;
import com.android.settings.intelligence.search.query.SearchQueryTask;
import com.android.settings.intelligence.search.savedqueries.SavedQueryLoader;
import com.android.settings.intelligence.search.sitemap.SiteMapManager;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.FutureTask;
/**
* FeatureProvider for Settings Search
*/
public interface SearchFeatureProvider {
boolean DEBUG = false;
/**
* Returns a new loader to get settings search results.
*/
SearchResultLoader getSearchResultLoader(Context context, String query);
/**
* Returns a list of {@link SearchQueryTask}, each responsible for searching a subsystem for
* user query.
*/
List<SearchQueryTask> getSearchQueryTasks(Context context, String query);
/**
* Returns a new loader to get all recently saved queries search terms.
*/
SavedQueryLoader getSavedQueryLoader(Context context);
/**
* Returns the manager for indexing Settings data.
*/
DatabaseIndexingManager getIndexingManager(Context context);
/**
* Returns the manager for looking up breadcrumbs.
*/
SiteMapManager getSiteMapManager();
/**
* Updates the Settings indexes and calls {@link IndexingCallback#onIndexingFinished()} on
* {@param callback} when indexing is complete.
*/
void updateIndexAsync(Context context, IndexingCallback callback);
/**
* @returns true when indexing is complete.
*/
boolean isIndexingComplete(Context context);
/**
* @return a {@link ExecutorService} to be shared between search tasks.
*/
ExecutorService getExecutorService();
/**
* Initializes the feedback button in case it was dismissed.
*/
void initFeedbackButton();
/**
* Show a button users can click to submit feedback on the quality of the search results.
*/
void showFeedbackButton(SearchFragment fragment, View root);
/**
* Hide the feedback button shown by
* {@link #showFeedbackButton(SearchFragment fragment, View view) showFeedbackButton}
*/
void hideFeedbackButton(View root);
/**
* Notify that a search result is clicked.
*
* @param context application context
* @param query input user query
* @param searchResult clicked result
*/
void searchResultClicked(Context context, String query, SearchResult searchResult);
/**
* @return true to enable search ranking.
*/
boolean isSmartSearchRankingEnabled(Context context);
/**
* @return smart ranking timeout in milliseconds.
*/
long smartSearchRankingTimeoutMs(Context context);
/**
* Prepare for search ranking predictions to avoid latency on the first prediction call.
*/
void searchRankingWarmup(Context context);
/**
* Return a FutureTask to get a list of scores for search results.
*/
FutureTask<List<Pair<String, Float>>> getRankerTask(Context context, String query);
}
|
