Making TextClassifier helper objects parcelable
- EntityConfidence is no longer generic because it doesn't mix well with
being Parcelable.
- Deprecated OnClick listeners in TextClassification as they can't be
parceled. (Outright removed the secondary listeners that were not part
of any release)
- Classes that were present in previous releases have their parceling
factored out into ParcelableWrapper helper classes for backwards
compatibility.
Bug: 67609167
Test: Added
Change-Id: I820ca4abc6b80f90007ab4424bc5df2a14f797b0
diff --git a/core/tests/coretests/src/android/view/textclassifier/TextClassificationTest.java b/core/tests/coretests/src/android/view/textclassifier/TextClassificationTest.java
new file mode 100644
index 0000000..9ee7fac
--- /dev/null
+++ b/core/tests/coretests/src/android/view/textclassifier/TextClassificationTest.java
@@ -0,0 +1,161 @@
+/*
+ * 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.view.textclassifier;
+
+import static org.junit.Assert.assertEquals;
+
+import android.content.Intent;
+import android.graphics.Bitmap;
+import android.graphics.Color;
+import android.graphics.drawable.BitmapDrawable;
+import android.graphics.drawable.ColorDrawable;
+import android.os.LocaleList;
+import android.os.Parcel;
+import android.support.test.filters.SmallTest;
+import android.support.test.runner.AndroidJUnit4;
+import android.view.View;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.Locale;
+
+@SmallTest
+@RunWith(AndroidJUnit4.class)
+public class TextClassificationTest {
+
+ public BitmapDrawable generateTestDrawable(int width, int height, int colorValue) {
+ final int numPixels = width * height;
+ final int[] colors = new int[numPixels];
+ for (int i = 0; i < numPixels; ++i) {
+ colors[i] = colorValue;
+ }
+ final Bitmap bitmap = Bitmap.createBitmap(colors, width, height, Bitmap.Config.ARGB_8888);
+ final BitmapDrawable drawable = new BitmapDrawable(null, bitmap);
+ drawable.setTargetDensity(bitmap.getDensity());
+ return drawable;
+ }
+
+ @Test
+ public void testParcel() {
+ final String text = "text";
+ final BitmapDrawable primaryIcon = generateTestDrawable(16, 16, Color.RED);
+ final String primaryLabel = "primarylabel";
+ final Intent primaryIntent = new Intent("primaryintentaction");
+ final View.OnClickListener primaryOnClick = v -> { };
+ final BitmapDrawable secondaryIcon0 = generateTestDrawable(32, 288, Color.GREEN);
+ final String secondaryLabel0 = "secondarylabel0";
+ final Intent secondaryIntent0 = new Intent("secondaryintentaction0");
+ final BitmapDrawable secondaryIcon1 = generateTestDrawable(576, 288, Color.BLUE);
+ final String secondaryLabel1 = "secondaryLabel1";
+ final Intent secondaryIntent1 = null;
+ final BitmapDrawable secondaryIcon2 = null;
+ final String secondaryLabel2 = null;
+ final Intent secondaryIntent2 = new Intent("secondaryintentaction2");
+ final ColorDrawable secondaryIcon3 = new ColorDrawable(Color.CYAN);
+ final String secondaryLabel3 = null;
+ final Intent secondaryIntent3 = null;
+ final String signature = "signature";
+ final TextClassification reference = new TextClassification.Builder()
+ .setText(text)
+ .setPrimaryAction(primaryIntent, primaryLabel, primaryIcon)
+ .setOnClickListener(primaryOnClick)
+ .addSecondaryAction(null, null, null) // ignored
+ .addSecondaryAction(secondaryIntent0, secondaryLabel0, secondaryIcon0)
+ .addSecondaryAction(secondaryIntent1, secondaryLabel1, secondaryIcon1)
+ .addSecondaryAction(secondaryIntent2, secondaryLabel2, secondaryIcon2)
+ .addSecondaryAction(secondaryIntent3, secondaryLabel3, secondaryIcon3)
+ .setEntityType(TextClassifier.TYPE_ADDRESS, 0.3f)
+ .setEntityType(TextClassifier.TYPE_PHONE, 0.7f)
+ .setSignature(signature)
+ .build();
+
+ // Parcel and unparcel using ParcelableWrapper.
+ final TextClassification.ParcelableWrapper parcelableReference = new TextClassification
+ .ParcelableWrapper(reference);
+ final Parcel parcel = Parcel.obtain();
+ parcelableReference.writeToParcel(parcel, parcelableReference.describeContents());
+ parcel.setDataPosition(0);
+ final TextClassification result =
+ TextClassification.ParcelableWrapper.CREATOR.createFromParcel(
+ parcel).getTextClassification();
+
+ assertEquals(text, result.getText());
+ assertEquals(signature, result.getSignature());
+ assertEquals(4, result.getSecondaryActionsCount());
+
+ // Primary action (re-use existing icon).
+ final Bitmap resPrimaryIcon = ((BitmapDrawable) result.getIcon()).getBitmap();
+ assertEquals(primaryIcon.getBitmap().getPixel(0, 0), resPrimaryIcon.getPixel(0, 0));
+ assertEquals(16, resPrimaryIcon.getWidth());
+ assertEquals(16, resPrimaryIcon.getHeight());
+ assertEquals(primaryLabel, result.getLabel());
+ assertEquals(primaryIntent.getAction(), result.getIntent().getAction());
+ assertEquals(null, result.getOnClickListener()); // Non-parcelable.
+
+ // Secondary action 0 (scale with height limit).
+ final Bitmap resSecondaryIcon0 = ((BitmapDrawable) result.getSecondaryIcon(0)).getBitmap();
+ assertEquals(secondaryIcon0.getBitmap().getPixel(0, 0), resSecondaryIcon0.getPixel(0, 0));
+ assertEquals(16, resSecondaryIcon0.getWidth());
+ assertEquals(144, resSecondaryIcon0.getHeight());
+ assertEquals(secondaryLabel0, result.getSecondaryLabel(0));
+ assertEquals(secondaryIntent0.getAction(), result.getSecondaryIntent(0).getAction());
+
+ // Secondary action 1 (scale with width limit).
+ final Bitmap resSecondaryIcon1 = ((BitmapDrawable) result.getSecondaryIcon(1)).getBitmap();
+ assertEquals(secondaryIcon1.getBitmap().getPixel(0, 0), resSecondaryIcon1.getPixel(0, 0));
+ assertEquals(144, resSecondaryIcon1.getWidth());
+ assertEquals(72, resSecondaryIcon1.getHeight());
+ assertEquals(secondaryLabel1, result.getSecondaryLabel(1));
+ assertEquals(null, result.getSecondaryIntent(1));
+
+ // Secondary action 2 (no icon).
+ assertEquals(null, result.getSecondaryIcon(2));
+ assertEquals(null, result.getSecondaryLabel(2));
+ assertEquals(secondaryIntent2.getAction(), result.getSecondaryIntent(2).getAction());
+
+ // Secondary action 3 (convert non-bitmap drawable with negative size).
+ final Bitmap resSecondaryIcon3 = ((BitmapDrawable) result.getSecondaryIcon(3)).getBitmap();
+ assertEquals(secondaryIcon3.getColor(), resSecondaryIcon3.getPixel(0, 0));
+ assertEquals(1, resSecondaryIcon3.getWidth());
+ assertEquals(1, resSecondaryIcon3.getHeight());
+ assertEquals(null, result.getSecondaryLabel(3));
+ assertEquals(null, result.getSecondaryIntent(3));
+
+ // Entities.
+ assertEquals(2, result.getEntityCount());
+ assertEquals(TextClassifier.TYPE_PHONE, result.getEntity(0));
+ assertEquals(TextClassifier.TYPE_ADDRESS, result.getEntity(1));
+ assertEquals(0.7f, result.getConfidenceScore(TextClassifier.TYPE_PHONE), 1e-7f);
+ assertEquals(0.3f, result.getConfidenceScore(TextClassifier.TYPE_ADDRESS), 1e-7f);
+ }
+
+ @Test
+ public void testParcelOptions() {
+ TextClassification.Options reference = new TextClassification.Options();
+ reference.setDefaultLocales(new LocaleList(Locale.US, Locale.GERMANY));
+
+ // Parcel and unparcel.
+ final Parcel parcel = Parcel.obtain();
+ reference.writeToParcel(parcel, reference.describeContents());
+ parcel.setDataPosition(0);
+ TextClassification.Options result = TextClassification.Options.CREATOR.createFromParcel(
+ parcel);
+
+ assertEquals("en-US,de-DE", result.getDefaultLocales().toLanguageTags());
+ }
+}
diff --git a/core/tests/coretests/src/android/view/textclassifier/TextLinksTest.java b/core/tests/coretests/src/android/view/textclassifier/TextLinksTest.java
new file mode 100644
index 0000000..a82542c
--- /dev/null
+++ b/core/tests/coretests/src/android/view/textclassifier/TextLinksTest.java
@@ -0,0 +1,118 @@
+/*
+ * 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.view.textclassifier;
+
+import static org.junit.Assert.assertEquals;
+
+import android.os.LocaleList;
+import android.os.Parcel;
+import android.support.test.InstrumentationRegistry;
+import android.support.test.filters.SmallTest;
+import android.support.test.runner.AndroidJUnit4;
+import android.util.ArrayMap;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+@SmallTest
+@RunWith(AndroidJUnit4.class)
+public class TextLinksTest {
+
+ private TextClassificationManager mTcm;
+ private TextClassifier mClassifier;
+
+ @Before
+ public void setup() {
+ mTcm = InstrumentationRegistry.getTargetContext()
+ .getSystemService(TextClassificationManager.class);
+ mTcm.setTextClassifier(null);
+ mClassifier = mTcm.getTextClassifier();
+ }
+
+ private Map<String, Float> getEntityScores(float address, float phone, float other) {
+ final Map<String, Float> result = new ArrayMap<>();
+ if (address > 0.f) {
+ result.put(TextClassifier.TYPE_ADDRESS, address);
+ }
+ if (phone > 0.f) {
+ result.put(TextClassifier.TYPE_PHONE, phone);
+ }
+ if (other > 0.f) {
+ result.put(TextClassifier.TYPE_OTHER, other);
+ }
+ return result;
+ }
+
+ @Test
+ public void testParcel() {
+ final String fullText = "this is just a test";
+ final TextLinks reference = new TextLinks.Builder(fullText)
+ .addLink(new TextLinks.TextLink(fullText, 0, 4, getEntityScores(0.f, 0.f, 1.f)))
+ .addLink(new TextLinks.TextLink(fullText, 5, 12, getEntityScores(.8f, .1f, .5f)))
+ .build();
+
+ // Parcel and unparcel.
+ final Parcel parcel = Parcel.obtain();
+ reference.writeToParcel(parcel, reference.describeContents());
+ parcel.setDataPosition(0);
+ final TextLinks result = TextLinks.CREATOR.createFromParcel(parcel);
+ final List<TextLinks.TextLink> resultList = new ArrayList<>(result.getLinks());
+
+ assertEquals(2, resultList.size());
+ assertEquals(0, resultList.get(0).getStart());
+ assertEquals(4, resultList.get(0).getEnd());
+ assertEquals(1, resultList.get(0).getEntityCount());
+ assertEquals(TextClassifier.TYPE_OTHER, resultList.get(0).getEntity(0));
+ assertEquals(1.f, resultList.get(0).getConfidenceScore(TextClassifier.TYPE_OTHER), 1e-7f);
+ assertEquals(5, resultList.get(1).getStart());
+ assertEquals(12, resultList.get(1).getEnd());
+ assertEquals(3, resultList.get(1).getEntityCount());
+ assertEquals(TextClassifier.TYPE_ADDRESS, resultList.get(1).getEntity(0));
+ assertEquals(TextClassifier.TYPE_OTHER, resultList.get(1).getEntity(1));
+ assertEquals(TextClassifier.TYPE_PHONE, resultList.get(1).getEntity(2));
+ assertEquals(.8f, resultList.get(1).getConfidenceScore(TextClassifier.TYPE_ADDRESS), 1e-7f);
+ assertEquals(.5f, resultList.get(1).getConfidenceScore(TextClassifier.TYPE_OTHER), 1e-7f);
+ assertEquals(.1f, resultList.get(1).getConfidenceScore(TextClassifier.TYPE_PHONE), 1e-7f);
+ }
+
+ @Test
+ public void testParcelOptions() {
+ TextClassifier.EntityConfig entityConfig = new TextClassifier.EntityConfig(
+ TextClassifier.ENTITY_PRESET_NONE);
+ entityConfig.includeEntities("a", "b", "c");
+ entityConfig.excludeEntities("b");
+ TextLinks.Options reference = new TextLinks.Options();
+ reference.setDefaultLocales(new LocaleList(Locale.US, Locale.GERMANY));
+ reference.setEntityConfig(entityConfig);
+
+ // Parcel and unparcel.
+ final Parcel parcel = Parcel.obtain();
+ reference.writeToParcel(parcel, reference.describeContents());
+ parcel.setDataPosition(0);
+ TextLinks.Options result = TextLinks.Options.CREATOR.createFromParcel(parcel);
+
+ assertEquals("en-US,de-DE", result.getDefaultLocales().toLanguageTags());
+ assertEquals(Arrays.asList("a", "c"), result.getEntityConfig().getEntities(mClassifier));
+ }
+}
diff --git a/core/tests/coretests/src/android/view/textclassifier/TextSelectionTest.java b/core/tests/coretests/src/android/view/textclassifier/TextSelectionTest.java
new file mode 100644
index 0000000..e920236
--- /dev/null
+++ b/core/tests/coretests/src/android/view/textclassifier/TextSelectionTest.java
@@ -0,0 +1,86 @@
+/*
+ * 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.view.textclassifier;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import android.os.LocaleList;
+import android.os.Parcel;
+import android.support.test.filters.SmallTest;
+import android.support.test.runner.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.Locale;
+
+@SmallTest
+@RunWith(AndroidJUnit4.class)
+public class TextSelectionTest {
+
+ @Test
+ public void testParcel() {
+ final int startIndex = 13;
+ final int endIndex = 37;
+ final String signature = "signature";
+ final TextSelection reference = new TextSelection.Builder(startIndex, endIndex)
+ .setEntityType(TextClassifier.TYPE_ADDRESS, 0.3f)
+ .setEntityType(TextClassifier.TYPE_PHONE, 0.7f)
+ .setEntityType(TextClassifier.TYPE_URL, 0.1f)
+ .setSignature(signature)
+ .build();
+
+ // Parcel and unparcel using ParcelableWrapper.
+ final TextSelection.ParcelableWrapper parcelableReference = new TextSelection
+ .ParcelableWrapper(reference);
+ final Parcel parcel = Parcel.obtain();
+ parcelableReference.writeToParcel(parcel, parcelableReference.describeContents());
+ parcel.setDataPosition(0);
+ final TextSelection result =
+ TextSelection.ParcelableWrapper.CREATOR.createFromParcel(
+ parcel).getTextSelection();
+
+ assertEquals(startIndex, result.getSelectionStartIndex());
+ assertEquals(endIndex, result.getSelectionEndIndex());
+ assertEquals(signature, result.getSignature());
+
+ assertEquals(3, result.getEntityCount());
+ assertEquals(TextClassifier.TYPE_PHONE, result.getEntity(0));
+ assertEquals(TextClassifier.TYPE_ADDRESS, result.getEntity(1));
+ assertEquals(TextClassifier.TYPE_URL, result.getEntity(2));
+ assertEquals(0.7f, result.getConfidenceScore(TextClassifier.TYPE_PHONE), 1e-7f);
+ assertEquals(0.3f, result.getConfidenceScore(TextClassifier.TYPE_ADDRESS), 1e-7f);
+ assertEquals(0.1f, result.getConfidenceScore(TextClassifier.TYPE_URL), 1e-7f);
+ }
+
+ @Test
+ public void testParcelOptions() {
+ TextSelection.Options reference = new TextSelection.Options();
+ reference.setDefaultLocales(new LocaleList(Locale.US, Locale.GERMANY));
+ reference.setDarkLaunchAllowed(true);
+
+ // Parcel and unparcel.
+ final Parcel parcel = Parcel.obtain();
+ reference.writeToParcel(parcel, reference.describeContents());
+ parcel.setDataPosition(0);
+ TextSelection.Options result = TextSelection.Options.CREATOR.createFromParcel(parcel);
+
+ assertEquals("en-US,de-DE", result.getDefaultLocales().toLanguageTags());
+ assertTrue(result.isDarkLaunchAllowed());
+ }
+}