com.firebase.ui.database

Class FirebaseListAdapter<T>

java.lang.Object

android.widget.BaseAdapter

com.firebase.ui.database.FirebaseListAdapter<T>

Type Parameters:

T - The class type to use as a model for the data contained in the children of the given Firebase location

All Implemented Interfaces:

android.widget.Adapter, android.widget.ListAdapter, android.widget.SpinnerAdapter

Direct Known Subclasses:

FirebaseIndexListAdapter

public abstract class FirebaseListAdapter<T>
extends android.widget.BaseAdapter

This class is a generic way of backing an Android ListView with a Firebase location. It handles all of the child events at the given Firebase location. It marshals received data into the given class type. Extend this class and provide an implementation of populateView, which will be given an instance of your list item mLayout and an instance your class that holds your data. Simply populate the view however you like and this class will handle updating the list as the data changes.

     DatabaseReference ref = FirebaseDatabase.getInstance().getReference();
     ListAdapter adapter = new FirebaseListAdapter(
              this, ChatMessage.class, android.R.layout.two_line_list_item, ref)
     {
         protected void populateView(View view, ChatMessage chatMessage, int position)
         {
             ((TextView)view.findViewById(android.R.id.text1)).setText(chatMessage.getName());
             ((TextView)view.findViewById(android.R.id.text2)).setText(chatMessage.getMessage());
         }
     };
     listView.setListAdapter(adapter);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected android.app.Activity	mActivity
protected int	mLayout

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
FirebaseListAdapter(android.app.Activity activity, java.lang.Class<T> modelClass, int modelLayout, Query ref)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
int	getCount()
T	getItem(int position)
long	getItemId(int i)
DatabaseReference	getRef(int position)
android.view.View	getView(int position, android.view.View view, android.view.ViewGroup viewGroup)
protected void	onCancelled(DatabaseError error)
protected void	onChildChanged(ChangeEventListener.EventType type, int index, int oldIndex)
protected void	onDataChanged()
protected T	parseSnapshot(DataSnapshot snapshot) This method parses the DataSnapshot into the requested type.
protected abstract void	populateView(android.view.View v, T model, int position) Each time the data at the given Firebase location changes, this method will be called for each item that needs to be displayed.

Methods inherited from class android.widget.BaseAdapter

areAllItemsEnabled, getDropDownView, getItemViewType, getViewTypeCount, hasStableIds, isEmpty, isEnabled, notifyDataSetChanged, notifyDataSetInvalidated, registerDataSetObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mActivity

protected android.app.Activity mActivity

mLayout

protected int mLayout

Constructor Detail

FirebaseListAdapter

public FirebaseListAdapter(android.app.Activity activity,
                           java.lang.Class<T> modelClass,
                           int modelLayout,
                           Query ref)

Parameters:

activity - The activity containing the ListView

modelClass - Firebase will marshall the data at a location into an instance of a class that you provide

modelLayout - This is the layout used to represent a single list item. You will be responsible for populating an instance of the corresponding view with the data from an instance of modelClass.

ref - The Firebase location to watch for data changes. Can also be a slice of a location, using some combination of limit(), startAt(), and endAt().

Method Detail

cleanup

public void cleanup()

getCount

public int getCount()

getItem

public T getItem(int position)

parseSnapshot

protected T parseSnapshot(DataSnapshot snapshot)

This method parses the DataSnapshot into the requested type. You can override it in subclasses to do custom parsing.

Parameters:

snapshot - the DataSnapshot to extract the model from

Returns:

the model extracted from the DataSnapshot

getRef

public DatabaseReference getRef(int position)

getItemId

public long getItemId(int i)

getView

public android.view.View getView(int position,
                                 android.view.View view,
                                 android.view.ViewGroup viewGroup)

onChildChanged

protected void onChildChanged(ChangeEventListener.EventType type,
                              int index,
                              int oldIndex)

See Also:

ChangeEventListener.onChildChanged(ChangeEventListener.EventType, int, int)

onDataChanged

protected void onDataChanged()

See Also:

ChangeEventListener.onDataChanged()

onCancelled

protected void onCancelled(DatabaseError error)

See Also:

ChangeEventListener.onCancelled(DatabaseError)

populateView

protected abstract void populateView(android.view.View v,
                                     T model,
                                     int position)

Each time the data at the given Firebase location changes, this method will be called for each item that needs to be displayed. The first two arguments correspond to the mLayout and mModelClass given to the constructor of this class. The third argument is the item's position in the list.

Your implementation should populate the view using the data contained in the model.

Parameters:

v - The view to populate

model - The object containing the data used to populate the view

position - The position in the list of the view being populated