1 /* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.settings.search; 18 19 import android.content.Context; 20 import android.provider.SearchIndexableResource; 21 import com.android.settings.core.PreferenceControllerMixin; 22 import com.android.settingslib.core.AbstractPreferenceController; 23 24 import java.util.List; 25 26 /** 27 * Interface for classes whose instances can provide data for indexing. 28 * 29 * Classes implementing the Indexable interface must have a static field called 30 * <code>SEARCH_INDEX_DATA_PROVIDER</code>, which is an object implementing the 31 * {@link Indexable.SearchIndexProvider} interface. 32 * 33 * See {@link android.provider.SearchIndexableResource} and {@link SearchIndexableRaw}. 34 * 35 */ 36 public interface Indexable { 37 38 interface SearchIndexProvider { 39 /** 40 * Return a list of references for indexing. 41 * 42 * See {@link android.provider.SearchIndexableResource} 43 * 44 * 45 * @param context the context. 46 * @param enabled hint telling if the data needs to be considered into the search results 47 * or not. 48 * @return a list of {@link android.provider.SearchIndexableResource} references. 49 * Can be null. 50 */ getXmlResourcesToIndex(Context context, boolean enabled)51 List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled); 52 53 /** 54 * Return a list of raw data for indexing. See {@link SearchIndexableRaw} 55 * 56 * @param context the context. 57 * @param enabled hint telling if the data needs to be considered into the search results 58 * or not. 59 * @return a list of {@link SearchIndexableRaw} references. Can be null. 60 */ getRawDataToIndex(Context context, boolean enabled)61 List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled); 62 63 /** 64 * Return a list of data keys that cannot be indexed. See {@link SearchIndexableRaw} 65 * 66 * @param context the context. 67 * @return a list of {@link SearchIndexableRaw} references. Can be null. 68 */ getNonIndexableKeys(Context context)69 List<String> getNonIndexableKeys(Context context); 70 71 /** 72 * @param context 73 * @return a list of {@link AbstractPreferenceController} for ResultPayload data during 74 * Indexing. 75 */ getPreferenceControllers(Context context)76 List<AbstractPreferenceController> getPreferenceControllers(Context context); 77 } 78 } 79