Thursday 4 July 2013

Writing Content Provider

Android provides a cleaner & simplistic approach to handle the structured data through SQLite databases. But ever wondered, if your application wants data to be shared with other applications?? First thought that strikes the mind is sharing the database file by keeping it at a common location, may be on SD card. This approach indeed can work for you. :) But wait, why not to give a second thought on this? What if user just wipes out all data from his SD card? Or what if just removes the card from phone & forgot to put it back? These are some examples of what might go wrong with the application. In both the cases, not only the application for which you shared but also, your own app will certainly loose all data and/or crash. Quite embarrassing...

Here, comes the elegant way of sharing your app data with other apps reliably. Content Providers!
Content provider is a wrapper over the database which allows other applications to access data generated by our app. The wrapper consists of the methods written for database's read, update & delete operations on SQLite database.

For custom content provider, we need to have the app database built up and we will be providing the wrapper over it for other applications. To make other apps aware that a content provider is available, declare it in AndroidManifest.xml as:

Here the name refers to the class MyContentProvider which extends ContentProvider class. You need to override following methods in this class.
  • onCreate() 
  • delete(Uri, String, String[]) 
  • getType(Uri)
  • insert(Uri, ContentValues) 
  • query(Uri, String[], String, String[], String) 
  • update(Uri, ContentValues, String, String[])
Usually these are wrapper functions for SQL queries on the sqlite database. You parse the input parameters and perform the queries on your database.
public class MyContentProvider extends ContentProvider {

 DatabaseHelper mDatabase;
        private static final int RECORDS = 1;
 public static final Uri CONTENT_URI = Uri
   .parse("content://com.example.android.contentprovider");

 public static final String AUTHORITY = "com.example.android.contentprovider";
 private static final UriMatcher matcher = new UriMatcher(
   UriMatcher.NO_MATCH);
 
 static {
  matcher.addURI(AUTHORITY, "records", RECORDS);
 }

 @Override
 public int delete(Uri uri, String selection, String[] selectionArgs) {
  // the app specific code for deleting records from database goes here
  return 0;
 }

 @Override
 public String getType(Uri uri) {
  int matchType = matcher.match(uri);
  switch (matchType) {
  case RECORDS:
   return ContentResolver.CURSOR_DIR_BASE_TYPE + "/records";
  default:
   throw new IllegalArgumentException("Unknown or Invalid URI " + uri);
  }
 }

 @Override
 public Uri insert(Uri uri, ContentValues values) {
                //your app specific insertion code goes here
                // it can be as simple as follows; inserting all values in database and returning the record id
  long id = mDatabase.getWritableDatabase().insert(Helper.TABLE_NAME,
    null, values);
  uri = Uri.withAppendedPath(uri, "/" + id);
  return uri;
 }

 @Override
 public boolean onCreate() {
                //initialize your database constructs
  return true;
 }

 @Override
 public Cursor query(Uri uri, String[] projection, String selection,
   String[] selectionArgs, String sortOrder) {
                //build your query with SQLiteQueryBuilder
  SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder();
  qBuilder.setTables(Helper.TABLE_NAME);
  int uriType = matcher.match(uri);
  
                //query the database and get result in cursor
  Cursor resultCursor = qBuilder.query(mDatabase.getWritableDatabase(),
    projection, selection, selectionArgs, null, null, sortOrder,
    null);
  resultCursor.setNotificationUri(getContext().getContentResolver(), uri);
  return resultCursor;

 }

 @Override
 public int update(Uri uri, ContentValues values, String selection,
   String[] selectionArgs) {
  // to be implemented
  return 0;
 }

}

By providing a content provider you avoid giving access to your database to other developers and also reduce the chances of database inconsistency.

Saturday 9 February 2013

Integrating Google Analytics in Android App

As an enthusiastic developer, I always wish to offer many features in my application. Many times, it happens that a particular feature gets popular. I may be interested in finding such features which I would like keep enhancing. I may also cut down the features showing similarity to less popular features. But the question is how do I get such list? The common answer to this question would be taking feedback from users, having surveys, etc. How about getting this statistical data without all this hassle?

Yes, we can get the application usage data anonymously using Google Analytics. It works the same way, as we track the hit count for a particular web page. Using the statistics collected by Analytics, it is easy to plan the features for application.

Before we use Google Analytics in our app, we need an Analytics account and the Google Analytics SDK.

Download the Analytics SDK from here. Unzip the SDK and add libGoogleAnalytics.jar to your project's build path.

Add following permissions in your project's AndroidManifest.xml.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Now, sign into your analytics account and create a website profile for the App. The website URL can be fake but shall be descriptive enough. It is suggested that you use the reverse package name for this. For example, if the application package name is com.example.analytics.test; then the website URL for this app can be http://test.analytics.example.com. After successful creation of website profile, a web property ID is generated for that profile. Note it down as we will be using this in our app. This web property ID, also known as UA number of your tracking code, uniquely identifies the website profile. Note: You must mention in your App that you are collecting anonymous user data in your App to track your App.

After this setup, we are ready to track our application. Obtain the singleton instance of the tracker by calling GoogleAnalyticsTracker.getInstance() method. Then start tracking by calling its start()
method. Usually, we will want to track more than activities in the App. In such a scenario it is a good idea to have this tracker instance in onCreate() method of the Application class of the app.

public class TestApp extends Application {  
      
     //define your web property ID obtained after profile creation for the app   
      
      
     private String webId = "UA-XXXXXXXX-Y";  
      
      
     //Analytics tracker instance   
      
     GoogleAnalyticsTracker tracker;  
      
     @Override  
      
     public void onCreate() {  
      
      super.onCreate();   
      //get the singleton tracker instance  
      tracker = GoogleAnalyticsTracker.getInstance();  
      
      //start tracking app with your web property ID  
      tracker.start(webId,getApplicationContext());  
      
      //your app specific code goes here  
      
     }  
      
      
     /* This is getter for tracker instance.  
             This is called in activity to get reference to tracker instance. */  
      
     public GoogleAnalyticsTracker getTracker() {  
      
      return tracker;  
      
     }  
      
    }
You can track pageviews and events in the activity by calling trackPageView() and trackEvent() methods on tracker instance.
public class MainActivity extends Activity   
    {  
      
        @Override  
      
        protected void onCreate(Bundle savedInstanceState) {  
      
            super.onCreate(savedInstanceState);  
      
                  
      
            //track the page view for activity  
      
            GoogleAnalyticsTracker tracker = ((TestApp)getApplication()).getTracker();  
            tracker.trackPageView("/MainActivity");  
      
      
            /*You can track events like button clicks*/  
      
            findViewById(R.id.actionButton).setOnClickListener(  
                new View.OnClickListener() {           
      
            @Override  
            public void onClick(View v) {  
      
                  GoogleAnalyticsTracker tracker = ((TestApp)getApplication()).getTracker();  
                  tracker.trackEvent("Action Event","Action Button", "Button clicked",0);  
                  tracker.dispatch();  
      
            }  
      
             });  
      
            //your stuff goes here      
      
        }  
      
    }
Remember, your events and pageviews will not be sent to server until you call dispatch() method on tracker. In this way we can track all the activities and events inside them. By analyzing the various reports available on Google Analytics page, we can plan the features for the app.