1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* 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 android.annotation.IntRange;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.StringDef;
import android.annotation.WorkerThread;
import android.os.LocaleList;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Interface for providing text classification related features.
*
* <p>Unless otherwise stated, methods of this interface are blocking operations and you should
* avoid calling them on the UI thread.
*/
public interface TextClassifier {
/** @hide */
String DEFAULT_LOG_TAG = "TextClassifierImpl";
/** @hide */
String TYPE_UNKNOWN = ""; // TODO: Make this public API.
String TYPE_OTHER = "other";
String TYPE_EMAIL = "email";
String TYPE_PHONE = "phone";
String TYPE_ADDRESS = "address";
String TYPE_URL = "url";
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@StringDef({
TYPE_UNKNOWN, TYPE_OTHER, TYPE_EMAIL, TYPE_PHONE, TYPE_ADDRESS, TYPE_URL
})
@interface EntityType {}
/**
* No-op TextClassifier.
* This may be used to turn off TextClassifier features.
*/
TextClassifier NO_OP = new TextClassifier() {
@Override
public TextSelection suggestSelection(
CharSequence text,
int selectionStartIndex,
int selectionEndIndex,
LocaleList defaultLocales) {
return new TextSelection.Builder(selectionStartIndex, selectionEndIndex).build();
}
@Override
public TextClassification classifyText(
CharSequence text, int startIndex, int endIndex, LocaleList defaultLocales) {
return TextClassification.EMPTY;
}
};
/**
* Returns suggested text selection indices, recognized types and their associated confidence
* scores. The selections are ordered from highest to lowest scoring.
*
* @param text text providing context for the selected text (which is specified
* by the sub sequence starting at selectionStartIndex and ending at selectionEndIndex)
* @param selectionStartIndex start index of the selected part of text
* @param selectionEndIndex end index of the selected part of text
* @param defaultLocales ordered list of locale preferences that can be used to disambiguate
* the provided text. If no locale preferences exist, set this to null or an empty locale
* list in which case the classifier will decide whether to use no locale information, use
* a default locale, or use the system default.
*
* @throws IllegalArgumentException if text is null; selectionStartIndex is negative;
* selectionEndIndex is greater than text.length() or not greater than selectionStartIndex
*/
@WorkerThread
@NonNull
TextSelection suggestSelection(
@NonNull CharSequence text,
@IntRange(from = 0) int selectionStartIndex,
@IntRange(from = 0) int selectionEndIndex,
@Nullable LocaleList defaultLocales);
/**
* Classifies the specified text and returns a {@link TextClassification} object that can be
* used to generate a widget for handling the classified text.
*
* @param text text providing context for the text to classify (which is specified
* by the sub sequence starting at startIndex and ending at endIndex)
* @param startIndex start index of the text to classify
* @param endIndex end index of the text to classify
* @param defaultLocales ordered list of locale preferences that can be used to disambiguate
* the provided text. If no locale preferences exist, set this to null or an empty locale
* list in which case the classifier will decide whether to use no locale information, use
* a default locale, or use the system default.
*
* @throws IllegalArgumentException if text is null; startIndex is negative;
* endIndex is greater than text.length() or not greater than startIndex
*/
@WorkerThread
@NonNull
TextClassification classifyText(
@NonNull CharSequence text,
@IntRange(from = 0) int startIndex,
@IntRange(from = 0) int endIndex,
@Nullable LocaleList defaultLocales);
/**
* Returns a {@link LinksInfo} that may be applied to the text to annotate it with links
* information.
*
* @param text the text to generate annotations for
* @param linkMask See {@link android.text.util.Linkify} for a list of linkMasks that may be
* specified. Subclasses of this interface may specify additional linkMasks
* @param defaultLocales ordered list of locale preferences that can be used to disambiguate
* the provided text. If no locale preferences exist, set this to null or an empty locale
* list in which case the classifier will decide whether to use no locale information, use
* a default locale, or use the system default.
*
* @throws IllegalArgumentException if text is null
* @hide
*/
@WorkerThread
default LinksInfo getLinks(
@NonNull CharSequence text, int linkMask, @Nullable LocaleList defaultLocales) {
return LinksInfo.NO_OP;
}
/**
* Logs a TextClassifier event.
*
* @param source the text classifier used to generate this event
* @param event the text classifier related event
* @hide
*/
@WorkerThread
default void logEvent(String source, String event) {}
/**
* Returns this TextClassifier's settings.
* @hide
*/
default TextClassifierConstants getSettings() {
return TextClassifierConstants.DEFAULT;
}
}
|
