Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit eed44c9d authored by Fabrice Di Meglio's avatar Fabrice Di Meglio
Browse files

Fix bug #15342475 Settings search ranking improvement 

- introduce the "base rank" concept. All SearchIndexablesProvider
will have a base rank and the Settings one will get a "0" base rank.
- use a map whose key is the authority name for the provider to get
and store the base rank
- if a base rank is not defined, use the current max defined one and
increment it to define the new one.

Then we will compute the real rank this way:

rank = (providerRank > 0) ? baseRank + providerRank : baseRank

Change-Id: Ifa82bfcdfc07f25c4a5f304f47550686f7d4c13d
parent d4757e08

src/com/android/settings/search/Index.java

+12 −6
Original line number Diff line number Diff line
@@ -279,15 +279,17 @@ public class Index { 


    private boolean addIndexablesFromRemoteProvider(String packageName, String authority) {

        try {

            final int baseRank = Ranking.getBaseRankForAuthority(authority);



            final Context packageContext = mContext.createPackageContext(packageName, 0);



            final Uri uriForResources = buildUriForXmlResources(authority);

            addIndexablesForXmlResourceUri(packageContext, packageName, uriForResources,

                    SearchIndexablesContract.INDEXABLES_XML_RES_COLUMNS);

                    SearchIndexablesContract.INDEXABLES_XML_RES_COLUMNS, baseRank);



            final Uri uriForRawData = buildUriForRawData(authority);

            addIndexablesForRawDataUri(packageContext, packageName, uriForRawData,

                    SearchIndexablesContract.INDEXABLES_RAW_COLUMNS);

                    SearchIndexablesContract.INDEXABLES_RAW_COLUMNS, baseRank);

            return true;

        } catch (PackageManager.NameNotFoundException e) {

            Log.w(LOG_TAG, "Could not create context for " + packageName + ": "
@@ -496,7 +498,7 @@ public class Index { 
    }



    private void addIndexablesForXmlResourceUri(Context packageContext, String packageName,

            Uri uri, String[] projection) {

                                                Uri uri, String[] projection, int baseRank) {



        final ContentResolver resolver = packageContext.getContentResolver();

        final Cursor cursor = resolver.query(uri, projection, null, null, null);
@@ -510,7 +512,9 @@ public class Index { 
            final int count = cursor.getCount();

            if (count > 0) {

                while (cursor.moveToNext()) {

                    final int rank = cursor.getInt(COLUMN_INDEX_XML_RES_RANK);

                    final int providerRank = cursor.getInt(COLUMN_INDEX_XML_RES_RANK);

                    final int rank = (providerRank > 0) ? baseRank + providerRank : baseRank;



                    final int xmlResId = cursor.getInt(COLUMN_INDEX_XML_RES_RESID);



                    final String className = cursor.getString(COLUMN_INDEX_XML_RES_CLASS_NAME);
@@ -541,7 +545,7 @@ public class Index { 
    }



    private void addIndexablesForRawDataUri(Context packageContext, String packageName,

            Uri uri, String[] projection) {

                                            Uri uri, String[] projection, int baseRank) {



        final ContentResolver resolver = packageContext.getContentResolver();

        final Cursor cursor = resolver.query(uri, projection, null, null, null);
@@ -555,7 +559,9 @@ public class Index { 
            final int count = cursor.getCount();

            if (count > 0) {

                while (cursor.moveToNext()) {

                    final int rank = cursor.getInt(COLUMN_INDEX_RAW_RANK);

                    final int providerRank = cursor.getInt(COLUMN_INDEX_RAW_RANK);

                    final int rank = (providerRank > 0) ? baseRank + providerRank : baseRank;



                    final String title = cursor.getString(COLUMN_INDEX_RAW_TITLE);

                    final String summaryOn = cursor.getString(COLUMN_INDEX_RAW_SUMMARY_ON);

                    final String summaryOff = cursor.getString(COLUMN_INDEX_RAW_SUMMARY_OFF);

src/com/android/settings/search/Ranking.java

0 → 100644
+145 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2014 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.search;



import com.android.settings.DataUsageSummary;

import com.android.settings.DateTimeSettings;

import com.android.settings.DevelopmentSettings;

import com.android.settings.DeviceInfoSettings;

import com.android.settings.DisplaySettings;

import com.android.settings.HomeSettings;

import com.android.settings.PrivacySettings;

import com.android.settings.SecuritySettings;

import com.android.settings.WallpaperTypeSettings;

import com.android.settings.WirelessSettings;

import com.android.settings.accessibility.AccessibilitySettings;

import com.android.settings.bluetooth.BluetoothSettings;

import com.android.settings.deviceinfo.Memory;

import com.android.settings.fuelgauge.PowerUsageSummary;

import com.android.settings.inputmethod.InputMethodAndLanguageSettings;

import com.android.settings.location.LocationSettings;

import com.android.settings.notification.NotificationDisplaySettings;

import com.android.settings.notification.NotificationSettings;

import com.android.settings.notification.OtherSoundSettings;

import com.android.settings.notification.ZenModeSettings;

import com.android.settings.print.PrintSettingsFragment;

import com.android.settings.users.UserSettings;

import com.android.settings.wifi.AdvancedWifiSettings;

import com.android.settings.wifi.WifiSettings;



import java.util.HashMap;



/**

 * Utility class for dealing with Search Ranking.

 */

public final class Ranking {



    public static final int RANK_WIFI = 1;

    public static final int RANK_BT = 2;

    public static final int RANK_DATA_USAGE = 3;

    public static final int RANK_WIRELESS = 4;

    public static final int RANK_HOME = 5;

    public static final int RANK_DISPLAY = 6;

    public static final int RANK_WALLPAPER = 7;

    public static final int RANK_NOTIFICATIONS = 8;

    public static final int RANK_MEMORY = 9;

    public static final int RANK_POWER_USAGE = 10;

    public static final int RANK_USERS = 11;

    public static final int RANK_LOCATION = 12;

    public static final int RANK_SECURITY = 13;

    public static final int RANK_IME = 14;

    public static final int RANK_PRIVACY = 15;

    public static final int RANK_DATE_TIME = 16;

    public static final int RANK_ACCESSIBILITY = 17;

    public static final int RANK_PRINTING = 18;

    public static final int RANK_DEVELOPEMENT = 19;

    public static final int RANK_DEVICE_INFO = 20;



    public static final int RANK_UNDEFINED = -1;

    public static final int RANK_OTHERS = 1024;

    public static final int BASE_RANK_DEFAULT = 2048;



    public static int sCurrentBaseRank = BASE_RANK_DEFAULT;



    private static HashMap<String, Integer> sRankMap = new HashMap<String, Integer>();

    private static HashMap<String, Integer> sBaseRankMap = new HashMap<String, Integer>();



    static {

        sRankMap.put(WifiSettings.class.getName(), RANK_WIFI);

        sRankMap.put(AdvancedWifiSettings.class.getName(), RANK_WIFI);



        sRankMap.put(BluetoothSettings.class.getName(), RANK_BT);



        sRankMap.put(DataUsageSummary.class.getName(), RANK_DATA_USAGE);



        sRankMap.put(WirelessSettings.class.getName(), RANK_WIRELESS);



        sRankMap.put(HomeSettings.class.getName(), RANK_HOME);



        sRankMap.put(DisplaySettings.class.getName(), RANK_DISPLAY);



        sRankMap.put(WallpaperTypeSettings.class.getName(), RANK_WALLPAPER);



        sRankMap.put(NotificationSettings.class.getName(), RANK_NOTIFICATIONS);

        sRankMap.put(NotificationDisplaySettings.class.getName(), RANK_NOTIFICATIONS);

        sRankMap.put(OtherSoundSettings.class.getName(), RANK_NOTIFICATIONS);

        sRankMap.put(ZenModeSettings.class.getName(), RANK_NOTIFICATIONS);



        sRankMap.put(Memory.class.getName(), RANK_MEMORY);



        sRankMap.put(PowerUsageSummary.class.getName(), RANK_POWER_USAGE);



        sRankMap.put(UserSettings.class.getName(), RANK_USERS);



        sRankMap.put(LocationSettings.class.getName(), RANK_LOCATION);



        sRankMap.put(SecuritySettings.class.getName(), RANK_SECURITY);



        sRankMap.put(InputMethodAndLanguageSettings.class.getName(), RANK_IME);



        sRankMap.put(PrivacySettings.class.getName(), RANK_PRIVACY);



        sRankMap.put(DateTimeSettings.class.getName(), RANK_DATE_TIME);



        sRankMap.put(AccessibilitySettings.class.getName(), RANK_ACCESSIBILITY);



        sRankMap.put(PrintSettingsFragment.class.getName(), RANK_PRINTING);



        sRankMap.put(DevelopmentSettings.class.getName(), RANK_DEVELOPEMENT);



        sRankMap.put(DeviceInfoSettings.class.getName(), RANK_DEVICE_INFO);



        sBaseRankMap.put("com.android.settings", 0);

    }



    public static int getRankForClassName(String className) {

        Integer rank = sRankMap.get(className);

        return (rank != null) ? (int) rank: RANK_OTHERS;

    }



    public static int getBaseRankForAuthority(String authority) {

        synchronized (sBaseRankMap) {

            Integer base = sBaseRankMap.get(authority);

            if (base != null) {

                return base;

            }

            sCurrentBaseRank++;

            sBaseRankMap.put(authority, sCurrentBaseRank);

            return sCurrentBaseRank;

        }

    }

}

src/com/android/settings/search/SearchIndexableResources.java

+48 −46
Original line number Diff line number Diff line
@@ -51,172 +51,174 @@ public final class SearchIndexableResources { 


    public static int NO_DATA_RES_ID = 0;



    public static final int RANK_WIFI = 1;

    public static final int RANK_BT = 2;

    public static final int RANK_DATA_USAGE = 3;

    public static final int RANK_WIRELESS = 4;

    public static final int RANK_HOME = 5;

    public static final int RANK_DISPLAY = 7;

    public static final int RANK_WALLPAPER = 7;

    public static final int RANK_NOTIFICATIONS = 8;

    public static final int RANK_MEMORY = 9;

    public static final int RANK_POWER_USAGE = 10;

    public static final int RANK_USERS = 11;

    public static final int RANK_LOCATION = 12;

    public static final int RANK_SECURITY = 13;

    public static final int RANK_IME = 14;

    public static final int RANK_PRIVACY = 15;

    public static final int RANK_DATE_TIME = 16;

    public static final int RANK_ACCESSIBILITY = 17;

    public static final int RANK_PRINTING = 18;

    public static final int RANK_DEVELOPEMENT = 19;

    public static final int RANK_DEVICE_INFO = 20;



    private static HashMap<String, SearchIndexableResource> sResMap =

            new HashMap<String, SearchIndexableResource>();





    static {

        sResMap.put(WifiSettings.class.getName(),

                new SearchIndexableResource(RANK_WIFI,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(WifiSettings.class.getName()),

                        NO_DATA_RES_ID,

                        WifiSettings.class.getName(),

                        R.drawable.ic_settings_wireless));



        sResMap.put(WifiSettings.class.getName(),

                new SearchIndexableResource(RANK_WIFI,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(AdvancedWifiSettings.class.getName()),

                        R.xml.wifi_advanced_settings,

                        AdvancedWifiSettings.class.getName(),

                        R.drawable.ic_settings_wireless));



        sResMap.put(BluetoothSettings.class.getName(),

                new SearchIndexableResource(RANK_BT,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(BluetoothSettings.class.getName()),

                        NO_DATA_RES_ID,

                        BluetoothSettings.class.getName(),

                        R.drawable.ic_settings_bluetooth2));



        sResMap.put(DataUsageSummary.class.getName(),

                new SearchIndexableResource(RANK_DATA_USAGE,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(DataUsageSummary.class.getName()),

                        NO_DATA_RES_ID,

                        DataUsageSummary.class.getName(),

                        R.drawable.ic_settings_data_usage));



        sResMap.put(WirelessSettings.class.getName(),

                new SearchIndexableResource(RANK_WIRELESS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(WirelessSettings.class.getName()),

                        R.xml.wireless_settings,

                        WirelessSettings.class.getName(),

                        R.drawable.empty_icon));



        sResMap.put(HomeSettings.class.getName(),

                new SearchIndexableResource(RANK_HOME,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(HomeSettings.class.getName()),

                        R.xml.home_selection,

                        HomeSettings.class.getName(),

                        R.drawable.ic_settings_home));



        sResMap.put(DisplaySettings.class.getName(),

                new SearchIndexableResource(RANK_DISPLAY,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(DisplaySettings.class.getName()),

                        R.xml.display_settings,

                        DisplaySettings.class.getName(),

                        R.drawable.ic_settings_display));



        sResMap.put(WallpaperTypeSettings.class.getName(),

                new SearchIndexableResource(RANK_WALLPAPER,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(WallpaperTypeSettings.class.getName()),

                        NO_DATA_RES_ID,

                        WallpaperTypeSettings.class.getName(),

                        R.drawable.ic_settings_display));



        sResMap.put(NotificationSettings.class.getName(),

                new SearchIndexableResource(RANK_NOTIFICATIONS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(NotificationSettings.class.getName()),

                        NO_DATA_RES_ID,

                        NotificationSettings.class.getName(),

                        R.drawable.ic_settings_notifications));



        sResMap.put(NotificationDisplaySettings.class.getName(),

                new SearchIndexableResource(RANK_NOTIFICATIONS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(NotificationDisplaySettings.class.getName()),

                        R.xml.notification_display_settings,

                        NotificationDisplaySettings.class.getName(),

                        R.drawable.ic_settings_notifications));



        sResMap.put(OtherSoundSettings.class.getName(),

                new SearchIndexableResource(RANK_NOTIFICATIONS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(OtherSoundSettings.class.getName()),

                        NO_DATA_RES_ID,

                        OtherSoundSettings.class.getName(),

                        R.drawable.ic_settings_notifications));



        sResMap.put(ZenModeSettings.class.getName(),

                new SearchIndexableResource(RANK_NOTIFICATIONS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(ZenModeSettings.class.getName()),

                        NO_DATA_RES_ID,

                        ZenModeSettings.class.getName(),

                        R.drawable.ic_settings_notifications));



        sResMap.put(Memory.class.getName(),

                new SearchIndexableResource(RANK_MEMORY,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(Memory.class.getName()),

                        NO_DATA_RES_ID,

                        Memory.class.getName(),

                        R.drawable.ic_settings_storage));



        sResMap.put(PowerUsageSummary.class.getName(),

                new SearchIndexableResource(RANK_POWER_USAGE,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(PowerUsageSummary.class.getName()),

                        R.xml.power_usage_summary,

                        PowerUsageSummary.class.getName(),

                        R.drawable.ic_settings_battery));



        sResMap.put(UserSettings.class.getName(),

                new SearchIndexableResource(RANK_USERS,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(UserSettings.class.getName()),

                        R.xml.user_settings,

                        UserSettings.class.getName(),

                        R.drawable.ic_settings_multiuser));



        sResMap.put(LocationSettings.class.getName(),

                new SearchIndexableResource(RANK_LOCATION,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(LocationSettings.class.getName()),

                        R.xml.location_settings,

                        LocationSettings.class.getName(),

                        R.drawable.ic_settings_location));



        sResMap.put(SecuritySettings.class.getName(),

                new SearchIndexableResource(RANK_SECURITY,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(SecuritySettings.class.getName()),

                        NO_DATA_RES_ID,

                        SecuritySettings.class.getName(),

                        R.drawable.ic_settings_security));



        sResMap.put(InputMethodAndLanguageSettings.class.getName(),

                new SearchIndexableResource(RANK_IME,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(InputMethodAndLanguageSettings.class.getName()),

                        NO_DATA_RES_ID,

                        InputMethodAndLanguageSettings.class.getName(),

                        R.drawable.ic_settings_language));



        sResMap.put(PrivacySettings.class.getName(),

                new SearchIndexableResource(RANK_PRIVACY,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(PrivacySettings.class.getName()),

                        R.xml.privacy_settings,

                        PrivacySettings.class.getName(),

                        R.drawable.ic_settings_backup));



        sResMap.put(DateTimeSettings.class.getName(),

                new SearchIndexableResource(RANK_DATE_TIME,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(DateTimeSettings.class.getName()),

                        R.xml.date_time_prefs,

                        DateTimeSettings.class.getName(),

                        R.drawable.ic_settings_date_time));



        sResMap.put(AccessibilitySettings.class.getName(),

                new SearchIndexableResource(RANK_ACCESSIBILITY,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(AccessibilitySettings.class.getName()),

                        NO_DATA_RES_ID,

                        AccessibilitySettings.class.getName(),

                        R.drawable.ic_settings_accessibility));



        sResMap.put(PrintSettingsFragment.class.getName(),

                new SearchIndexableResource(RANK_PRINTING,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(PrintSettingsFragment.class.getName()),

                        NO_DATA_RES_ID,

                        PrintSettingsFragment.class.getName(),

                        R.drawable.ic_settings_print));



        sResMap.put(DevelopmentSettings.class.getName(),

                new SearchIndexableResource(RANK_DEVELOPEMENT,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(DevelopmentSettings.class.getName()),

                        R.xml.development_prefs,

                        DevelopmentSettings.class.getName(),

                        R.drawable.ic_settings_development));



        sResMap.put(DeviceInfoSettings.class.getName(),

                new SearchIndexableResource(RANK_DEVICE_INFO,

                new SearchIndexableResource(

                        Ranking.getRankForClassName(DeviceInfoSettings.class.getName()),

                        R.xml.device_info_settings,

                        DeviceInfoSettings.class.getName(),

                        R.drawable.ic_settings_about));