/android/import-contacts

To get this branch, use:
bzr branch http://bzr.ed.am/android/import-contacts

« back to all changes in this revision

Viewing changes to src/am/ed/importcontacts/ContactsCache.java

  • Committer: edam
  • Date: 2012-10-23 16:00:27 UTC
  • Revision ID: tim@ed.am-20121023160027-2jb0r4b4v78rewh1
updated TODO

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/ContactsCache.java
1
1
/*
2
2
 * ContactsCache.java
3
3
 *
4
 
 * Copyright (C) 2011 to 2013 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2011 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of the Import Contacts program (hereafter referred
7
 
 * to as "this program").  For more information, see
 
7
 * to as "this program"). For more information, see
8
8
 * http://ed.am/dev/android/import-contacts
9
9
 *
10
10
 * This program is free software: you can redistribute it and/or modify
25
25
 
26
26
import java.util.HashMap;
27
27
import java.util.HashSet;
28
 
import java.util.Locale;
 
28
 
 
29
import android.app.Activity;
 
30
 
29
31
 
30
32
public class ContactsCache
31
33
{
32
34
        /**
33
 
         * A thing that can be used to identify (or lookup) a contact within the
34
 
         * contacts cache.  It is not a reference to a cache entry and may not
35
 
         * identify an existing contact in the cache.
 
35
         * Information that can be used to identify a contact within the cache
36
36
         */
37
 
        public static class CacheIdentifier
 
37
        static public class CacheIdentifier
