4
* Copyright (C) 2011 to 2012 Tim Marston <tim@ed.am>
6
* This file is part of the Import Contacts program (hereafter referred
7
* to as "this program"). For more information, see
8
* http://ed.am/dev/android/import-contacts
10
* This program is free software: you can redistribute it and/or modify
11
* it under the terms of the GNU General Public License as published by
12
* the Free Software Foundation, either version 3 of the License, or
13
* (at your option) any later version.
15
* This program is distributed in the hope that it will be useful,
16
* but WITHOUT ANY WARRANTY; without even the implied warranty of
17
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
* GNU General Public License for more details.
20
* You should have received a copy of the GNU General Public License
21
* along with this program. If not, see <http://www.gnu.org/licenses/>.
24
package am.ed.importcontacts;
26
import java.util.HashMap;
27
import java.util.HashSet;
28
import java.util.Locale;
30
public class ContactsCache
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.
37
public static class CacheIdentifier
39
public enum Type { NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
42
private String _detail;
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
52
public static CacheIdentifier factory( Type type, String detail )
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;
62
if( detail == null ) return null;
63
return new CacheIdentifier( type, detail );
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
73
public static CacheIdentifier factory( Importer.ContactData contact )
75
CacheIdentifier identifier = null;
77
if( contact.hasName() )
78
identifier = factory( CacheIdentifier.Type.NAME,
80
if( identifier != null ) return identifier;
82
if( contact.hasPrimaryOrganisation() )
83
identifier = factory( CacheIdentifier.Type.ORGANISATION,
84
contact.getPrimaryOrganisation() );
85
if( identifier != null ) return identifier;
87
if( contact.hasPrimaryNumber() )
88
identifier = factory( CacheIdentifier.Type.PRIMARY_NUMBER,
89
contact.getPrimaryNumber() );
90
if( identifier != null ) return identifier;
92
if( contact.hasPrimaryEmail() )
93
identifier = factory( CacheIdentifier.Type.PRIMARY_EMAIL,
94
contact.getPrimaryEmail() );
95
if( identifier != null ) return identifier;
100
protected CacheIdentifier( Type type, String detail )
106
public Type getType()
111
public String getDetail()
117
// mappings of contact names, organisations and primary numbers to ids
118
private HashMap< String, Long > _contactsByName
119
= new HashMap< String, Long >();
120
private HashMap< String, Long > _contactsByOrg
121
= new HashMap< String, Long >();
122
private HashMap< String, Long > _contactsByNumber
123
= new HashMap< String, Long >();
124
private HashMap< String, Long > _contactsByEmail
125
= new HashMap< String, Long >();
127
// mapping of contact ids to sets of associated data
128
private HashMap< Long, HashSet< String > > _contactNumbers
129
= new HashMap< Long, HashSet< String > >();
130
private HashMap< Long, HashSet< String > > _contactEmails
131
= new HashMap< Long, HashSet< String > >();
132
private HashMap< Long, HashSet< String > > _contactAddresses
133
= new HashMap< Long, HashSet< String > >();
134
private HashMap< Long, HashSet< String > > _contactOrganisations
135
= new HashMap< Long, HashSet< String > >();
136
private HashMap< Long, HashSet< String > > _contactNotes
137
= new HashMap< Long, HashSet< String > >();
139
public boolean canLookup( CacheIdentifier identifier )
141
return lookup( identifier ) != null;
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
150
public Long lookup( CacheIdentifier identifier )
152
switch( identifier.getType() )
155
return _contactsByName.get( identifier.getDetail() );
157
return _contactsByOrg.get( identifier.getDetail() );
159
return _contactsByNumber.get( identifier.getDetail() );
161
return _contactsByEmail.get( identifier.getDetail() );
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
171
public Long removeLookup( CacheIdentifier identifier )
173
switch( identifier.getType() )
176
return _contactsByName.remove( identifier.getDetail() );
178
return _contactsByOrg.remove( identifier.getDetail() );
180
return _contactsByNumber.remove( identifier.getDetail() );
182
return _contactsByEmail.remove( identifier.getDetail() );
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
192
public void addLookup( CacheIdentifier identifier, Long id )
194
switch( identifier.getType() )
197
_contactsByName.put( identifier.getDetail(), id );
200
_contactsByOrg.put( identifier.getDetail(), id );
203
_contactsByNumber.put( identifier.getDetail(), id );
206
_contactsByEmail.put( identifier.getDetail(), id );
212
* Remove any data that is associated with an contact id.
215
public void removeAssociatedData( Long id )
217
_contactNumbers.remove( id );
218
_contactEmails.remove( id );
219
_contactAddresses.remove( id );
220
_contactOrganisations.remove( id );
221
_contactNotes.remove( id );
224
public boolean hasAssociatedNumber( Long id, String number )
226
number = normalisePhoneNumber( number );
227
if( number == null ) return false;
229
HashSet< String > set = _contactNumbers.get( id );
230
return set != null && set.contains( number );
233
public void addAssociatedNumber( Long id, String number )
235
number = normalisePhoneNumber( number );
236
if( number == null ) return;
238
HashSet< String > set = _contactNumbers.get( id );
240
set = new HashSet< String >();
241
_contactNumbers.put( id, set );
246
public boolean hasAssociatedEmail( Long id, String email )
248
email = normaliseEmailAddress( email );
249
if( email == null ) return false;
251
HashSet< String > set = _contactEmails.get( id );
252
return set != null && set.contains( email );
255
public void addAssociatedEmail( Long id, String email )
257
email = normaliseEmailAddress( email );
258
if( email == null ) return;
260
HashSet< String > set = _contactEmails.get( id );
262
set = new HashSet< String >();
263
_contactEmails.put( id, set );
268
public boolean hasAssociatedAddress( Long id, String address )
270
address = normaliseAddress( address );
271
if( address == null ) return false;
273
HashSet< String > set = _contactAddresses.get( id );
274
return set != null && set.contains( address );
277
public void addAssociatedAddress( Long id, String address )
279
address = normaliseAddress( address );
280
if( address == null ) return;
282
HashSet< String > set = _contactAddresses.get( id );
284
set = new HashSet< String >();
285
_contactAddresses.put( id, set );
290
public boolean hasAssociatedOrganisation( Long id, String organisation )
292
organisation = normaliseOrganisation( organisation );
293
if( organisation == null ) return false;
295
HashSet< String > set = _contactOrganisations.get( id );
296
return set != null && set.contains( organisation );
299
public void addAssociatedOrganisation( Long id, String organisation )
301
organisation = normaliseOrganisation( organisation );
302
if( organisation == null ) return;
304
HashSet< String > set = _contactOrganisations.get( id );
306
set = new HashSet< String >();
307
_contactOrganisations.put( id, set );
309
set.add( organisation );
312
public boolean hasAssociatedNote( Long id, String note )
314
note = normaliseNote( note );
315
if( note == null ) return false;
317
HashSet< String > set = _contactNotes.get( id );
318
return set != null && set.contains( note );
321
public void addAssociatedNote( Long id, String note )
323
note = normaliseNote( note );
324
if( note == null ) return;
326
HashSet< String > set = _contactNotes.get( id );
328
set = new HashSet< String >();
329
_contactNotes.put( id, set );
334
static public String normaliseName( String name )
336
if( name == null ) return null;
338
return name.length() > 0? name : null;
341
static public String normalisePhoneNumber( String number )
343
if( number == null ) return null;
344
number = number.trim().replaceAll( "[-\\(\\) ]", "" );
345
return number.length() > 0? number : null;
348
static public String normaliseEmailAddress( String email )
350
if( email == null ) return null;
351
email = email.trim().toLowerCase( Locale.US );
352
return email.length() > 0? email : null;
355
static public String normaliseOrganisation( String organisation )
357
if( organisation == null ) return null;
358
organisation = organisation.trim();
359
return organisation.length() > 0? organisation : null;
362
static public String normaliseAddress( String address )
364
if( address == null ) return null;
365
address = address.trim();
366
return address.length() > 0? address : null;
369
static public String normaliseNote( String note )
371
if( note == null ) return null;
373
return note.length() > 0? note : null;