/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: Tim Marston
  • Date: 2013-03-17 12:07:41 UTC
  • Revision ID: tim@ed.am-20130317120741-pq94jr0ajq1dsqw8
updated NEWS

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/ContactsCache.java
25
25
 
26
26
import java.util.HashMap;
27
27
import java.util.HashSet;
 
28
import java.util.Locale;
28
29
 
29
30
public class ContactsCache
30
31
{
31
32
        /**
32
 
         * Information that can be used to identify a contact within the cache
 
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.
33
36
         */
34
 
        static public class CacheIdentifier
 
37
        public static class CacheIdentifier
35
38
        {
36
 
                public enum Type {
37
 
                        NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
 
39
                public enum Type { NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
38
40
 
39
41
                private Type _type;
40
42
                private String _detail;
41
43
 
42
 
                protected CacheIdentifier()
43
 
                {
44
 
                        _type = Type.NONE;
 
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
                 * @param type the detail type
 
49
                 * @param detail the detail
 
50
                 * @return the cache identifier, or null
 
51
                 */
 
52
                public static CacheIdentifier factory( Type type, String detail )
 
53
                {
 
54
                        switch( type )
 
55
                        {
 
56
                        case NAME: detail = normaliseName( detail ); break;
 
57
                        case ORGANISATION: detail = normaliseOrganisation( detail ); break;
 
58
                        case PRIMARY_NUMBER: detail = normalisePhoneNumber( detail ); break;
 
59
                        case PRIMARY_EMAIL: detail = normaliseEmailAddress( detail ); break;
 
60
                        default: return null;
 
61
                        }
 
62
                        if( detail == null ) return null;
 
63
                        return new CacheIdentifier( type, detail );
 
64
                }
 
65
 
 
66
                /**
 
67
                 * Obtain a cache identifier from contact data.  This routine is
 
68
                 * designed to be as robust as possible and may return null when a cache
 
69
                 * identifier can not be created.
 
70
                 * @param contact the contact data
 
71
                 * @return the cache identifier, or null
 
72
                 */
 
73
                public static CacheIdentifier factory( Importer.ContactData contact )
 
74
                {
 
75
                        CacheIdentifier identifier = null;
 
76
 
 
77
                        if( contact.hasName() )
 
78
                                identifier = factory( CacheIdentifier.Type.NAME,
 
79
                                        contact.getName() );
 
80
                        if( identifier != null ) return identifier;
 
81
 
 
82
                        if( contact.hasPrimaryOrganisation() )
 
83
                                identifier = factory( CacheIdentifier.Type.ORGANISATION,
 
84
                                        contact.getPrimaryOrganisation() );
 
85
                        if( identifier != null ) return identifier;
 
86
 
 
87
                        if( contact.hasPrimaryNumber() )
 
88
                                identifier = factory( CacheIdentifier.Type.PRIMARY_NUMBER,
 
89
                                        contact.getPrimaryNumber() );
 
90
                        if( identifier != null ) return identifier;
 
91
 
 
92
                        if( contact.hasPrimaryEmail() )
 
93
                                identifier = factory( CacheIdentifier.Type.PRIMARY_EMAIL,
 
94
                                        contact.getPrimaryEmail() );
 
95
                        if( identifier != null ) return identifier;
 
96
 
 
97
                        return null;
45
98
                }
46
99
 
47
100
                protected CacheIdentifier( Type type, String detail )
80
133
                = new HashMap< Long, HashSet< String > >();
81
134
        private HashMap< Long, HashSet< String > > _contactOrganisations
82
135
                = new HashMap< Long, HashSet< String > >();
83
 
 
84
 
        public static CacheIdentifier createIdentifier(
85
 
                Importer.ContactData contact )
86
 
        {
87
 
                if( contact.hasName() ) {
88
 
                        String name = normaliseName( contact.getName() );
89
 
                        if( name != null )
90
 
                                return new CacheIdentifier(
91
 
                                        CacheIdentifier.Type.NAME, name );
92
 
                }
93
 
 
94
 
                if( contact.hasPrimaryOrganisation() ) {
95
 
                        String organisation = normaliseOrganisation(
96
 
                                contact.getPrimaryOrganisation() );
97
 
                        if( organisation != null )
98
 
                                return new CacheIdentifier(
99
 
                                        CacheIdentifier.Type.ORGANISATION, organisation );
100
 
                }
101
 
 
102
 
                if( contact.hasPrimaryNumber() ) {
103
 
                        String number = normalisePhoneNumber( contact.getPrimaryNumber() );
104
 
                        if( number != null )
105
 
                        return new CacheIdentifier(
106
 
                                CacheIdentifier.Type.PRIMARY_NUMBER, number );
107
 
                }
108
 
 
109
 
                if( contact.hasPrimaryEmail() ) {
110
 
                        String email = normaliseEmailAddress( contact.getPrimaryEmail() );
111
 
                        if( email != null )
112
 
                        return new CacheIdentifier(
113
 
                                CacheIdentifier.Type.PRIMARY_EMAIL, email );
114
 
                }
115
 
 
116
 
                return null;
117
 
        }
 
136
        private HashMap< Long, HashSet< String > > _contactNotes
 
137
                = new HashMap< Long, HashSet< String > >();
118
138
 
119
139
        public boolean canLookup( CacheIdentifier identifier )
120
140
        {
121
141
                return lookup( identifier ) != null;
122
142
        }
123
143
 
 
144
        /**
 
145
         * Retrieve the contact id of a contact identified by the specified cache
 
146
         * identifier, if it exists.
 
147
         * @param identifier the cache identifier
 
148
         * @return a contact id, or null
 
149
         */
124
150
        public Long lookup( CacheIdentifier identifier )
125
151
        {
126
152
                switch( identifier.getType() )
137
163
                return null;
138
164
        }
139
165
 
 
166
        /**
 
167
         * Remove any cache entry that is identified by the cache identifier.
 
168
         * @param identifier the cache identifier
 
169
         * @return the contact id of the contact that was removed, or null
 
170
         */
140
171
        public Long removeLookup( CacheIdentifier identifier )
141
172
        {
142
173
                switch( identifier.getType() )
153
184
                return null;
154
185
        }
155
186
 
 
187
        /**
 
188
         * Add a lookup from a contact identifier to a contact id to the cache.
 
189
         * @param identifier the cache identifier
 
190
         * @param id teh contact id
 
191
         */
156
192
        public void addLookup( CacheIdentifier identifier, Long id )
157
193
        {
158
194
                switch( identifier.getType() )
172
208
                }
173
209
        }
174
210
 
 
211
        /**
 
212
         * Remove any data that is associated with an contact id.
 
213
         * @param id
 
214
         */
175
215
        public void removeAssociatedData( Long id )
176
216
        {
177
217
                _contactNumbers.remove( id );
178
218
                _contactEmails.remove( id );
179
219
                _contactAddresses.remove( id );
180
220
                _contactOrganisations.remove( id );
 
221
                _contactNotes.remove( id );
181
222
        }
182
223
 
183
224
        public boolean hasAssociatedNumber( Long id, String number )
199
240
                        set = new HashSet< String >();
200
241
                        _contactNumbers.put( id, set );
201
242
                }
202
 
                set.add( normalisePhoneNumber( number ) );
 
243
                set.add( number );
203
244
        }
204
245
 
205
246
        public boolean hasAssociatedEmail( Long id, String email )
208
249
                if( email == null ) return false;
209
250
 
210
251
                HashSet< String > set = _contactEmails.get( id );
211
 
                return set != null && set.contains( normaliseEmailAddress( email ) );
 
252
                return set != null && set.contains( email );
212
253
        }
213
254
 
214
255
        public void addAssociatedEmail( Long id, String email )
221
262
                        set = new HashSet< String >();
222
263
                        _contactEmails.put( id, set );
223
264
                }