38
38
        {
39
 
                public enum Type { NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
 
39
                public enum Type {
 
40
                        NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
40
41
 
41
42
                private Type _type;
42
43
                private String _detail;
43
44
 
44
 
                /**
45
 
                 * Obtain a cache identifier.  This routine is designed to be as robust
46
 
                 * as possible (in terms of bad or null detail values), and to return
47
 
                 * null when a cache identifier can not be created.
48
 
                 *
49
 
                 * @param type the detail type
50
 
                 * @param detail the detail
51
 
                 * @return the cache identifier, or null
52
 
                 */
53
 
                public static CacheIdentifier factory( Type type, String detail )
54
 
                {
55
 
                        switch( type )
56
 
                        {
57
 
                        case NAME: detail = normaliseName( detail ); break;
58
 
                        case ORGANISATION: detail = normaliseOrganisation( detail ); break;
59
 
                        case PRIMARY_NUMBER: detail = normalisePhoneNumber( detail ); break;
60
 
                        case PRIMARY_EMAIL: detail = normaliseEmailAddress( detail ); break;
61
 
                        default: return null;
62
 
                        }
63
 
                        if( detail == null ) return null;
64
 
                        return new CacheIdentifier( type, detail );
65
 
                }
66
 
 
67
 
                /**
68
 
                 * Obtain a cache identifier from contact data.  This routine is
69
 
                 * designed to be as robust as possible and may return null when a cache
70
 
                 * identifier can not be created.
71
 
                 *
72
 
                 * @param contact the contact data
73
 
                 * @return the cache identifier, or null
74
 
                 */
75
 
                public static CacheIdentifier factory( Importer.ContactData contact )
76
 
                {
77
 
                        CacheIdentifier identifier = null;
78
 
 
79
 
                        if( contact.hasName() )
80
 
                                identifier = factory( CacheIdentifier.Type.NAME,
81
 
                                        contact.getName() );
82
 
                        if( identifier != null ) return identifier;
83
 
 
84
 
                        if( contact.hasPrimaryOrganisation() )
85
 
                                identifier = factory( CacheIdentifier.Type.ORGANISATION,
86
 
                                        contact.getPrimaryOrganisation() );
87
 
                        if( identifier != null ) return identifier;
88
 
 
89
 
                        if( contact.hasPrimaryNumber() )
90
 
                                identifier = factory( CacheIdentifier.Type.PRIMARY_NUMBER,
91
 
                                        contact.getPrimaryNumber() );
92
 
                        if( identifier != null ) return identifier;
93
 
 
94
 
                        if( contact.hasPrimaryEmail() )
95
 
                                identifier = factory( CacheIdentifier.Type.PRIMARY_EMAIL,
96
 
                                        contact.getPrimaryEmail() );
97
 
                        if( identifier != null ) return identifier;
98
 
 
99
 
                        return null;
 
45
                protected CacheIdentifier()
 
46
                {
 
47
                        _type = Type.NONE;
100
48
                }
101
49
 
102
50
                protected CacheIdentifier( Type type, String detail )
135
83
                = new HashMap< Long, HashSet< String > >();
136
84
        private HashMap< Long, HashSet< String > > _contactOrganisations
137
85
                = new HashMap< Long, HashSet< String > >();
138
 
        private HashMap< Long, HashSet< String > > _contactNotes
139
 
                = new HashMap< Long, HashSet< String > >();
140
 
        private HashMap< Long, String > _contactBirthdays
141
 
                = new HashMap< Long, String >();
 
86
 
 
87
        ContactsCache()
 
88
        {
 
89
                // init id lookups
 
90
//              _contactsByName = new HashMap< String, Long >();
 
91
//              _contactsByOrg = new HashMap< String, Long >();
 
92
//              _contactsByNumber = new HashMap< String, Long >();
 
93
//              _contactsByEmail = new HashMap< String, Long >();
 
94
 
 
95
                // init associated data cache
 
96
//              _contactNumbers = new HashMap< Long, HashSet< String > >();
 
97
//              _contactEmails = new HashMap< Long, HashSet< String > >();
 
98
//              _contactAddresses = new HashMap< Long, HashSet< String > >();
 
99
//              _contactOrganisations = new HashMap< Long, HashSet< String > >();
 
100
        }
 
101
 
 
102
        public static CacheIdentifier createIdentifier(
 
103
                Importer.ContactData contact )
 
104
        {
 
105
                if( contact.hasName() ) {
 
106
                        String name = normaliseName( contact.getName() );
 
107
                        if( name != null )
 
108
                                return new CacheIdentifier(
 
109
                                        CacheIdentifier.Type.NAME, name );
 
110
                }
 
111
 
 
112
                if( contact.hasPrimaryOrganisation() ) {
 
113
                        String organisation = normaliseOrganisation(
 
114
                                contact.getPrimaryOrganisation() );
 
115
                        if( organisation != null )
 
116
                                return new CacheIdentifier(
 
117
                                        CacheIdentifier.Type.ORGANISATION, organisation );
 
118
                }
 
119
 
 
120
                if( contact.hasPrimaryNumber() ) {
 
121
                        String number = normalisePhoneNumber( contact.getPrimaryNumber() );
 
122
                        if( number != null )
 
123
                        return new CacheIdentifier(
 
124
                                CacheIdentifier.Type.PRIMARY_NUMBER, number );
 
125
                }
 
126
 
 
127
                if( contact.hasPrimaryEmail() ) {
 
128
                        String email = normaliseEmailAddress( contact.getPrimaryEmail() );
 
129
                        if( email != null )
 
130
                        return new CacheIdentifier(
 
131
                                CacheIdentifier.Type.PRIMARY_EMAIL, email );
 
132
                }
 
133
 
 
134
                return null;
 
135
        }
142
136
 
143
137
        public boolean canLookup( CacheIdentifier identifier )
144
138
        {
145
139
                return lookup( identifier ) != null;
146
140
        }
147
141
 
148
 
        /**
149
 
         * Retrieve the contact id of a contact identified by the specified cache
150
 
         * identifier, if it exists.
151
 
         *
152
 
         * @param identifier the cache identifier
153
 
         * @return a contact id, or null
154
 
         */
155
142
        public Long lookup( CacheIdentifier identifier )
156
143
        {
157
144
                switch( identifier.getType() )
168
155
                return null;
169
156
        }
170
157
 
171
 
        /**
172
 
         * Remove any cache entry that is identified by the cache identifier.
173
 
         *
174
 
         * @param identifier the cache identifier
175
 
         * @return the contact id of the contact that was removed, or null
176
 
         */
177
158
        public Long removeLookup( CacheIdentifier identifier )
178
159
        {
179
160
                switch( identifier.getType() )
190
171
                return null;
191
172
        }
192
173
 
193
 
        /**
194
 
         * Add a lookup from a contact identifier to a contact id to the cache.
195
 
         *
196
 
         * @param identifier the cache identifier
197
 
         * @param id teh contact id
198
 
         */
199
174
        public void addLookup( CacheIdentifier identifier, Long id )
200
175
        {
201
176
                switch( identifier.getType() )
215
190
                }
216
191
        }
217
192
 
218
 
        /**
219
 
         * Remove any data that is associated with an contact id.
220
 
         *
221
 
         * @param id
222
 
         */
223
193
        public void removeAssociatedData( Long id )
224
194
        {
225
195
                _contactNumbers.remove( id );
226
196
                _contactEmails.remove( id );
227
197
                _contactAddresses.remove( id );
228
198
                _contactOrganisations.remove( id );
229
 
                _contactNotes.remove( id );
230
199
        }
231
200
 
232
201
        public boolean hasAssociatedNumber( Long id, String number )
248
217
                        set = new HashSet< String >();
249
218
                        _contactNumbers.put( id, set );
250
219
                }
251
 
                set.add( number );
 
220
                set.add( normalisePhoneNumber( number ) );
252
221
        }
253
222
 
254
223
        public boolean hasAssociatedEmail( Long id, String email )
257
226
                if( email == null ) return false;
258
227
 
259
228
                HashSet< String > set = _contactEmails.get( id );
260
 
                return set != null && set.contains( email );
 
229
                return set != null && set.contains( normaliseEmailAddress( email ) );
261
230
        }
