Android AutoCompleteTextView with Custom Adapter filtering not working

Android Problem Overview

I've the Custom CustomerAdapter

public class CustomerAdapter extends ArrayAdapter<Customer> {
	private final String MY_DEBUG_TAG = "CustomerAdapter";
	private ArrayList<Customer> items;
	private int viewResourceId;
	
	public CustomerAdapter(Context context, int viewResourceId, ArrayList<Customer> items) {
		super(context, viewResourceId, items);
		this.items = items;
		this.viewResourceId = viewResourceId;
	}

	public View getView(int position, View convertView, ViewGroup parent) {
		View v = convertView;
		if (v == null) {
			LayoutInflater vi = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
			v = vi.inflate(viewResourceId, null);
		}
		Customer customer = items.get(position);
		if (customer != null) {
			TextView customerNameLabel = (TextView) v.findViewById(R.id.customerNameLabel);
			if (customerNameLabel != null) {
				customerNameLabel.setText(String.valueOf(customer.getName()));
			}
		}
		return v;
	}
}

and customer_auto layout

<?xml version="1.0" encoding="utf-8"?>
<TextView xmlns:android="http://schemas.android.com/apk/res/android"
	android:id="@+id/customerNameLabel"
	android:layout_width="fill_parent" android:layout_height="fill_parent"
	android:padding="10dp" android:textSize="16sp" 
	android:textColor="#000">
</TextView>

and on my public void onCreate

AutoCompleteTextView customerAutoComplete = (AutoCompleteTextView) findViewById(R.id.autocomplete_customer);
CustomerAdapter customerAdapter = new CustomerAdapter(this, R.layout.customer_auto, customerList);
customerAutoComplete.setAdapter(customerAdapter);

and Customer.java

public class Customer implements Parcelable {
	
	private int id;
	private String name = "";
	
	public Customer() {
		// TODO Auto-generated constructor stub
	}
	
	/**
	 * This will be used only by the MyCreator
	 * 
	 * @param source
	 */
	public Customer(Parcel source) {
		/*
		 * Reconstruct from the Parcel
		 */
		id = source.readInt();
		name = source.readString();
	}
	
	public void setId(int id) {
		this.id = id;
	}
	
	public void setName(String name) {
		this.name = name;
	}
	
	public int getId() {
		return this.id;
	}
	
	public String getName() {
		return this.name;
	}
	
	@Override
	public int describeContents() {
		return 0;
	}
	
	@Override
	public void writeToParcel(Parcel dest, int flags) {
		dest.writeInt(id);
		dest.writeString(name);
	}
	
	public static final Parcelable.Creator CREATOR = new Parcelable.Creator() {
		
		@Override
		public Customer createFromParcel(Parcel source) {
			return new Customer(source);
		}
		
		@Override
		public Customer[] newArray(int size) {
			return new Customer[size];
			// TODO Auto-generated method stub
		}
		
	};
	
	@Override
	public String toString() {
		return this.name;
	}
	
}

But the auto suggest box does not filter correctly. for eg; if i type an in the test box customers starting with br are showing up!

Android Solutions

Solution 1 - Android

I have to over-ride the getFilter() method of the Adapter

Here is the code which worked for me, thanks to sacoskun

public class CustomerAdapter extends ArrayAdapter<Customer> {
	private final String MY_DEBUG_TAG = "CustomerAdapter";
	private ArrayList<Customer> items;
	private ArrayList<Customer> itemsAll;
	private ArrayList<Customer> suggestions;
	private int viewResourceId;
	
	public CustomerAdapter(Context context, int viewResourceId, ArrayList<Customer> items) {
		super(context, viewResourceId, items);
		this.items = items;
		this.itemsAll = (ArrayList<Customer>) items.clone();
		this.suggestions = new ArrayList<Customer>();
		this.viewResourceId = viewResourceId;
	}

	public View getView(int position, View convertView, ViewGroup parent) {
		View v = convertView;
		if (v == null) {
			LayoutInflater vi = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
			v = vi.inflate(viewResourceId, null);
		}
		Customer customer = items.get(position);
		if (customer != null) {
			TextView customerNameLabel = (TextView) v.findViewById(R.id.customerNameLabel);
			if (customerNameLabel != null) {
//				Log.i(MY_DEBUG_TAG, "getView Customer Name:"+customer.getName());
				customerNameLabel.setText(customer.getName());
			}
		}
		return v;
	}
	
