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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
/*
* 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 com.android.dialer.searchfragment.cp2;
import android.content.ContentResolver;
import android.database.CharArrayBuffer;
import android.database.ContentObserver;
import android.database.Cursor;
import android.database.DataSetObserver;
import android.net.Uri;
import android.os.Bundle;
import android.support.annotation.IntDef;
import android.support.annotation.Nullable;
import android.text.TextUtils;
import com.android.dialer.searchfragment.common.Projections;
import com.android.dialer.searchfragment.common.QueryFilteringUtil;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.List;
/**
* Wrapper for a cursor containing all on device contacts.
*
* <p>This cursor removes duplicate phone numbers associated with the same contact and can filter
* contacts based on a query by calling {@link #filter(String)}.
*/
final class ContactFilterCursor implements Cursor {
private final Cursor cursor;
// List of cursor ids that are valid for displaying after filtering.
private final List<Integer> queryFilteredPositions = new ArrayList<>();
private int currentPosition = 0;
@Retention(RetentionPolicy.SOURCE)
@IntDef({
Qualification.NUMBERS_ARE_NOT_DUPLICATES,
Qualification.NEW_NUMBER_IS_MORE_QUALIFIED,
Qualification.CURRENT_MORE_QUALIFIED
})
private @interface Qualification {
/** Numbers are not duplicates (i.e. neither is more qualified than the other). */
int NUMBERS_ARE_NOT_DUPLICATES = 0;
/** Number are duplicates and new number is more qualified than the existing number. */
int NEW_NUMBER_IS_MORE_QUALIFIED = 1;
/** Numbers are duplicates but current/existing number is more qualified than new number. */
int CURRENT_MORE_QUALIFIED = 2;
}
/**
* @param cursor with projection {@link Projections#PHONE_PROJECTION}.
* @param query to filter cursor results.
*/
ContactFilterCursor(Cursor cursor, @Nullable String query) {
// TODO(calderwoodra) investigate copying this into a MatrixCursor and holding in memory
this.cursor = cursor;
filter(query);
}
/**
* Filters out contacts that do not match the query.
*
* <p>The query can have at least 1 of 3 forms:
*
* <ul>
* <li>A phone number
* <li>A T9 representation of a name (matches {@link QueryFilteringUtil#T9_PATTERN}).
* <li>A name
* </ul>
*
* <p>A contact is considered a match if:
*
* <ul>
* <li>Its phone number contains the phone number query
* <li>Its name represented in T9 contains the T9 query
* <li>Its name contains the query
* </ul>
*/
public void filter(@Nullable String query) {
if (query == null) {
query = "";
}
queryFilteredPositions.clear();
// On some devices, contacts have multiple rows with identical phone numbers. These numbers are
// considered duplicates. Since the order might not be guaranteed, we compare all of the numbers
// and hold onto the most qualified one as the one we want to display to the user.
// See #getQualification for details on how qualification is determined.
int previousMostQualifiedPosition = 0;
String previousName = "";
String previousMostQualifiedNumber = "";
query = query.toLowerCase();
cursor.moveToPosition(-1);
while (cursor.moveToNext()) {
int position = cursor.getPosition();
String currentNumber = cursor.getString(Projections.PHONE_NUMBER);
String currentName = cursor.getString(Projections.PHONE_DISPLAY_NAME);
if (!previousName.equals(currentName)) {
previousName = currentName;
previousMostQualifiedNumber = currentNumber;
previousMostQualifiedPosition = position;
} else {
// Since the contact name is the same, check if this number is a duplicate
switch (getQualification(currentNumber, previousMostQualifiedNumber)) {
case Qualification.CURRENT_MORE_QUALIFIED:
// Number is a less qualified duplicate, ignore it.
continue;
case Qualification.NEW_NUMBER_IS_MORE_QUALIFIED:
// If number wasn't filtered out before, remove it and add it's more qualified version.
if (queryFilteredPositions.contains(previousMostQualifiedPosition)) {
queryFilteredPositions.remove(previousMostQualifiedPosition);
queryFilteredPositions.add(position);
}
previousMostQualifiedNumber = currentNumber;
previousMostQualifiedPosition = position;
continue;
case Qualification.NUMBERS_ARE_NOT_DUPLICATES:
default:
previousMostQualifiedNumber = currentNumber;
previousMostQualifiedPosition = position;
}
}
if (TextUtils.isEmpty(query)
|| QueryFilteringUtil.nameMatchesT9Query(query, previousName)
|| QueryFilteringUtil.numberMatchesNumberQuery(query, previousMostQualifiedNumber)
|| QueryFilteringUtil.nameContainsQuery(query, previousName)) {
queryFilteredPositions.add(previousMostQualifiedPosition);
}
}
currentPosition = 0;
cursor.moveToFirst();
}
/**
* @param number that may or may not be more qualified than the existing most qualified number
* @param mostQualifiedNumber currently most qualified number associated with same contact
* @return {@link Qualification} where the more qualified number is the number with the most
* digits. If the digits are the same, the number with the most formatting is more qualified.
*/
private @Qualification int getQualification(String number, String mostQualifiedNumber) {
// Ignore formatting
String numberDigits = QueryFilteringUtil.digitsOnly(number);
String qualifiedNumberDigits = QueryFilteringUtil.digitsOnly(mostQualifiedNumber);
// If the numbers are identical, return version with more formatting
if (qualifiedNumberDigits.equals(numberDigits)) {
if (mostQualifiedNumber.length() >= number.length()) {
return Qualification.CURRENT_MORE_QUALIFIED;
} else {
return Qualification.NEW_NUMBER_IS_MORE_QUALIFIED;
}
}
// If one number is a suffix of another, then return the longer one.
// If they are equal, then return the current most qualified number.
if (qualifiedNumberDigits.endsWith(numberDigits)) {
return Qualification.CURRENT_MORE_QUALIFIED;
}
if (numberDigits.endsWith(qualifiedNumberDigits)) {
return Qualification.NEW_NUMBER_IS_MORE_QUALIFIED;
}
return Qualification.NUMBERS_ARE_NOT_DUPLICATES;
}
@Override
public boolean moveToPosition(int position) {
currentPosition = position;
return currentPosition < getCount()
&& cursor.moveToPosition(queryFilteredPositions.get(currentPosition));
}
@Override
public boolean move(int offset) {
currentPosition += offset;
return moveToPosition(currentPosition);
}
@Override
public int getCount() {
return queryFilteredPositions.size();
}
@Override
public boolean isFirst() {
return currentPosition == 0;
}
@Override
public boolean isLast() {
return currentPosition == getCount() - 1;
}
@Override
public int getPosition() {
return currentPosition;
}
@Override
public boolean moveToFirst() {
return moveToPosition(0);
}
@Override
public boolean moveToLast() {
return moveToPosition(getCount() - 1);
}
@Override
public boolean moveToNext() {
return moveToPosition(++currentPosition);
}
@Override
public boolean moveToPrevious() {
return moveToPosition(--currentPosition);
}
// Methods below simply call the corresponding method in cursor.
@Override
public boolean isBeforeFirst() {
return cursor.isBeforeFirst();
}
@Override
public boolean isAfterLast() {
return cursor.isAfterLast();
}
@Override
public int getColumnIndex(String columnName) {
return cursor.getColumnIndex(columnName);
}
@Override
public int getColumnIndexOrThrow(String columnName) {
return cursor.getColumnIndexOrThrow(columnName);
}
@Override
public String getColumnName(int columnIndex) {
return cursor.getColumnName(columnIndex);
}
@Override
public String[] getColumnNames() {
return cursor.getColumnNames();
}
@Override
public int getColumnCount() {
return cursor.getColumnCount();
}
@Override
public byte[] getBlob(int columnIndex) {
return cursor.getBlob(columnIndex);
}
@Override
public String getString(int columnIndex) {
return cursor.getString(columnIndex);
}
@Override
public void copyStringToBuffer(int columnIndex, CharArrayBuffer buffer) {
cursor.copyStringToBuffer(columnIndex, buffer);
}
@Override
public short getShort(int columnIndex) {
return cursor.getShort(columnIndex);
}
@Override
public int getInt(int columnIndex) {
return cursor.getInt(columnIndex);
}
@Override
public long getLong(int columnIndex) {
return cursor.getLong(columnIndex);
}
@Override
public float getFloat(int columnIndex) {
return cursor.getFloat(columnIndex);
}
@Override
public double getDouble(int columnIndex) {
return cursor.getDouble(columnIndex);
}
@Override
public int getType(int columnIndex) {
return cursor.getType(columnIndex);
}
@Override
public boolean isNull(int columnIndex) {
return cursor.isNull(columnIndex);
}
@Override
public void deactivate() {
cursor.deactivate();
}
@Override
public boolean requery() {
return cursor.requery();
}
@Override
public void close() {
cursor.close();
}
@Override
public boolean isClosed() {
return cursor.isClosed();
}
@Override
public void registerContentObserver(ContentObserver observer) {
cursor.registerContentObserver(observer);
}
@Override
public void unregisterContentObserver(ContentObserver observer) {
cursor.unregisterContentObserver(observer);
}
@Override
public void registerDataSetObserver(DataSetObserver observer) {
cursor.registerDataSetObserver(observer);
}
@Override
public void unregisterDataSetObserver(DataSetObserver observer) {
cursor.unregisterDataSetObserver(observer);
}
@Override
public void setNotificationUri(ContentResolver cr, Uri uri) {
cursor.setNotificationUri(cr, uri);
}
@Override
public Uri getNotificationUri() {
return cursor.getNotificationUri();
}
@Override
public boolean getWantsAllOnMoveCalls() {
return cursor.getWantsAllOnMoveCalls();
}
@Override
public void setExtras(Bundle extras) {
cursor.setExtras(extras);
}
@Override
public Bundle getExtras() {
return cursor.getExtras();
}
@Override
public Bundle respond(Bundle extras) {
return cursor.respond(extras);
}
}
|