/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-06-22 17:29:31 UTC
  • Revision ID: tim@ed.am-20130622172931-ujydoni23t3a543b
minor style tweaks

Show diffs side-by-side

added added

removed removed

src/am/ed/importcontacts/ContactsCache.java
4
4
 * Copyright (C) 2011 to 2012 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
 
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
                 *
 
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
100
                }
46
101
 
47
102
                protected CacheIdentifier( Type type, String detail )
80
135
                = new HashMap< Long, HashSet< String > >();
81
136
        private HashMap< Long, HashSet< String > > _contactOrganisations
82
137
                = 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
 
        }
 
138
        private HashMap< Long, HashSet< String > > _contactNotes
 
139
                = new HashMap< Long, HashSet< String > >();
118
140
 
119
141
        public boolean canLookup( CacheIdentifier identifier )
120
142
        {
121
143
                return lookup( identifier ) != null;
122
144
        }
123
145
 
 
146
        /**
 
147
         * Retrieve the contact id of a contact identified by the specified cache
 
148
         * identifier, if it exists.
 
149
         *
 
150
         * @param identifier the cache identifier
 
151
         * @return a contact id, or null
 
152
         */
124
153
        public Long lookup( CacheIdentifier identifier )
125
154
        {
126
155
                switch( identifier.getType() )
137
166
                return null;
138
167
        }
139
168
 
 
169
        /**
 
170
         * Remove any cache entry that is identified by the cache identifier.
 
171
         *
 
172
         * @param identifier the cache identifier
 
173
         * @return the contact id of the contact that was removed, or null
 
174
         */
140
175
        public Long removeLookup( CacheIdentifier identifier )
141
176
        {
142
177
                switch( identifier.getType() )
153
188
                return null;
154
189
        }
155
190
 
 
191
        /**
 
192
         * Add a lookup from a contact identifier to a contact id to the cache.
 
193
         *
 
194
         * @param identifier the cache identifier
 
195
         * @param id teh contact id
 
196
         */
156
197
        public void addLookup( CacheIdentifier identifier, Long id )
157
198
        {
158
199
                switch( identifier.getType() )
172
213
                }
173
214
        }
174
215
 
 
216
        /**
 
217
         * Remove any data that is associated with an contact id.
 
218
         *
 
219
         * @param id
 
220
         */
175
221
        public void removeAssociatedData( Long id )
176
222
        {
177
223
                _contactNumbers.remove( id );
178
224
                _contactEmails.remove( id );
179
225
                _contactAddresses.remove( id );
180
226
                _contactOrganisations.remove( id );
 
227
                _contactNotes.remove( id );
181
228
        }
182
229
 
183
230
        public boolean hasAssociatedNumber( Long id, String number )
199
246
                        set = new HashSet< String >();
200
247
                        _contactNumbers.put( id, set );
201
248
                }
202
 
                set.add( normalisePhoneNumber( number ) );
 
249
                set.add( number );
203
250
        }
204
251
 
205
252
        public boolean hasAssociatedEmail( Long id, String email )
208
255
                if( email == null ) return false;
209
256
 
210
257
                HashSet< String > set = _contactEmails.get( id );
211
 
                return set != null && set.contains( normaliseEmailAddress( email ) );
 
258
                return set != null && set.contains( email );
212
259
        }
213
260
 
214
261
        public void addAssociatedEmail( Long id, String email )
221
268
                        set = new HashSet< String >();
222
269
                        _contactEmails.put( id, set );
223
270
                }
224
 
                set.add( normaliseEmailAddress( email ) );
 
271
                set.add( email );
225
272
        }
226
273
 
227
274
        public boolean hasAssociatedAddress( Long id, String address )
230
277
                if( address == null ) return false;
231
278
 
232
279
                HashSet< String > set = _contactAddresses.get( id );
233
 
                return set != null && set.contains( normaliseAddress( address ) );
 
280
                return set != null && set.contains( address );
234
281
        }
235
282
 
236
283
        public void addAssociatedAddress( Long id, String address )
243
290
                        set = new HashSet< String >();
244
291
                        _contactAddresses.put( id, set );
245
292
                }
246
 
                set.add( normaliseAddress( address ) );
 
293
                set.add( address );
247
294
        }
248
295
 
249
296
        public boolean hasAssociatedOrganisation( Long id, String organisation )
252
299
                if( organisation == null ) return false;
253
300
 
254
301
                HashSet< String > set = _contactOrganisations.get( id );
255
 
                return set != null && set.contains(
256
 
                        normaliseOrganisation( organisation ) );
 
302
                return set != null && set.contains( organisation );
257
303
        }
258
304
 
259
305
        public void addAssociatedOrganisation( Long id, String organisation )
266
312
                        set = new HashSet< String >();
267
313
                        _contactOrganisations.put( id, set );
268
314
                }
269
 
                set.add( normaliseOrganisation( organisation ) );
 
315
                set.add( organisation );
 
316
        }
 
317
 
 
318
        public boolean hasAssociatedNote( Long id, String note )
 
319
        {
 
320
                note = normaliseNote( note );
 
321
                if( note == null ) return false;
 
322
 
 
323
                HashSet< String > set = _contactNotes.get( id );
 
324
                return set != null && set.contains( note );
 
325
        }
 
326
 
 
327
        public void addAssociatedNote( Long id, String note )
 
328
        {
 
329
                note = normaliseNote( note );
 
330
                if( note == null ) return;
 
331
 
 
332
                HashSet< String > set = _contactNotes.get( id );
 
333
                if( set == null ) {
 
334
                        set = new HashSet< String >();
 
335
                        _contactNotes.put( id, set );
 
336
                }
 
337
                set.add( note );
270
338
        }
271
339
 
272
340
        static public String normaliseName( String name )
286
354
        static public String normaliseEmailAddress( String email )
287
355
        {
288
356
                if( email == null ) return null;
289
 
                email = email.trim().toLowerCase();
 
357
                email = email.trim().toLowerCase( Locale.US );
290
358
                return email.length() > 0? email : null;
291
359
        }
292
360
 
303
371
                address = address.trim();
304
372
                return address.length() > 0? address : null;
305
373
        }
 
374
 
 
375
        static public String normaliseNote( String note )
 
376
        {
 
377
                if( note == null ) return null;
 
378
                note = note.trim();
 
379
                return note.length() > 0? note : null;
 
380
        }
306
381
}