/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-12-20 16:49:39 UTC
  • Revision ID: tim@ed.am-20121220164939-j9mg98v0uofws7kw
added support for notes; rewrote backends so that all normalising of data is now done within the contacts cache; made the vCard unescape routine slightly more acceptant of non-standard escaped characters

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
7
 * to as "this program"). For more information, see
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
39
                public enum Type {
40
40
                        NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
47
47
                        _type = Type.NONE;
48
48
                }
49
49
 
 
50
                /**
 
51
                 * Obtain a cache identifier.  This routine is designed to be as robust
 
52
                 * as possible (in terms of bad or null detail values), and to return
 
53
                 * null when a cache identifier can not be created.
 
54
                 * @param type the detail type
 
55
                 * @param detail the detail
 
56
                 * @return the cache identifier, or null
 
57
                 */
 
58
                public static CacheIdentifier factory( Type type, String detail )
 
59
                {
 
60
                        switch( type )
 
61
                        {
 
62
                        case NAME: detail = normaliseName( detail ); break;
 
63
                        case ORGANISATION: detail = normaliseOrganisation( detail ); break;
 
64
                        case PRIMARY_NUMBER: detail = normalisePhoneNumber( detail ); break;
 
65
                        case PRIMARY_EMAIL: detail = normaliseEmailAddress( detail ); break;
 
66
                        default: return null;
 
67
                        }
 
68
                        if( detail == null ) return null;
 
69
                        return new CacheIdentifier( type, detail );
 
70
                }
 
71
 
 
72
                /**
 
73
                 * Obtain a cache identifier from contact data.  This routine is
 
74
                 * designed to be as robust as possible and may return null when a cache
 
75
                 * identifier can not be created.
 
76
                 * @param contact the contact data
 
77
                 * @return the cache identifier, or null
 
78
                 */
 
79
                public static CacheIdentifier factory( Importer.ContactData contact )
 
80
                {
 
81
                        CacheIdentifier ret = null;
 
82
 
 
83
                        if( contact.hasName() )
 
84
                                ret = factory( CacheIdentifier.Type.NAME,
 
85
                                        contact.getName() );
 
86
                        if( ret == null && contact.hasPrimaryOrganisation() )
 
87
                                ret = factory( CacheIdentifier.Type.ORGANISATION,
 
88
                                        contact.getPrimaryOrganisation() );
 
89
                        if( ret == null && contact.hasPrimaryNumber() )
 
90
                                ret = factory( CacheIdentifier.Type.PRIMARY_NUMBER,
 
91
                                        contact.getPrimaryNumber() );
 
92
                        if( ret == null && contact.hasPrimaryEmail() )
 
93
                                ret = factory( CacheIdentifier.Type.PRIMARY_EMAIL,
 
94
                                        contact.getPrimaryEmail() );
 
95
 
 
96
                        return ret;
 
97
                }
 
98
 
50
99
                protected CacheIdentifier( Type type, String detail )
51
100
                {
52
101
                        _type = type;
83
132
                = new HashMap< Long, HashSet< String > >();
84
133
        private HashMap< Long, HashSet< String > > _contactOrganisations
85
134
                = 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
 
        }
 
135
        private HashMap< Long, HashSet< String > > _contactNotes
 
136
                = new HashMap< Long, HashSet< String > >();
136
137
 
137
138
        public boolean canLookup( CacheIdentifier identifier )
138
139
        {
139
140
                return lookup( identifier ) != null;
140
141
        }
141
142
 
 
143
        /**
 
144
         * Retrieve the contact id of a contact identified by the specified cache
 
145
         * identifier, if it exists.
 
146
         * @param identifier the cache identifier
 
147
         * @return a contact id, or null
 
148
         */
142
149
        public Long lookup( CacheIdentifier identifier )
143
150
        {
144
151
                switch( identifier.getType() )
155
162
                return null;
156
163
        }
157
164
 
 
165
        /**
 
166
         * Remove any cache entry that is identified by the cache identifier.
 
167
         * @param identifier the cache identifier
 
168
         * @return the contact id of the contact that was removed, or null
 
169
         */
158
170
        public Long removeLookup( CacheIdentifier identifier )
159
171
        {
160
172
                switch( identifier.getType() )
171
183
                return null;
172
184
        }
173
185
 
 
186
        /**
 
187
         * Add a lookup from a contact identifier to a contact id to the cache.
 
188
         * @param identifier the cache identifier
 
189
         * @param id teh contact id
 
190
         */
