Home | History | Annotate | Download | only in search 
      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 
     22 import java.util.List;
     23 
     24 /**
     25  * Interface for classes whose instances can provide data for indexing.
     26  *
     27  * Classes implementing the Indexable interface must have a static field called
     28  * <code>SEARCH_INDEX_DATA_PROVIDER</code>, which is an object implementing the
     29  * {@link Indexable.SearchIndexProvider} interface.
     30  *
     31  * See {@link android.provider.SearchIndexableResource} and {@link SearchIndexableRaw}.
     32  *
     33  */
     34 public interface Indexable {
     35 
     36     public interface SearchIndexProvider {
     37         /**
     38          * Return a list of references for indexing.
     39          *
     40          * See {@link android.provider.SearchIndexableResource}
     41          *
     42          *
     43          * @param context the context.
     44          * @param enabled hint telling if the data needs to be considered into the search results
     45          *                or not.
     46          * @return a list of {@link android.provider.SearchIndexableResource} references.
     47          *         Can be null.
     48          */
     49         List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled);
     50 
     51         /**
     52          * Return a list of raw data for indexing. See {@link SearchIndexableRaw}
     53          *
     54          * @param context the context.
     55          * @param enabled hint telling if the data needs to be considered into the search results
     56          *                or not.
     57          * @return a list of {@link SearchIndexableRaw} references. Can be null.
     58          */
     59         List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled);
     60 
     61         /**
     62          * Return a list of data keys that cannot be indexed. See {@link SearchIndexableRaw}
     63          *
     64          * @param context the context.
     65          * @return a list of {@link SearchIndexableRaw} references. Can be null.
     66          */
     67         List<String> getNonIndexableKeys(Context context);
     68     }
     69 }
     70