Merge "Add a service to rank apps for ResolverActivity." into oc-dev
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
/*
|
||||
* 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 android.service.resolver;
|
||||
|
||||
import android.service.resolver.ResolverTarget;
|
||||
|
||||
/**
|
||||
* @hide
|
||||
*/
|
||||
oneway interface IResolverRankerResult
|
||||
{
|
||||
void sendResult(in List<ResolverTarget> results);
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
/*
|
||||
* 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 android.service.resolver;
|
||||
|
||||
import android.service.resolver.IResolverRankerResult;
|
||||
import android.service.resolver.ResolverTarget;
|
||||
|
||||
/**
|
||||
* @hide
|
||||
*/
|
||||
oneway interface IResolverRankerService
|
||||
{
|
||||
void predict(in List<ResolverTarget> targets, IResolverRankerResult result);
|
||||
void train(in List<ResolverTarget> targets, int selectedPosition);
|
||||
}
|
||||
187
core/java/android/service/resolver/ResolverRankerService.java
Normal file
187
core/java/android/service/resolver/ResolverRankerService.java
Normal file
@@ -0,0 +1,187 @@
|
||||
/*
|
||||
* 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 android.service.resolver;
|
||||
|
||||
import android.annotation.SdkConstant;
|
||||
import android.annotation.SystemApi;
|
||||
import android.app.Service;
|
||||
import android.content.ComponentName;
|
||||
import android.content.Intent;
|
||||
import android.os.IBinder;
|
||||
import android.os.Handler;
|
||||
import android.os.HandlerThread;
|
||||
import android.os.RemoteException;
|
||||
import android.service.resolver.ResolverTarget;
|
||||
import android.util.Log;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A service to rank apps according to usage stats of apps, when the system is resolving targets for
|
||||
* an Intent.
|
||||
*
|
||||
* <p>To extend this class, you must declare the service in your manifest file with the
|
||||
* {@link android.Manifest.permission#BIND_RESOLVER_RANKER_SERVICE} permission, and include an
|
||||
* intent filter with the {@link #SERVICE_INTERFACE} action. For example:</p>
|
||||
* <pre>
|
||||
* <service android:name=".MyResolverRankerService"
|
||||
* android:exported="true"
|
||||
* android:priority="100"
|
||||
* android:permission="android.permission.BIND_RESOLVER_RANKER_SERVICE">
|
||||
* <intent-filter>
|
||||
* <action android:name="android.service.resolver.ResolverRankerService" />
|
||||
* </intent-filter>
|
||||
* </service>
|
||||
* </pre>
|
||||
* @hide
|
||||
*/
|
||||
@SystemApi
|
||||
public abstract class ResolverRankerService extends Service {
|
||||
|
||||
private static final String TAG = "ResolverRankerService";
|
||||
|
||||
private static final boolean DEBUG = false;
|
||||
|
||||
/**
|
||||
* The Intent action that a service must respond to. Add it to the intent filter of the service
|
||||
* in its manifest.
|
||||
*/
|
||||
@SdkConstant(SdkConstant.SdkConstantType.SERVICE_ACTION)
|
||||
public static final String SERVICE_INTERFACE = "android.service.resolver.ResolverRankerService";
|
||||
|
||||
/**
|
||||
* The permission that a service must require to ensure that only Android system can bind to it.
|
||||
* If this permission is not enforced in the AndroidManifest of the service, the system will
|
||||
* skip that service.
|
||||
*/
|
||||
public static final String BIND_PERMISSION = "android.permission.BIND_RESOLVER_RANKER_SERVICE";
|
||||
|
||||
private ResolverRankerServiceWrapper mWrapper = null;
|
||||
|
||||
/**
|
||||
* Called by the system to retrieve a list of probabilities to rank apps/options. To implement
|
||||
* it, set selectProbability of each input {@link ResolverTarget}. The higher the
|
||||
* selectProbability is, the more likely the {@link ResolverTarget} will be selected by the
|
||||
* user. Override this function to provide prediction results.
|
||||
*
|
||||
* @param targets a list of {@link ResolverTarget}, for the list of apps to be ranked.
|
||||
*
|
||||
* @throws Exception when the prediction task fails.
|
||||
*/
|
||||
public void onPredictSharingProbabilities(final List<ResolverTarget> targets) {}
|
||||
|
||||
/**
|
||||
* Called by the system to train/update a ranking service, after the user makes a selection from
|
||||
* the ranked list of apps. Override this function to enable model updates.
|
||||
*
|
||||
* @param targets a list of {@link ResolverTarget}, for the list of apps to be ranked.
|
||||
* @param selectedPosition the position of the selected app in the list.
|
||||
*
|
||||
* @throws Exception when the training task fails.
|
||||
*/
|
||||
public void onTrainRankingModel(
|
||||
final List<ResolverTarget> targets, final int selectedPosition) {}
|
||||
|
||||
private static final String HANDLER_THREAD_NAME = "RESOLVER_RANKER_SERVICE";
|
||||
private volatile Handler mHandler;
|
||||
private HandlerThread mHandlerThread;
|
||||
|
||||
@Override
|
||||
public IBinder onBind(Intent intent) {
|
||||
if (DEBUG) Log.d(TAG, "onBind " + intent);
|
||||
if (!SERVICE_INTERFACE.equals(intent.getAction())) {
|
||||
if (DEBUG) Log.d(TAG, "bad intent action " + intent.getAction() + "; returning null");
|
||||
return null;
|
||||
}
|
||||
if (mHandlerThread == null) {
|
||||
mHandlerThread = new HandlerThread(HANDLER_THREAD_NAME);
|
||||
mHandlerThread.start();
|
||||
mHandler = new Handler(mHandlerThread.getLooper());
|
||||
}
|
||||
if (mWrapper == null) {
|
||||
mWrapper = new ResolverRankerServiceWrapper();
|
||||
}
|
||||
return mWrapper;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onDestroy() {
|
||||
mHandler = null;
|
||||
if (mHandlerThread != null) {
|
||||
mHandlerThread.quitSafely();
|
||||
}
|
||||
super.onDestroy();
|
||||
}
|
||||
|
||||
private static void sendResult(List<ResolverTarget> targets, IResolverRankerResult result) {
|
||||
try {
|
||||
result.sendResult(targets);
|
||||
} catch (Exception e) {
|
||||
Log.e(TAG, "failed to send results: " + e);
|
||||
}
|
||||
}
|
||||
|
||||
private class ResolverRankerServiceWrapper extends IResolverRankerService.Stub {
|
||||
|
||||
@Override
|
||||
public void predict(final List<ResolverTarget> targets, final IResolverRankerResult result)
|
||||
throws RemoteException {
|
||||
Runnable predictRunnable = new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
if (DEBUG) {
|
||||
Log.d(TAG, "predict calls onPredictSharingProbabilities.");
|
||||
}
|
||||
onPredictSharingProbabilities(targets);
|
||||
sendResult(targets, result);
|
||||
} catch (Exception e) {
|
||||
Log.e(TAG, "onPredictSharingProbabilities failed; send null results: " + e);
|
||||
sendResult(null, result);
|
||||
}
|
||||
}
|
||||
};
|
||||
final Handler h = mHandler;
|
||||
if (h != null) {
|
||||
h.post(predictRunnable);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void train(final List<ResolverTarget> targets, final int selectedPosition)
|
||||
throws RemoteException {
|
||||
Runnable trainRunnable = new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
if (DEBUG) {
|
||||
Log.d(TAG, "train calls onTranRankingModel");
|
||||
}
|
||||
onTrainRankingModel(targets, selectedPosition);
|
||||
} catch (Exception e) {
|
||||
Log.e(TAG, "onTrainRankingModel failed; skip train: " + e);
|
||||
}
|
||||
}
|
||||
};
|
||||
final Handler h = mHandler;
|
||||
if (h != null) {
|
||||
h.post(trainRunnable);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
22
core/java/android/service/resolver/ResolverTarget.aidl
Normal file
22
core/java/android/service/resolver/ResolverTarget.aidl
Normal file
@@ -0,0 +1,22 @@
|
||||
/*
|
||||
* 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 android.service.resolver;
|
||||
|
||||
/**
|
||||
* @hide
|
||||
*/
|
||||
parcelable ResolverTarget;
|
||||
216
core/java/android/service/resolver/ResolverTarget.java
Normal file
216
core/java/android/service/resolver/ResolverTarget.java
Normal file
@@ -0,0 +1,216 @@
|
||||
/*
|
||||
* 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 android.service.resolver;
|
||||
|
||||
import android.annotation.SystemApi;
|
||||
import android.os.Bundle;
|
||||
import android.os.Parcel;
|
||||
import android.os.Parcelable;
|
||||
import android.util.ArrayMap;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A ResolverTarget contains features by which an app or option will be ranked, in
|
||||
* {@link ResolverRankerService}.
|
||||
* @hide
|
||||
*/
|
||||
@SystemApi
|
||||
public final class ResolverTarget implements Parcelable {
|
||||
private static final String TAG = "ResolverTarget";
|
||||
|
||||
/**
|
||||
* a float score for recency of last use.
|
||||
*/
|
||||
private float mRecencyScore;
|
||||
|
||||
/**
|
||||
* a float score for total time spent.
|
||||
*/
|
||||
private float mTimeSpentScore;
|
||||
|
||||
/**
|
||||
* a float score for number of launches.
|
||||
*/
|
||||
private float mLaunchScore;
|
||||
|
||||
/**
|
||||
* a float score for number of selected.
|
||||
*/
|
||||
private float mChooserScore;
|
||||
|
||||
/**
|
||||
* a float score for the probability to be selected.
|
||||
*/
|
||||
private float mSelectProbability;
|
||||
|
||||
// constructor for the class.
|
||||
public ResolverTarget() {}
|
||||
|
||||
ResolverTarget(Parcel in) {
|
||||
mRecencyScore = in.readFloat();
|
||||
mTimeSpentScore = in.readFloat();
|
||||
mLaunchScore = in.readFloat();
|
||||
mChooserScore = in.readFloat();
|
||||
mSelectProbability = in.readFloat();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the score for how recently the target was used in the foreground.
|
||||
*
|
||||
* @return a float score whose range is [0, 1]. The higher the score is, the more recently the
|
||||
* target was used.
|
||||
*/
|
||||
public float getRecencyScore() {
|
||||
return mRecencyScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the score for how recently the target was used in the foreground.
|
||||
*
|
||||
* @param recencyScore a float score whose range is [0, 1]. The higher the score is, the more
|
||||
* recently the target was used.
|
||||
*/
|
||||
public void setRecencyScore(float recencyScore) {
|
||||
this.mRecencyScore = recencyScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the score for how long the target has been used in the foreground.
|
||||
*
|
||||
* @return a float score whose range is [0, 1]. The higher the score is, the longer the target
|
||||
* has been used for.
|
||||
*/
|
||||
public float getTimeSpentScore() {
|
||||
return mTimeSpentScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the score for how long the target has been used in the foreground.
|
||||
*
|
||||
* @param timeSpentScore a float score whose range is [0, 1]. The higher the score is, the
|
||||
* longer the target has been used for.
|
||||
*/
|
||||
public void setTimeSpentScore(float timeSpentScore) {
|
||||
this.mTimeSpentScore = timeSpentScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the score for how many times the target has been launched to the foreground.
|
||||
*
|
||||
* @return a float score whose range is [0, 1]. The higher the score is, the more times the
|
||||
* target has been launched.
|
||||
*/
|
||||
public float getLaunchScore() {
|
||||
return mLaunchScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the score for how many times the target has been launched to the foreground.
|
||||
*
|
||||
* @param launchScore a float score whose range is [0, 1]. The higher the score is, the more
|
||||
* times the target has been launched.
|
||||
*/
|
||||
public void setLaunchScore(float launchScore) {
|
||||
this.mLaunchScore = launchScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the score for how many times the target has been selected by the user to share the same
|
||||
* types of content.
|
||||
*
|
||||
* @return a float score whose range is [0, 1]. The higher the score is, the
|
||||
* more times the target has been selected by the user to share the same types of content for.
|
||||
*/
|
||||
public float getChooserScore() {
|
||||
return mChooserScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the score for how many times the target has been selected by the user to share the same
|
||||
* types of content.
|
||||
*
|
||||
* @param chooserScore a float score whose range is [0, 1]. The higher the score is, the more
|
||||
* times the target has been selected by the user to share the same types
|
||||
* of content for.
|
||||
*/
|
||||
public void setChooserScore(float chooserScore) {
|
||||
this.mChooserScore = chooserScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the probability of how likely this target will be selected by the user.
|
||||
*
|
||||
* @return a float score whose range is [0, 1]. The higher the score is, the more likely the
|
||||
* user is going to select this target.
|
||||
*/
|
||||
public float getSelectProbability() {
|
||||
return mSelectProbability;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the probability for how like this target will be selected by the user.
|
||||
*
|
||||
* @param selectProbability a float score whose range is [0, 1]. The higher the score is, the
|
||||
* more likely tht user is going to select this target.
|
||||
*/
|
||||
public void setSelectProbability(float selectProbability) {
|
||||
this.mSelectProbability = selectProbability;
|
||||
}
|
||||
|
||||
// serialize the class to a string.
|
||||
@Override
|
||||
public String toString() {
|
||||
return "ResolverTarget{"
|
||||
+ mRecencyScore + ", "
|
||||
+ mTimeSpentScore + ", "
|
||||
+ mLaunchScore + ", "
|
||||
+ mChooserScore + ", "
|
||||
+ mSelectProbability + "}";
|
||||
}
|
||||
|
||||
// describes the kinds of special objects contained in this Parcelable instance's marshaled
|
||||
// representation.
|
||||
@Override
|
||||
public int describeContents() {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// flattens this object in to a Parcel.
|
||||
@Override
|
||||
public void writeToParcel(Parcel dest, int flags) {
|
||||
dest.writeFloat(mRecencyScore);
|
||||
dest.writeFloat(mTimeSpentScore);
|
||||
dest.writeFloat(mLaunchScore);
|
||||
dest.writeFloat(mChooserScore);
|
||||
dest.writeFloat(mSelectProbability);
|
||||
}
|
||||
|
||||
// creator definition for the class.
|
||||
public static final Creator<ResolverTarget> CREATOR
|
||||
= new Creator<ResolverTarget>() {
|
||||
@Override
|
||||
public ResolverTarget createFromParcel(Parcel source) {
|
||||
return new ResolverTarget(source);
|
||||
}
|
||||
|
||||
@Override
|
||||
public ResolverTarget[] newArray(int size) {
|
||||
return new ResolverTarget[size];
|
||||
}
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user