174
191
        public void addLookup( CacheIdentifier identifier, Long id )
175
192
        {
176
193
                switch( identifier.getType() )
190
207
                }
191
208
        }
192
209
 
 
210
        /**
 
211
         * Remove any data that is associated with an contact id.
 
212
         * @param id
 
213
         */
193
214
        public void removeAssociatedData( Long id )
194
215
        {
195
216
                _contactNumbers.remove( id );
196
217
                _contactEmails.remove( id );
197
218
                _contactAddresses.remove( id );
198
219
                _contactOrganisations.remove( id );
 
220
                _contactNotes.remove( id );
199
221
        }
200
222
 
201
223
        public boolean hasAssociatedNumber( Long id, String number )
217
239
                        set = new HashSet< String >();
218
240
                        _contactNumbers.put( id, set );
219
241
                }
220
 
                set.add( normalisePhoneNumber( number ) );
 
242
                set.add( number );
221
243
        }
222
244
 
223
245
        public boolean hasAssociatedEmail( Long id, String email )
226
248
                if( email == null ) return false;
227
249
 
228
250
                HashSet< String > set = _contactEmails.get( id );
229
 
                return set != null && set.contains( normaliseEmailAddress( email ) );
 
251
                return set != null && set.contains( email );
230
252
        }
231
253
 
232
254
        public void addAssociatedEmail( Long id, String email )
239
261
                        set = new HashSet< String >();
240
262
                        _contactEmails.put( id, set );
241
263
                }
242
 
                set.add( normaliseEmailAddress( email ) );
 
264
                set.add( email );
243
265
        }
244
266
 
245
267
        public boolean hasAssociatedAddress( Long id, String address )
248
270
                if( address == null ) return false;
249
271
 
250
272
                HashSet< String > set = _contactAddresses.get( id );
251
 
                return set != null && set.contains( normaliseAddress( address ) );
 
273
                return set != null && set.contains( address );
252
274
        }
253
275
 
254
276
        public void addAssociatedAddress( Long id, String address )
261
283
                        set = new HashSet< String >();
262
284
                        _contactAddresses.put( id, set );
263
285
                }
264
 
                set.add( normaliseAddress( address ) );
 
286
                set.add( address );
265
287
        }
266
288
 
267
289
        public boolean hasAssociatedOrganisation( Long id, String organisation )
270
292
                if( organisation == null ) return false;
271
293
 
272
294
                HashSet< String > set = _contactOrganisations.get( id );
273
 
                return set != null && set.contains(
274
 
                        normaliseOrganisation( organisation ) );
 
295
                return set != null && set.contains( organisation );
275
296
        }
276
297
 
277
298
        public void addAssociatedOrganisation( Long id, String organisation )
284
305
                        set = new HashSet< String >();
285
306
                        _contactOrganisations.put( id, set );
286
307
                }
287
 
                set.add( normaliseOrganisation( organisation ) );
 
308
                set.add( organisation );
 
309
        }
 
310
 
 
311
        public boolean hasAssociatedNote( Long id, String note )
 
312
        {
 
313
                note = normaliseNote( note );
 
314
                if( note == null ) return false;
 
315
 
 
316
                HashSet< String > set = _contactNotes.get( id );
 
317
                return set != null && set.contains( note );
 
318
        }
 
319
 
 
320
        public void addAssociatedNote( Long id, String note )
 
321
        {
 
322
                note = normaliseNote( note );
 
323
                if( note == null ) return;
 
324
 
 
325
                HashSet< String > set = _contactNotes.get( id );
 
326
                if( set == null ) {
 
327
                        set = new HashSet< String >();
 
328
                        _contactNotes.put( id, set );
 
329
                }
 
330
                set.add( note );
288
331
        }
289
332
 
290
333
        static public String normaliseName( String name )
304
347
        static public String normaliseEmailAddress( String email )
305
348
        {
306
349
                if( email == null ) return null;
307
 
                email = email.trim().toLowerCase();
 
350
                email = email.trim().toLowerCase( Locale.US );
308
351
                return email.length() > 0? email : null;
309
352
        }
310
353
 
321
364
                address = address.trim();
322
365
                return address.length() > 0? address : null;
323
366
        }
 
367
 
 
368
        static public String normaliseNote( String note )
 
369
        {
 
370
                if( note == null ) return null;
 
371
                note = note.trim();
 
372
                return note.length() > 0? note : null;
 
373
        }
324
374
}