/android/import-contacts : contents of src/am/ed/importcontacts/ContactsCache.java at revision 57

: (revision 57)

To get this branch, use:

bzr branch
http://bzr.ed.am/android/import-contacts

/*
 * ContactsCache.java
 *
 * Copyright (C) 2011 to 2012 Tim Marston <tim@ed.am>
 *
 * This file is part of the Import Contacts program (hereafter referred
 * to as "this program"). For more information, see
 * http://ed.am/dev/android/import-contacts
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package am.ed.importcontacts;

import java.util.HashMap;
import java.util.HashSet;

public class ContactsCache
{
	/**
	 * Information that can be used to identify a contact within the cache
	 */
	static public class CacheIdentifier
	{
		public enum Type {
			NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }

		private Type _type;
		private String _detail;

		protected CacheIdentifier()
		{
			_type = Type.NONE;
		}

		protected CacheIdentifier( Type type, String detail )
		{
			_type = type;
			_detail = detail;
		}

		public Type getType()
		{
			return _type;
		}

		public String getDetail()
		{
			return _detail;
		}
	}

	// mappings of contact names, organisations and primary numbers to ids
	private HashMap< String, Long > _contactsByName
		= new HashMap< String, Long >();
	private HashMap< String, Long > _contactsByOrg
		= new HashMap< String, Long >();
	private HashMap< String, Long > _contactsByNumber
		= new HashMap< String, Long >();
	private HashMap< String, Long > _contactsByEmail
		= new HashMap< String, Long >();

	// mapping of contact ids to sets of associated data
	private HashMap< Long, HashSet< String > > _contactNumbers
		= new HashMap< Long, HashSet< String > >();
	private HashMap< Long, HashSet< String > > _contactEmails
		= new HashMap< Long, HashSet< String > >();
	private HashMap< Long, HashSet< String > > _contactAddresses
		= new HashMap< Long, HashSet< String > >();
	private HashMap< Long, HashSet< String > > _contactOrganisations
		= new HashMap< Long, HashSet< String > >();

	public static CacheIdentifier createIdentifier(
		Importer.ContactData contact )
	{
		if( contact.hasName() ) {
			String name = normaliseName( contact.getName() );
			if( name != null )
				return new CacheIdentifier(
					CacheIdentifier.Type.NAME, name );
		}

		if( contact.hasPrimaryOrganisation() ) {
			String organisation = normaliseOrganisation(
				contact.getPrimaryOrganisation() );
			if( organisation != null )
				return new CacheIdentifier(
					CacheIdentifier.Type.ORGANISATION, organisation );
		}

		if( contact.hasPrimaryNumber() ) {
			String number = normalisePhoneNumber( contact.getPrimaryNumber() );
			if( number != null )
			return new CacheIdentifier(
				CacheIdentifier.Type.PRIMARY_NUMBER, number );
		}

		if( contact.hasPrimaryEmail() ) {
			String email = normaliseEmailAddress( contact.getPrimaryEmail() );
			if( email != null )
			return new CacheIdentifier(
				CacheIdentifier.Type.PRIMARY_EMAIL, email );
		}

		return null;
	}

	public boolean canLookup( CacheIdentifier identifier )
	{
		return lookup( identifier ) != null;
	}

	public Long lookup( CacheIdentifier identifier )
	{
		switch( identifier.getType() )
		{
		case NAME:
			return _contactsByName.get( identifier.getDetail() );
		case ORGANISATION:
			return _contactsByOrg.get( identifier.getDetail() );
		case PRIMARY_NUMBER:
			return _contactsByNumber.get( identifier.getDetail() );
		case PRIMARY_EMAIL:
			return _contactsByEmail.get( identifier.getDetail() );
		}
		return null;
	}

	public Long removeLookup( CacheIdentifier identifier )
	{
		switch( identifier.getType() )
		{
		case NAME:
			return _contactsByName.remove( identifier.getDetail() );
		case ORGANISATION:
			return _contactsByOrg.remove( identifier.getDetail() );
		case PRIMARY_NUMBER:
			return _contactsByNumber.remove( identifier.getDetail() );
		case PRIMARY_EMAIL:
			return _contactsByEmail.remove( identifier.getDetail() );
		}
		return null;
	}

	public void addLookup( CacheIdentifier identifier, Long id )
	{
		switch( identifier.getType() )
		{
		case NAME:
			_contactsByName.put( identifier.getDetail(), id );
			break;
		case ORGANISATION:
			_contactsByOrg.put( identifier.getDetail(), id );
			break;
		case PRIMARY_NUMBER:
			_contactsByNumber.put( identifier.getDetail(), id );
			break;
		case PRIMARY_EMAIL:
			_contactsByEmail.put( identifier.getDetail(), id );
			break;
		}
	}

	public void removeAssociatedData( Long id )
	{
		_contactNumbers.remove( id );
		_contactEmails.remove( id );
		_contactAddresses.remove( id );
		_contactOrganisations.remove( id );
	}

	public boolean hasAssociatedNumber( Long id, String number )
	{
		number = normalisePhoneNumber( number );
		if( number == null ) return false;

		HashSet< String > set = _contactNumbers.get( id );
		return set != null && set.contains( number );
	}

	public void addAssociatedNumber( Long id, String number )
	{
		number = normalisePhoneNumber( number );
		if( number == null ) return;

		HashSet< String > set = _contactNumbers.get( id );
		if( set == null ) {
			set = new HashSet< String >();
			_contactNumbers.put( id, set );
		}
		set.add( normalisePhoneNumber( number ) );
	}

	public boolean hasAssociatedEmail( Long id, String email )
	{
		email = normaliseEmailAddress( email );
		if( email == null ) return false;

		HashSet< String > set = _contactEmails.get( id );
		return set != null && set.contains( normaliseEmailAddress( email ) );
	}

	public void addAssociatedEmail( Long id, String email )
	{
		email = normaliseEmailAddress( email );
		if( email == null ) return;

		HashSet< String > set = _contactEmails.get( id );
		if( set == null ) {
			set = new HashSet< String >();
			_contactEmails.put( id, set );
		}
		set.add( normaliseEmailAddress( email ) );
	}

	public boolean hasAssociatedAddress( Long id, String address )
	{
		address = normaliseAddress( address );
		if( address == null ) return false;

		HashSet< String > set = _contactAddresses.get( id );
		return set != null && set.contains( normaliseAddress( address ) );
	}

	public void addAssociatedAddress( Long id, String address )
	{
		address = normaliseAddress( address );
		if( address == null ) return;

		HashSet< String > set = _contactAddresses.get( id );
		if( set == null ) {
			set = new HashSet< String >();
			_contactAddresses.put( id, set );
		}
		set.add( normaliseAddress( address ) );
	}

	public boolean hasAssociatedOrganisation( Long id, String organisation )
	{
		organisation = normaliseOrganisation( organisation );
		if( organisation == null ) return false;

		HashSet< String > set = _contactOrganisations.get( id );
		return set != null && set.contains(
			normaliseOrganisation( organisation ) );
	}

	public void addAssociatedOrganisation( Long id, String organisation )
	{
		organisation = normaliseOrganisation( organisation );
		if( organisation == null ) return;

		HashSet< String > set = _contactOrganisations.get( id );
		if( set == null ) {
			set = new HashSet< String >();
			_contactOrganisations.put( id, set );
		}
		set.add( normaliseOrganisation( organisation ) );
	}

	static public String normaliseName( String name )
	{
		if( name == null ) return null;
		name = name.trim();
		return name.length() > 0? name : null;
	}

	static public String normalisePhoneNumber( String number )
	{
		if( number == null ) return null;
		number = number.trim().replaceAll( "[-\\(\\) ]", "" );
		return number.length() > 0? number : null;
	}

	static public String normaliseEmailAddress( String email )
	{
		if( email == null ) return null;
		email = email.trim().toLowerCase();
		return email.length() > 0? email : null;
	}

	static public String normaliseOrganisation( String organisation )
	{
		if( organisation == null ) return null;
		organisation = organisation.trim();
		return organisation.length() > 0? organisation : null;
	}

	static public String normaliseAddress( String address )
	{
		if( address == null ) return null;
		address = address.trim();
		return address.length() > 0? address : null;
	}
}