224
 
                set.add( normaliseEmailAddress( email ) );
 
265
                set.add( email );
225
266
        }
226
267
 
227
268
        public boolean hasAssociatedAddress( Long id, String address )
230
271
                if( address == null ) return false;
231
272
 
232
273
                HashSet< String > set = _contactAddresses.get( id );
233
 
                return set != null && set.contains( normaliseAddress( address ) );
 
274
                return set != null && set.contains( address );
234
275
        }
235
276
 
236
277
        public void addAssociatedAddress( Long id, String address )
243
284
                        set = new HashSet< String >();
244
285
                        _contactAddresses.put( id, set );
245
286
                }
246
 
                set.add( normaliseAddress( address ) );
 
287
                set.add( address );
247
288
        }
248
289
 
249
290
        public boolean hasAssociatedOrganisation( Long id, String organisation )
252
293
                if( organisation == null ) return false;
253
294
 
254
295
                HashSet< String > set = _contactOrganisations.get( id );
255
 
                return set != null && set.contains(
256
 
                        normaliseOrganisation( organisation ) );
 
296
                return set != null && set.contains( organisation );
257
297
        }
258
298
 
259
299
        public void addAssociatedOrganisation( Long id, String organisation )
266
306
                        set = new HashSet< String >();
267
307
                        _contactOrganisations.put( id, set );
268
308
                }
269
 
                set.add( normaliseOrganisation( organisation ) );
 
309
                set.add( organisation );
 
310
        }
 
311
 
 
312
        public boolean hasAssociatedNote( Long id, String note )
 
313
        {
 
314
                note = normaliseNote( note );
 
315
                if( note == null ) return false;
 
316
 
 
317
                HashSet< String > set = _contactNotes.get( id );
 
318
                return set != null && set.contains( note );
 
319
        }
 
320
 
 
321
        public void addAssociatedNote( Long id, String note )
 
322
        {
 
323
                note = normaliseNote( note );
 
324
                if( note == null ) return;
 
325
 
 
326
                HashSet< String > set = _contactNotes.get( id );
 
327
                if( set == null ) {
 
328
                        set = new HashSet< String >();
 
329
                        _contactNotes.put( id, set );
 
330
                }
 
331
                set.add( note );
270
332
        }
271
333
 
272
334
        static public String normaliseName( String name )
286
348
        static public String normaliseEmailAddress( String email )
287
349
        {
288
350
                if( email == null ) return null;
289
 
                email = email.trim().toLowerCase();
 
351
                email = email.trim().toLowerCase( Locale.US );
290
352
                return email.length() > 0? email : null;
291
353
        }
292
354
 
303
365
                address = address.trim();
304
366
                return address.length() > 0? address : null;
305
367
        }
 
368
 
 
369
        static public String normaliseNote( String note )
 
370
        {
 
371
                if( note == null ) return null;
 
372
                note = note.trim();
 
373
                return note.length() > 0? note : null;
 
374
        }
306
375
}