	@Override
	public Filter getFilter() {
		return nameFilter;
	}
	
	Filter nameFilter = new Filter() {
        @Override
		public String convertResultToString(Object resultValue) {
			String str = ((Customer)(resultValue)).getName(); 
			return str;
		}
		@Override
		protected FilterResults performFiltering(CharSequence constraint) {
			if(constraint != null) {
				suggestions.clear();
				for (Customer customer : itemsAll) {
					if(customer.getName().toLowerCase().startsWith(constraint.toString().toLowerCase())){
						suggestions.add(customer);
					}
				}
				FilterResults filterResults = new FilterResults();
				filterResults.values = suggestions;
				filterResults.count = suggestions.size();
				return filterResults;
			} else {
				return new FilterResults();
			}
		}
		@Override
		protected void publishResults(CharSequence constraint, FilterResults results) {
			ArrayList<Customer> filteredList = (ArrayList<Customer>) results.values;
			if(results != null && results.count > 0) {
				clear();
				for (Customer c : filteredList) {
					add(c);
				}
				notifyDataSetChanged();
			}
		}
	};
	
}

Solution 2 - Android

This is my solution. I feel like it's a bit cleaner (doesn't use 3 separate, confusing ArrayLists) than the accepted one, and has more options. It should work even if the user types backspace, because it doesn't remove the original entries from mCustomers (unlike the accepted answer):

public class CustomerAdapter extends ArrayAdapter<Customer> {
    private LayoutInflater layoutInflater;
    List<Customer> mCustomers;

    private Filter mFilter = new Filter() {
        @Override
        public String convertResultToString(Object resultValue) {
            return ((Customer)resultValue).getName();
        }

        @Override
        protected FilterResults performFiltering(CharSequence constraint) {
            FilterResults results = new FilterResults();

            if (constraint != null) {
                ArrayList<Customer> suggestions = new ArrayList<Customer>();
                for (Customer customer : mCustomers) {
                    // Note: change the "contains" to "startsWith" if you only want starting matches
                    if (customer.getName().toLowerCase().contains(constraint.toString().toLowerCase())) {
                        suggestions.add(customer);
                    }
                }

                results.values = suggestions;
                results.count = suggestions.size();
            }

            return results;
        }

        @Override
        protected void publishResults(CharSequence constraint, FilterResults results) {
            clear();
            if (results != null && results.count > 0) {
                // we have filtered results
                addAll((ArrayList<Customer>) results.values);
            } else {
                // no filter, add entire original list back in
                addAll(mCustomers);
            }
            notifyDataSetChanged();
        }
    };

    public CustomerAdapter(Context context, int textViewResourceId, List<Customer> customers) {
        super(context, textViewResourceId, customers);
        // copy all the customers into a master list
        mCustomers = new ArrayList<Customer>(customers.size());
        mCustomers.addAll(customers);
        layoutInflater = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
    }

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        View view = convertView;

        if (view == null) {
            view = layoutInflater.inflate(R.layout.customerNameLabel, null);
        }

        Customer customer = getItem(position);

        TextView name = (TextView) view.findViewById(R.id.customerNameLabel);
        name.setText(customer.getName());

        return view;
    }

    @Override
    public Filter getFilter() {
        return mFilter;
    }
}

Solution 3 - Android

Instead of overriding getFilter() method in adapter, simply we can override the toString() of the userDefined object (Customer). In toString() just return the field based on what you need to filter. It worked for me.

In my example I'm filtering based on names:

public class Customer{
    private int id;
    private String name;

    @Override
    public String toString() {
        return this.name;
    }
}

Solution 4 - Android

In the above code publisHResults() method gives the concurrent modification exception.... we have to modify the code as:

@Override
protected void publishResults(CharSequence constraint, FilterResults results) {
    ArrayList<Customer> filteredList = (ArrayList<Customer>) results.values;
    ArrayList<Customer> customerList=new ArrayList<Customer>();
    if (results != null && results.count > 0) {
        clear();
        for (Customer c : filteredList) {
            customerList.add(c);
        }
        Iterator<Customer> customerIterator=getResult.iterator();
        while (customerIterator.hasNext()) {
        	Customer customerIterator=customerIterator.next();
         	add(customerIterator);
        }
        notifyDataSetChanged();
    }
}

Solution 5 - Android