39 by edam - pulled contacts cache out in to seperate class	1	/*
	2	* ContactsCache.java
	3	*
57 by edam cleanup; fixed some typos; updated TODO	4	* Copyright (C) 2011 to 2012 Tim Marston <tim@ed.am>
39 by edam - pulled contacts cache out in to seperate class	5	*
	6	* This file is part of the Import Contacts program (hereafter referred
	7	* to as "this program"). For more information, see
50 by edam updated all URLs, email addresses and package names to ed.am	8	* http://ed.am/dev/android/import-contacts
39 by edam - pulled contacts cache out in to seperate class	9	*
	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.
	14	*
	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.
	19	*
	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/>.
	22	*/
	23
50 by edam updated all URLs, email addresses and package names to ed.am	24	package am.ed.importcontacts;
39 by edam - pulled contacts cache out in to seperate class	25
	26	import java.util.HashMap;
	27	import java.util.HashSet;
	28
	29	public class ContactsCache
	30	{
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	31	/**
	32	* Information that can be used to identify a contact within the cache
	33	*/
	34	static public class CacheIdentifier
	35	{
	36	public enum Type {
	37	NONE, NAME, ORGANISATION, PRIMARY_NUMBER, PRIMARY_EMAIL }
	38
	39	private Type _type;
	40	private String _detail;
	41
	42	protected CacheIdentifier()
	43	{
	44	_type = Type.NONE;
	45	}
	46
	47	protected CacheIdentifier( Type type, String detail )
	48	{
	49	_type = type;
	50	_detail = detail;
	51	}
	52
	53	public Type getType()
	54	{
	55	return _type;
	56	}
	57
	58	public String getDetail()
	59	{
	60	return _detail;
	61	}
	62	}
	63
	64	// mappings of contact names, organisations and primary numbers to ids
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	65	private HashMap< String, Long > _contactsByName
	66	= new HashMap< String, Long >();
	67	private HashMap< String, Long > _contactsByOrg
	68	= new HashMap< String, Long >();
	69	private HashMap< String, Long > _contactsByNumber
	70	= new HashMap< String, Long >();
	71	private HashMap< String, Long > _contactsByEmail
	72	= new HashMap< String, Long >();
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	73
	74	// mapping of contact ids to sets of associated data
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	75	private HashMap< Long, HashSet< String > > _contactNumbers
	76	= new HashMap< Long, HashSet< String > >();
	77	private HashMap< Long, HashSet< String > > _contactEmails
	78	= new HashMap< Long, HashSet< String > >();
	79	private HashMap< Long, HashSet< String > > _contactAddresses
	80	= new HashMap< Long, HashSet< String > >();
	81	private HashMap< Long, HashSet< String > > _contactOrganisations
	82	= new HashMap< Long, HashSet< String > >();
	83
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	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	}
	118
	119	public boolean canLookup( CacheIdentifier identifier )
	120	{
	121	return lookup( identifier ) != null;
	122	}
	123
	124	public Long lookup( CacheIdentifier identifier )
	125	{
	126	switch( identifier.getType() )
	127	{
	128	case NAME:
	129	return _contactsByName.get( identifier.getDetail() );
	130	case ORGANISATION:
	131	return _contactsByOrg.get( identifier.getDetail() );
	132	case PRIMARY_NUMBER:
	133	return _contactsByNumber.get( identifier.getDetail() );
	134	case PRIMARY_EMAIL:
	135	return _contactsByEmail.get( identifier.getDetail() );
	136	}
	137	return null;
	138	}
	139
	140	public Long removeLookup( CacheIdentifier identifier )
	141	{
	142	switch( identifier.getType() )
	143	{
	144	case NAME:
	145	return _contactsByName.remove( identifier.getDetail() );
	146	case ORGANISATION:
	147	return _contactsByOrg.remove( identifier.getDetail() );
148	case PRIMARY_NUMBER:
149	return _contactsByNumber.remove( identifier.getDetail() );
150	case PRIMARY_EMAIL:
151	return _contactsByEmail.remove( identifier.getDetail() );
152	}
153	return null;
154	}
155
156	public void addLookup( CacheIdentifier identifier, Long id )
157	{
158	switch( identifier.getType() )
159	{
160	case NAME:
161	_contactsByName.put( identifier.getDetail(), id );
162	break;
163	case ORGANISATION:
164	_contactsByOrg.put( identifier.getDetail(), id );
165	break;
166	case PRIMARY_NUMBER:
167	_contactsByNumber.put( identifier.getDetail(), id );
168	break;
169	case PRIMARY_EMAIL:
170	_contactsByEmail.put( identifier.getDetail(), id );
171	break;
172	}
173	}
174
175	public void removeAssociatedData( Long id )
176	{
177	_contactNumbers.remove( id );
178	_contactEmails.remove( id );
179	_contactAddresses.remove( id );
180	_contactOrganisations.remove( id );
181	}
182
183	public boolean hasAssociatedNumber( Long id, String number )
184	{
185	number = normalisePhoneNumber( number );
186	if( number == null ) return false;
187
188	HashSet< String > set = _contactNumbers.get( id );
189	return set != null && set.contains( number );
190	}
191
192	public void addAssociatedNumber( Long id, String number )
193	{
194	number = normalisePhoneNumber( number );
195	if( number == null ) return;
196
197	HashSet< String > set = _contactNumbers.get( id );
198	if( set == null ) {
199	set = new HashSet< String >();
200	_contactNumbers.put( id, set );
201	}
202	set.add( normalisePhoneNumber( number ) );
203	}
204
205	public boolean hasAssociatedEmail( Long id, String email )
206	{
207	email = normaliseEmailAddress( email );
208	if( email == null ) return false;
209
210	HashSet< String > set = _contactEmails.get( id );
211	return set != null && set.contains( normaliseEmailAddress( email ) );
212	}
213
214	public void addAssociatedEmail( Long id, String email )
215	{
216	email = normaliseEmailAddress( email );
217	if( email == null ) return;
218
219	HashSet< String > set = _contactEmails.get( id );
220	if( set == null ) {
221	set = new HashSet< String >();
222	_contactEmails.put( id, set );
223	}
224	set.add( normaliseEmailAddress( email ) );
225	}
226
227	public boolean hasAssociatedAddress( Long id, String address )
228	{
229	address = normaliseAddress( address );
230	if( address == null ) return false;
231
232	HashSet< String > set = _contactAddresses.get( id );
233	return set != null && set.contains( normaliseAddress( address ) );
234	}
235
236	public void addAssociatedAddress( Long id, String address )
237	{
238	address = normaliseAddress( address );
239	if( address == null ) return;
240
241	HashSet< String > set = _contactAddresses.get( id );
242	if( set == null ) {
243	set = new HashSet< String >();
244	_contactAddresses.put( id, set );
245	}
246	set.add( normaliseAddress( address ) );
247	}
248
249	public boolean hasAssociatedOrganisation( Long id, String organisation )
250	{
251	organisation = normaliseOrganisation( organisation );
252	if( organisation == null ) return false;
253
254	HashSet< String > set = _contactOrganisations.get( id );
255	return set != null && set.contains(
256	normaliseOrganisation( organisation ) );
257	}
258
259	public void addAssociatedOrganisation( Long id, String organisation )
260	{
261	organisation = normaliseOrganisation( organisation );
262	if( organisation == null ) return;
263
264	HashSet< String > set = _contactOrganisations.get( id );
265	if( set == null ) {
266	set = new HashSet< String >();
267	_contactOrganisations.put( id, set );
268	}
269	set.add( normaliseOrganisation( organisation ) );
39 by edam - pulled contacts cache out in to seperate class	270	}
39 by edam - pulled contacts cache out in to seperate class	271
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	272	static public String normaliseName( String name )
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	273	{
	274	if( name == null ) return null;
	275	name = name.trim();
	276	return name.length() > 0? name : null;
	277	}
	278
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	279	static public String normalisePhoneNumber( String number )
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	280	{
	281	if( number == null ) return null;
	282	number = number.trim().replaceAll( "[-\\(\\) ]", "" );
	283	return number.length() > 0? number : null;
	284	}
	285
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	286	static public String normaliseEmailAddress( String email )
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	287	{
	288	if( email == null ) return null;
	289	email = email.trim().toLowerCase();
	290	return email.length() > 0? email : null;
	291	}
	292
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	293	static public String normaliseOrganisation( String organisation )
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	294	{
	295	if( organisation == null ) return null;
	296	organisation = organisation.trim();
	297	return organisation.length() > 0? organisation : null;
	298	}
	299
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	300	static public String normaliseAddress( String address )
40 by edam - fixed logic for vcard field types (home, work, cell, etc) so it works	301	{
	302	if( address == null ) return null;
	303	address = address.trim();
	304	return address.length() > 0? address : null;
39 by edam - pulled contacts cache out in to seperate class	305	}
39 by edam - pulled contacts cache out in to seperate class	306	}