/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
1
1
/*
2
2
 * ContactsCache.java
3
3
 *
4
 
 * Copyright (C) 2011 Tim Marston <tim@ed.am>
 
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
 
 
29
 
import android.app.Activity;
30
 
 
 
28
import java.util.Locale;
31
29
 
32
30
public class ContactsCache
33
31
{
34
32
        /**
35
 
         * 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.
36
36
         */
37
 
        static public class CacheIdentifier
 
37
        public static class CacheIdentifier
38
38
        {
39
 
                public enum Type {
40
 
                        NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
 
39
                public enum Type { NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
41
40
 
42
41
                private Type _type;
43
42
                private String _detail;
44
43
 
45
 
                protected CacheIdentifier()
46
 
                {
47
 
                        _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;
48
100
                }
49
101
 
50
102
                protected CacheIdentifier( Type type, String detail )
83
135
                = new HashMap< Long, HashSet< String > >();
84
136
        private HashMap< Long, HashSet< String > > _contactOrganisations
85
137
                = new HashMap< Long, HashSet< 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
 
        }
 
138
        private HashMap< Long, HashSet< String > > _contactNotes
 
139
                = new HashMap< Long, HashSet< String > >();
136
140
 
137
141
        public boolean canLookup( CacheIdentifier identifier )
138
142
        {
139
143
                return lookup( identifier ) != null;
140
144
        }
141
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
         */
142
153
        public Long lookup( CacheIdentifier identifier )
143
154
        {
144
155
                switch( identifier.getType() )
155
166
                return null;
156
167
        }
157
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
         */
158
175
        public Long removeLookup( CacheIdentifier identifier )
159
176
        {
160
177
                switch( identifier.getType() )
171
188
                return null;
172
189
        }
173
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
         */
174
197
        public void addLookup( CacheIdentifier identifier, Long id )
175
198
        {
176
199
                switch( identifier.getType() )
190
213
                }
191
214
        }
192
215
 
 
216
        /**
 
217
         * Remove any data that is associated with an contact id.
 
218
         *
 
219
         * @param id
 
220
         */
193
221
        public void removeAssociatedData( Long id )
194
222
        {
195
223
                _contactNumbers.remove( id );
196
224
                _contactEmails.remove( id );
197
225
                _contactAddresses.remove( id );
198
226
                _contactOrganisations.remove( id );
 
227
                _contactNotes.remove( id );
199
228
        }
200
229
 
201
230
        public boolean hasAssociatedNumber( Long id, String number )
217
246
                        set = new HashSet< String >();
218
247
                        _contactNumbers.put( id, set );
219
248
                }
220
 
                set.add( normalisePhoneNumber( number ) );
 
249
                set.add( number );
221
250
        }
222
251
 
223
252
        public boolean hasAssociatedEmail( Long id, String email )
226
255
                if( email == null ) return false;
227
256
 
228
257
                HashSet< String > set = _contactEmails.get( id );
229
 
                return set != null && set.contains( normaliseEmailAddress( email ) );
 
258
                return set != null && set.contains( email );
230
259
        }
231
260
 
232
261
        public void addAssociatedEmail( Long id, String email )
239
268
                        set = new HashSet< String >();
240
269
                        _contactEmails.put( id, set );
241
270
                }
242
 
                set.add( normaliseEmailAddress( email ) );
 
271
                set.add( email );
243
272
        }
244
273
 
245
274
        public boolean hasAssociatedAddress( Long id, String address )
248
277
                if( address == null ) return false;
249
278
 
250
279
                HashSet< String > set = _contactAddresses.get( id );
251
 
                return set != null && set.contains( normaliseAddress( address ) );
 
280
                return set != null && set.contains( address );
252
281
        }
253
282
 
254
283
        public void addAssociatedAddress( Long id, String address )
261
290
                        set = new HashSet< String >();
262
291
                        _contactAddresses.put( id, set );
263
292
                }
264
 
                set.add( normaliseAddress( address ) );
 
293
                set.add( address );
265
294
        }
266
295
 
267
296
        public boolean hasAssociatedOrganisation( Long id, String organisation )
270
299
                if( organisation == null ) return false;
271
300
 
272
301
                HashSet< String > set = _contactOrganisations.get( id );
273
 
                return set != null && set.contains(
274
 
                        normaliseOrganisation( organisation ) );
 
302
                return set != null && set.contains( organisation );
275
303
        }
276
304
 
277
305
        public void addAssociatedOrganisation( Long id, String organisation )
284
312
                        set = new HashSet< String >();
285
313
                        _contactOrganisations.put( id, set );
286
314
                }
287
 
                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 );
288
338
        }
289
339
 
290
340
        static public String normaliseName( String name )
304
354
        static public String normaliseEmailAddress( String email )
305
355
        {
306
356
                if( email == null ) return null;
307
 
                email = email.trim().toLowerCase();
 
357
                email = email.trim().toLowerCase( Locale.US );
308
358
                return email.length() > 0? email : null;
309
359
        }
310
360
 
321
371
                address = address.trim();
322
372
                return address.length() > 0? address : null;
323
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
        }
324
381
}