Maybe this is too late, you dont need to override all of these functions , the only function to override is :

  public View getView(int position, View convertView, ViewGroup parent) {
    View v = convertView;
    if (v == null) {
        LayoutInflater vi = (LayoutInflater) getContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
        v = vi.inflate(viewResourceId, null);
    }
    Customer customer = getItem(position);
    if (customer != null) {
        TextView customerNameLabel = (TextView) v.findViewById(R.id.customerNameLabel);
        if (customerNameLabel != null) {
            customerNameLabel.setText(String.valueOf(customer.getName()));
        }
    }
    return v;
}

consider I change :

 Customer customer = items.get(position);
 Customer customer = getItem(position);

pay attention, you should not declare new ListItems,

 private ArrayList<Customer> items;

because ArrayAdapter works with its own mObjects, and filter this list not your items list, So you should use getItem function to access items. then there is no reason to write your ArrayFilter.

Solution 6 - Android

I don't know where you retrieving the getResult. I think the solution in this case for don't have the concurrent modification is:

@Override
protected void publishResults(CharSequence constraint, FilterResults results) {
    ArrayList<Customer> filteredList = (ArrayList<Customer>) results.values;
    ArrayList<Customer> customerList=new ArrayList<Customer>();
    if (results != null && results.count > 0) {
        clear();

try{
            for (Customer c : filteredList) {
                customerList.add(c);
            }
}catch(Exception e){
Log.e("PEEEETAAAAAAAA", "AutoCompletaError: "+e.getMessage()+"  "+e.getCause()+" "+e.getLocalizedMessage());
			}

        Iterator<Customer> customerIterator=customerList.iterator();
        while (customerIterator.hasNext()) {
            Customer customerIterator=customerIterator.next();
            add(customerIterator);
        }
        notifyDataSetChanged();
    }
}

Solution 7 - Android

If you get ConcurrentModificationException exception.

Replace ArrayList with the thread safe CopyOnWriteArrayList.

Here you can find detatils answer

Solution 8 - Android

I hope that this post will help people with implementation of a similar custom functionality in the future. I based this on my version of adapter used for displaying tag suggestions in my microblogging app:

public class TagSuggestionsAdapter extends ArrayAdapter<String> implements Filterable

Extending ArrayAdapter to have less boilerplate code. Implementing Filterable to change filter behavior later.

    private List<String> allTags;
    private List<String> tagSuggestions;      
    private Context context;

public TagSuggestionsAdapter(List<String> initialTagSuggestions, List<String> allTags,
                             Context context) {
    super(context, R.layout.item_tag_suggestion, initialTagSuggestions);
    this.tagSuggestions = initialTagSuggestions;
    this.allTags = allTags;   
    this.context = context;
}

Basically in constructor you need to pass a list that will be displayed initially - it'll later become a list with filtered results (this is also a reference to a list that will be taken into consideration when calling notifyDataSetChanged()) and obviously a list on which you can base your filtering (allTags in my case). I'm also passing Context for layout inflation in getView().

   @NonNull
    @Override
    public View getView(final int position, @Nullable View convertView, @NonNull ViewGroup parent) {

        ViewHolder viewHolder;    

        if (convertView == null) {
            convertView = LayoutInflater.from(context)
                    .inflate(R.layout.item_tag_suggestion, parent, false);
            viewHolder = new ViewHolder(convertView);
            convertView.setTag(viewHolder);
        } else {
            viewHolder = (ViewHolder) convertView.getTag();
        }

        viewHolder.tagSuggestionTextView.setText(tagSuggestions.get(position));
      
        return convertView;
    }

    static class ViewHolder {

        @BindView(R.id.tag_suggestion_text_view)
        TextView tagSuggestionTextView;

        ViewHolder(View itemView) {
            ButterKnife.bind(this, itemView);
        }
    }

Above you can see a simple view holder pattern with a little help from Butterknife to inflate a custom row layout.

 @NonNull
    @Override
    public Filter getFilter() {
        return new Filter() {

            @Override
            protected FilterResults performFiltering(CharSequence constraint) {
                if (constraint != null) {
                    List<String> filteredTags = filterTagSuggestions(constraint.toString(), allTags);
                    FilterResults filterResults = new FilterResults();
                    filterResults.values = filteredTags;
                    filterResults.count = filteredTags.size();
                    return filterResults;
                } else {
                    return new FilterResults();
                }
            }

            @Override
            protected void publishResults(CharSequence constraint, FilterResults results) {
                tagSuggestions.clear();
                if (results != null && results.count > 0) {
                    List<?> filteredTags = (List<?>) results.values;
                    for (Object filteredTag : filteredTags) {
                        if (filteredTag instanceof String) {
                            tagSuggestions.add((String) filteredTag);
                        }
                    }
                }
                notifyDataSetChanged();
            }
        };
    }

