package com.example.android.asynctaskloader;
import android.os.Bundle;
import android.support.v4.app.LoaderManager;
import android.support.v4.content.AsyncTaskLoader;
import android.support.v4.content.Loader;
import android.support.v7.app.AppCompatActivity;
import android.text.TextUtils;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.widget.EditText;
import android.widget.ProgressBar;
import android.widget.TextView;
import com.example.android.asynctaskloader.utilities.NetworkUtils;
import java.io.IOException;
import java.net.URL;
//@@1
public class MainActivity extends AppCompatActivity implements
LoaderManager.LoaderCallbacks<String> {
/* A constant to save and restore the URL that is being displayed */
private static final String SEARCH_QUERY_URL_EXTRA = "query";
/*
* This number will uniquely identify our Loader and is chosen arbitrarily. You can change this
* to any number you like, as long as you use the same variable name.
*/
// @@2
private static final int GITHUB_SEARCH_LOADER = 22;
private EditText mSearchBoxEditText;
private TextView mUrlDisplayTextView;
private TextView mSearchResultsTextView;
private TextView mErrorMessageDisplay;
private ProgressBar mLoadingIndicator;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mSearchBoxEditText = (EditText) findViewById(R.id.et_search_box);
mUrlDisplayTextView = (TextView) findViewById(R.id.tv_url_display);
mSearchResultsTextView = (TextView) findViewById(R.id.tv_github_search_results_json);
mErrorMessageDisplay = (TextView) findViewById(R.id.tv_error_message_display);
mLoadingIndicator = (ProgressBar) findViewById(R.id.pb_loading_indicator);
if (savedInstanceState != null) {
String queryUrl = savedInstanceState.getString(SEARCH_QUERY_URL_EXTRA);
mUrlDisplayTextView.setText(queryUrl);
}
/*
* Initialize the loader
*/
// @@6.1
getSupportLoaderManager().initLoader(GITHUB_SEARCH_LOADER, null, this);
}
/**
* This method retrieves the search text from the EditText, constructs the
* URL (using {@link NetworkUtils}) for the github repository you'd like to find, displays
* that URL in a TextView, and finally request that an AsyncTaskLoader performs the GET request.
*/
private void makeGithubSearchQuery() {
String githubQuery = mSearchBoxEditText.getText().toString();
/*
* If the user didn't enter anything, there's nothing to search for. In the case where no
* search text was entered but the search button was clicked, we will display a message
* stating that there is nothing to search for and we will not attempt to load anything.
*
* If there is text entered in the search box when the search button was clicked, we will
* create the URL that will return our Github search results, display that URL, and then
* pass that URL to the Loader. The reason we pass the URL as a String is simply a matter
* of convenience. There are other ways of achieving this same result, but we felt this
* was the simplest.
*/
if (TextUtils.isEmpty(githubQuery)) {
mUrlDisplayTextView.setText("No query entered, nothing to search for.");
return;
}
URL githubSearchUrl = NetworkUtils.buildUrl(githubQuery);
mUrlDisplayTextView.setText(githubSearchUrl.toString());
// @@3
Bundle queryBundle = new Bundle();
queryBundle.putString(SEARCH_QUERY_URL_EXTRA, githubSearchUrl.toString());
/*
* Now that we've created our bundle that we will pass to our Loader, we need to decide
* if we should restart the loader (if the loader already existed) or if we need to
* initialize the loader (if the loader did NOT already exist).
*
* We do this by first store the support loader manager in the variable loaderManager.
* All things related to the Loader go through through the LoaderManager. Once we have a
* hold on the support loader manager, (loaderManager) we can attempt to access our
* githubSearchLoader. To do this, we use LoaderManager's method, "getLoader", and pass in
* the ID we assigned in its creation. You can think of this process similar to finding a
* View by ID. We give the LoaderManager an ID and it returns a loader (if one exists). If
* one doesn't exist, we tell the LoaderManager to create one. If one does exist, we tell
* the LoaderManager to restart it.
*/
// @@6.2
LoaderManager loaderManager = getSupportLoaderManager();
Loader<String> githubSearchLoader = loaderManager.getLoader(GITHUB_SEARCH_LOADER);
if (githubSearchLoader == null) {
loaderManager.initLoader(GITHUB_SEARCH_LOADER, queryBundle, this);
} else {
loaderManager.restartLoader(GITHUB_SEARCH_LOADER, queryBundle, this);
}
}
/**
* This method will make the View for the JSON data visible and
* hide the error message.
* <p>
* Since it is okay to redundantly set the visibility of a View, we don't
* need to check whether each view is currently visible or invisible.
*/
private void showJsonDataView() {
/* First, make sure the error is invisible */
mErrorMessageDisplay.setVisibility(View.INVISIBLE);
/* Then, make sure the JSON data is visible */
mSearchResultsTextView.setVisibility(View.VISIBLE);
}
/**
* This method will make the error message visible and hide the JSON
* View.
* <p>
* Since it is okay to redundantly set the visibility of a View, we don't
* need to check whether each view is currently visible or invisible.
*/
private void showErrorMessage() {
/* First, hide the currently visible data */
mSearchResultsTextView.setVisibility(View.INVISIBLE);
/* Then, show the error */
mErrorMessageDisplay.setVisibility(View.VISIBLE);
}
@Override
public Loader<String> onCreateLoader(int id, final Bundle args) {
// @@4
return new AsyncTaskLoader<String>(this) {
// COMPLETED (1) Create a String member variable called mGithubJson that will store the raw JSON
/* This String will contain the raw JSON from the results of our Github search */
String mGithubJson;
@Override
protected void onStartLoading() {
/* If no arguments were passed, we don't have a query to perform. Simply return. */
if (args == null) {
return;
}
/*
* When we initially begin loading in the background, we want to display the
* loading indicator to the user
*/
mLoadingIndicator.setVisibility(View.VISIBLE);
// COMPLETED (2) If mGithubJson is not null, deliver that result. Otherwise, force a load
/*
* If we already have cached results, just deliver them now. If we don't have any
* cached results, force a load.
*/
if (mGithubJson != null) {
//@@7.1
deliverResult(mGithubJson);
} else {
forceLoad();
}
}
@Override
public String loadInBackground() {
/* Extract the search query from the args using our constant */
String searchQueryUrlString = args.getString(SEARCH_QUERY_URL_EXTRA);
/* If the user didn't enter anything, there's nothing to search for */
if (searchQueryUrlString == null || TextUtils.isEmpty(searchQueryUrlString)) {
return null;
}
/* Parse the URL from the passed in String and perform the search */
try {
URL githubUrl = new URL(searchQueryUrlString);
String githubSearchResults = NetworkUtils.getResponseFromHttpUrl(githubUrl);
return githubSearchResults;
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
// COMPLETED (3) Override deliverResult and store the data in mGithubJson
// COMPLETED (4) Call super.deliverResult after storing the data
// @@7.2
@Override
public void deliverResult(String githubJson) {
mGithubJson = githubJson;
super.deliverResult(githubJson);
}
};
}
@Override
public void onLoadFinished(Loader<String> loader, String data) {
/* When we finish loading, we want to hide the loading indicator from the user. */
mLoadingIndicator.setVisibility(View.INVISIBLE);
/*
* If the results are null, we assume an error has occurred. There are much more robust
* methods for checking errors, but we wanted to keep this particular example simple.
*/
if (null == data) {
showErrorMessage();
} else {
mSearchResultsTextView.setText(data);
showJsonDataView();
}
}
@Override
public void onLoaderReset(Loader<String> loader) {
/*
* We aren't using this method in our example application, but we are required to Override
* it to implement the LoaderCallbacks<String> interface
*/
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getMenuInflater().inflate(R.menu.main, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
int itemThatWasClickedId = item.getItemId();
if (itemThatWasClickedId == R.id.action_search) {
makeGithubSearchQuery();
return true;
}
return super.onOptionsItemSelected(item);
}
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
String queryUrl = mUrlDisplayTextView.getText().toString();
outState.putString(SEARCH_QUERY_URL_EXTRA, queryUrl);
}
}