262
231
 
263
232
        public void addAssociatedEmail( Long id, String email )
270
239
                        set = new HashSet< String >();
271
240
                        _contactEmails.put( id, set );
272
241
                }
273
 
                set.add( email );
 
242
                set.add( normaliseEmailAddress( email ) );
274
243
        }
275
244
 
276
245
        public boolean hasAssociatedAddress( Long id, String address )
279
248
                if( address == null ) return false;
280
249
 
281
250
                HashSet< String > set = _contactAddresses.get( id );
282
 
                return set != null && set.contains( address );
 
251
                return set != null && set.contains( normaliseAddress( address ) );
283
252
        }
284
253
 
285
254
        public void addAssociatedAddress( Long id, String address )
292
261
                        set = new HashSet< String >();
293
262
                        _contactAddresses.put( id, set );
294
263
                }
295
 
                set.add( address );
 
264
                set.add( normaliseAddress( address ) );
296
265
        }
297
266
 
298
267
        public boolean hasAssociatedOrganisation( Long id, String organisation )
301
270
                if( organisation == null ) return false;
302
271
 
303
272
                HashSet< String > set = _contactOrganisations.get( id );
304
 
                return set != null && set.contains( organisation );
 
273
                return set != null && set.contains(
 
274
                        normaliseOrganisation( organisation ) );
305
275
        }
306
276
 
307
277
        public void addAssociatedOrganisation( Long id, String organisation )
314
284
                        set = new HashSet< String >();
315
285
                        _contactOrganisations.put( id, set );
316
286
                }
317
 
                set.add( organisation );
318
 
        }
319
 
 
320
 
        public boolean hasAssociatedNote( Long id, String note )
321
 
        {
322
 
                note = normaliseNote( note );
323
 
                if( note == null ) return false;
324
 
 
325
 
                HashSet< String > set = _contactNotes.get( id );
326
 
                return set != null && set.contains( note );
327
 
        }
328
 
 
329
 
        public void addAssociatedNote( Long id, String note )
330
 
        {
331
 
                note = normaliseNote( note );
332
 
                if( note == null ) return;
333
 
 
334
 
                HashSet< String > set = _contactNotes.get( id );
335
 
                if( set == null ) {
336
 
                        set = new HashSet< String >();
337
 
                        _contactNotes.put( id, set );
338
 
                }
339
 
                set.add( note );
340
 
        }
341
 
 
342
 
        public boolean hasAssociatedBirthday( Long id, String birthday )
343
 
        {
344
 
                birthday = normaliseBirthday( birthday );
345
 
                if( birthday == null ) return false;
346
 
 
347
 
                String found = _contactBirthdays.get( id );
348
 
                return found != null && found.equalsIgnoreCase( birthday );
349
 
        }
350
 
 
351
 
        public void addAssociatedBirthday( Long id, String birthday )
352
 
        {
353
 
                birthday = normaliseBirthday( birthday );
354
 
                if( birthday == null ) return;
355
 
 
356
 
                _contactBirthdays.put( id, birthday );
 
287
                set.add( normaliseOrganisation( organisation ) );
357
288
        }
358
289
 
359
290
        static public String normaliseName( String name )
373
304
        static public String normaliseEmailAddress( String email )
374
305
        {
375
306
                if( email == null ) return null;
376
 
                email = email.trim().toLowerCase( Locale.US );
 
307
                email = email.trim().toLowerCase();
377
308
                return email.length() > 0? email : null;
378
309
        }
379
310
 
390
321
                address = address.trim();
391
322
                return address.length() > 0? address : null;
392
323
        }
393
 
 
394
 
        static public String normaliseNote( String note )
395
 
        {
396
 
                if( note == null ) return null;
397
 
                note = note.trim();
398
 
                return note.length() > 0? note : null;
399
 
        }
400
 
 
401
 
        static public String normaliseBirthday( String birthday )
402
 
        {
403
 
                if( birthday == null ) return null;
404
 
                birthday = birthday.trim();
405
 
                return birthday.length() > 0? birthday : null;
406
 
        }
407
324
}