This is the least boilerplate code I could write. Your only concern is method filterTagSuggestions that should return a filtered list of tags based on input from user (CharSequence constraint). Hope that summarized and organized necessary info a little bit.

Solution 9 - Android

I have non-update and modify orginal list issues from above answer. I fixed this problem with this codes.

public class AdapterAutoCompleteTextView extends ArrayAdapter<ItemWord> {

    private int LayoutID;
    private int TextViewID;

    private LayoutInflater Inflater;

    private List<ItemWord> ObjectsList;

    public AdapterAutoCompleteTextView(Context ActivityContext, int ResourceID, int TextViewResourceID, List<ItemWord> WordList) {
        super(ActivityContext, ResourceID, TextViewResourceID, new ArrayList<ItemWord>());

        LayoutID = ResourceID;
        TextViewID = TextViewResourceID;

        ObjectsList = WordList;

        Inflater = LayoutInflater.from(ActivityContext);
    }

    @Override
    public View getView(int Position, View ConvertView, ViewGroup Parent) {
        ItemWord Word = getItem(Position);

        if(ConvertView == null) {
            ConvertView = Inflater.inflate(LayoutID, null);

            ResultHolder Holder = new ResultHolder();

            Holder.ResultLabel= (TextView) ConvertView.findViewById(TextViewID);

            ConvertView.setTag(Holder);
        }

        ResultHolder Holder = (ResultHolder) ConvertView.getTag();

        Holder.ResultLabel.setText(Word.getSpelling());

        return ConvertView;
    }

    @Override
    public Filter getFilter() {
        return CustomFilter;
    }

    private Filter CustomFilter = new Filter() {
        @Override
        public CharSequence convertResultToString(Object ResultValue) {
            return ((ItemWord) ResultValue).getSpelling();
        }

        @Override
        protected FilterResults performFiltering(CharSequence Constraint) {
            FilterResults ResultsFilter = new FilterResults();

            ArrayList<ItemWord> OriginalValues = new ArrayList<ItemWord>(ObjectsList);

            if(Constraint == null || Constraint.length() == 0){
                ResultsFilter.values = OriginalValues;
                ResultsFilter.count = OriginalValues.size();
            } else {
                String PrefixString = Constraint.toString().toLowerCase();

                final ArrayList<ItemWord> NewValues = new ArrayList<ItemWord>();

                for(ItemWord Word : OriginalValues){
                    String ValueText = Word.getSpelling().toLowerCase();

                    if(ValueText.startsWith(PrefixString))
                        NewValues.add(Word);
                }

                ResultsFilter.values = NewValues;
                ResultsFilter.count = NewValues.size();
            }

            return ResultsFilter;
        }

        @Override
        protected void publishResults(CharSequence Constraint, FilterResults Results) {
            clear();

            if(Results.count > 0)
                addAll(((ArrayList<ItemWord>) Results.values));
            else
                notifyDataSetInvalidated();
        }
    };

    private static class ResultHolder {
        TextView ResultLabel;
    }

}

This is most important line for non-update and modify orginal list issue:

super(ActivityContext, ResourceID, TextViewResourceID, new ArrayList<ItemWord>());

Particularly those

super(ActivityContext, ResourceID, TextViewResourceID, new ArrayList());

I hope this solution will be help you :)

Content Type	Original Author	Original Content on Stackoverflow
Question	Mithun Sreedharan	View Question on Stackoverflow
Solution 1 - Android	Mithun Sreedharan	View Answer on Stackoverflow
Solution 2 - Android	Carl Anderson	View Answer on Stackoverflow
Solution 3 - Android	kavinraj M	View Answer on Stackoverflow
Solution 4 - Android	Shivani Sangewar	View Answer on Stackoverflow
Solution 5 - Android	Mehrdad Faraji	View Answer on Stackoverflow
Solution 6 - Android	Jachumbelechao Unto Mantekilla	View Answer on Stackoverflow
Solution 7 - Android	Zoltán Buzás	View Answer on Stackoverflow
Solution 8 - Android	matdziu	View Answer on Stackoverflow
Solution 9 - Android	Abdulkadir NURKALEM	View Answer on Stackoverflow