Updated changes based on pull request feedback

rlwaldrop · rlwaldrop · commit a0c799deb2a3 · 2014-09-30T12:54:47.000+02:00
diff --git a/examples/gridViewExample/build.gradle b/examples/gridViewExample/build.gradle
@@ -14,7 +14,7 @@ android {
     compileSdkVersion 19
     buildToolsVersion "20.0.0"
     defaultConfig {
-        applicationId 'examples.realm.io.gridViewExample'
+        applicationId 'io.realm.examples.realmgridview'
         minSdkVersion 15
         targetSdkVersion 19
         versionCode 1
diff --git a/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/City.java b/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/City.java
@@ -39,11 +39,4 @@ public void setVotes(long votes) {
         this.votes = votes;
     }
 
-    @Override
-    public String toString() {
-        return "City{" +
-                "name='" + name + '\'' +
-                ", votes=" + votes +
-                '}';
-    }
 }
diff --git a/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/CityAdapter.java b/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/CityAdapter.java
@@ -25,6 +25,12 @@
 
 import java.util.List;
 
+// This adapter is strictly to interface with the GridView and doesn't
+// particular show much interesting Realm functionality.
+
+// Alternatively from this example,
+// a developer could update the getView() to pull items from the Realm.
+
 public class CityAdapter extends BaseAdapter {
 
     public static final String TAG = RealmExampleActivity.class.getName();
diff --git a/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/RealmExampleActivity.java b/examples/gridViewExample/src/main/java/io/realm/examples/realmgridview/RealmExampleActivity.java
@@ -26,6 +26,7 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
 
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
@@ -38,7 +39,7 @@ public class RealmExampleActivity extends Activity implements AdapterView.OnItem
 
     public static final String TAG = RealmExampleActivity.class.getName();
 
-    private GridView mGrid;
+    private GridView mGridView;
     private CityAdapter mAdapter;
 
     @Override
@@ -51,28 +52,32 @@ protected void onCreate(Bundle savedInstanceState) {
     public void onResume() {
         super.onResume();
 
+        // Load from file "cities.json" first time
         if(mAdapter == null) {
             List<City> cities = loadCities();
+
+            //This is the GridView adapter
             mAdapter = new CityAdapter(this);
             mAdapter.setData(cities);
 
-            mGrid = (GridView) findViewById(R.id.cities_list);
-            mGrid.setAdapter(mAdapter);
-            mGrid.setOnItemClickListener(RealmExampleActivity.this);
+            //This is the GridView which will display the list of cities
+            mGridView = (GridView) findViewById(R.id.cities_list);
+            mGridView.setAdapter(mAdapter);
+            mGridView.setOnItemClickListener(RealmExampleActivity.this);
             mAdapter.notifyDataSetChanged();
-            mGrid.invalidate();
+            mGridView.invalidate();
         }
     }
 
     public List<City> loadCities() {
         List<City> items = new ArrayList<City>();
 
-        //In this case we're loading from local assets.
-        //NOTE: could alternatively easily load from network
+        // In this case we're loading from local assets.
+        // NOTE: could alternatively easily load from network
         InputStream stream = null;
         try {
             stream = getAssets().open("cities.json");
-        } catch (Exception e) {
+        } catch (IOException e) {
             return null;
         }
 
@@ -85,11 +90,15 @@ public List<City> loadCities() {
         // Store the retrieved items to the Realm
         Realm realm = Realm.getInstance(this);
 
+        // Open a transaction to store items into the realm
         realm.beginTransaction();
         for (JsonElement e : array) {
+            // Create a realm capable object
             City realmCity = realm.createObject(City.class);
             realmCity.setName(e.getAsJsonObject().get("name").getAsString());
             realmCity.setVotes(e.getAsJsonObject().get("votes").getAsInt());
+            // Minor optimization to keep the new cities in a list
+            // so it doesn't have to be reloaded the first time
             items.add(realmCity);
         }
         realm.commitTransaction();
@@ -99,20 +108,27 @@ public List<City> loadCities() {
 
     public void updateCities() {
         Realm realm = Realm.getInstance(this);
+
+        // Pull all the cities from the realm
         RealmResults<City> cities = realm.where(City.class).findAll();
+
+        // Put these items in the Adapter
         mAdapter.setData(cities);
         mAdapter.notifyDataSetChanged();
-        mGrid.invalidate();
+        mGridView.invalidate();
     }
 
     @Override
     public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
         City modifiedCity = (City)mAdapter.getItem(position);
 
-        //Update the realm object affected by the user
+        // Update the realm object affected by the user
         Realm realm = Realm.getInstance(this);
+
+        // Acquire the list of realm cities matching the name of the clicked City.
         City city = realm.where(City.class).equalTo("name", modifiedCity.getName()).findFirst();
 
+        // Create a transaction to increment the vote count for the selected City in the realm
         realm.beginTransaction();
         city.setVotes(city.getVotes() + 1);
         realm.commitTransaction();

Original file line number	Diff line number	Diff line change
`@@ -39,11 +39,4 @@ public void setVotes(long votes) {`
`39`	`39`	`this.votes = votes;`
`40`	`40`	`}`
`41`	`41`
`42`		`- @Override`
`43`		`- public String toString() {`
`44`		`- return "City{" +`
`45`		`- "name='" + name + '\'' +`
`46`		`- ", votes=" + votes +`
`47`		`- '}';`
`48`		`- }`
`49`	`42`	`}`