Queries

In Tutorial Part I, we created a test class, one model class and two scenes that demonstrated basic CRUD functionality with complex model objects as well as authentication.

If you wish, you can download the complete Part II project file from Download Tutorial Part 2 Sample Files, unzip and then either run newapp again from this directory to use this application or copy the files that are enclosed to the application directory you created in a previous section Installing FatFractal allowing the copy to replace all the previous files.

If you have not scaffolded your app already, it is not a problem, just run ffef newapp, using your subdomain, as before from the directory with the Part II files you have just downloaded and it will set up all the things that you need.

> $HOME/ff/ffnsbin/ffef newapp hoodyoodoo <your subdomain>

Note: The subdomain refers to the name you signed up with, e.g. acme in acme.fatfractal.com

Note: When you download the project, the client application is configured to use a API that is already deployed and populated with data. This means you can run the application on your simulator immediately. To use your API, you should edit the Hoodyoodoo.java file as before to point to the API that you have set up.

In Tutorial Part II, we will streamline retrieving objects such that we only transfer the required data to the client. To do that we will use a query. Then we will begin to add the game mechanic to the WouldYaViewController. The design is that we will present two random and unique celebrities of the gender the player chooses, and when selected, create a record which we will call a “WouldYa” and store that in the API. In order to do that, we need to do the following:

Retrieve a random Celebrity of the selected gender using a query.
Retrieve a second random Celebrity of the selected gender that is different from the first one using a more complex query.
Add a new model class called “WouldYa” to our API.
Add the CRUD method to WouldYaViewController to persist our WouldYa to the API.

Retrieve a random Celebrity

Retrieve all Celebrities

To recap, Part I showed you how to retrieve all objects of a certain class from the API using the getArrayFromUri method.

ff.getArrayFromUri("/ff/resources/Celebrity",
function(celebArray) {
    ...
}, ...);

And we used the following to pick out a random Celebrity from celebArray and set it to leftCelebritywhich resulted in a major performance issue with large numbers of Celebrity objects.

var leftCelebrity = celebArray[Math.floor(Math.random() * celebArray.length)];

This is not efficient as we would retrieve all Celebrity objects, along with their images to the client application, and then force the client code to extract what it needs. If there were thousands of Celebrities in the datastore, this would be a huge load on the backend, the network and the client.

Retrieve a single random Celebrity

So, we need a better way to filter the result set on the backend. NoServer features an elegant method of filtering results using queries expressed as natural language strings. For example, if we wanted to retrieve a random Celebrity from the API, we write a query as follows: In the loadCelebrities method:

Change the method from getArrayFromUri to getObjFromUri since we only want to retrieve one object after all.
Add a query to the request in the form: /(guid eq random(guid)) that will return a single random Celebrity.

ff.getObjFromUri("/ff/resources/Celebrity/(gender eq '" + m_currentGender + "'",
function(leftCelebrity) {
    ...
}, ...);

This will return a single random Celebrity which is far more efficient for both the backend as well as the client code.

Retrieve a single random Celebrity filtered by gender parameter

For our application, we need to do also filter by gender, which will be selected by the user. To do that we need to be able to pass parameters in to the query. This is easily done by constructing the query string using NSString stringWithFormat as shown below and pass in the desired parameter(s).

ff.getObjFromUri("/ff/resources/Celebrity/(gender eq '" + m_currentGender + "' and guid eq random(guid))",
function(leftCelebrity) {
    ...
}, ...);

Note: The code on this page demonstrates the principles of using queries in Hoodyoodoo using synchronous requests. We will later implement loadCelebrities using asynchronous requests to allow the downloads to occur in the background.

Retrieve a second Celebrity filtered by gender parameter and not equal to the first Celebrity

Now, to complete loadCelebrities, we add the code to get the second Celebrity. This will use the FatFractal getMetaDataForObj method to get the guid from the meta data supplied by the API along with m_leftCeleb and pass the guid a as a parameter for another query that will make sure that the two Celebrities are unique.

ff.getObjFromUri("/ff/resources/Celebrity/(gender eq '" + m_currentGender + "' and guid ne '" + leftCelebrity.guid + "' and guid eq random(guid))",
function(rightCelebrity) {
    ...
}, ...);

NEXT: The WouldYa Class