com.semartinez.projects.choppit.viewmodel

Class MainViewModel

java.lang.Object

androidx.lifecycle.ViewModel

androidx.lifecycle.AndroidViewModel

com.semartinez.projects.choppit.viewmodel.MainViewModel

All Implemented Interfaces:

LifecycleObserver

public class MainViewModel
extends AndroidViewModel
implements LifecycleObserver

Implementation of AndroidViewModel. MainViewModel handles asynchronous calls to RecipeRepository methods and contains various MutableLiveData fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MainViewModel.State

Constructor Summary

Constructors

Constructor and Description
MainViewModel(Application application) Initializes the MainViewModel and the variables it contains.

Method Summary

Modifier and Type	Method and Description
void	deleteRecipe(Recipe r)
void	finish(AssemblyRecipe data) Posts a completed Recipe and the final status value.
void	generateStrings() This method is called if makeItGo(String) completes successfully.
LiveData<List<Recipe>>	getAllRecipes()
LiveData<List<Ingredient>>	getIngredients()
LiveData<Recipe>	getRecipe()
String	getSharedUrl()
LiveData<MainViewModel.State>	getStatus()
LiveData<List<Step>>	getSteps()
LiveData<List<String>>	getStringsFromDocument()
LiveData<Throwable>	getThrowable()
void	loadRecipe(Long id) On success, posts a retrieved Recipe.
void	makeItGo(String url) This method is called by the LoadingFragment on navigation from the HomeFragment to begin processing.
void	processData(String ingredient, String instruction) This method is called by the SelectionFragment when navigating back to the LoadingFragment.
void	resetData() Returns all MutableLiveData values (except Status) to default to clear data from prior activities.
void	resetStatus() Returns Status to default to clear progress from prior activities.
void	saveRecipe(Recipe newRecipe)
void	setSharedUrl(String string)
void	updateRecipe(Recipe recipe)

Methods inherited from class androidx.lifecycle.AndroidViewModel

getApplication

Methods inherited from class androidx.lifecycle.ViewModel

onCleared

Methods inherited from class java.lang.Object

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

Constructor Detail

MainViewModel

public MainViewModel(@NonNull
                     Application application)

Initializes the MainViewModel and the variables it contains.

Parameters:

application - this application.

Method Detail

getAllRecipes

public LiveData<List<Recipe>> getAllRecipes()

Returns:

LiveData containing all Recipes returned from the database by RecipeRepository.getAll().

getRecipe

public LiveData<Recipe> getRecipe()

Returns:

LiveData containing a single Recipe.

getSteps

public LiveData<List<Step>> getSteps()

Returns:

LiveData containing a list of Steps.

getIngredients

public LiveData<List<Ingredient>> getIngredients()

Returns:

LiveData containing a list of Ingredients.

getStringsFromDocument

public LiveData<List<String>> getStringsFromDocument()

Returns:

LiveData containing a list of Strings

getStatus

public LiveData<MainViewModel.State> getStatus()

Returns:

LiveData containing a State.

getThrowable

public LiveData<Throwable> getThrowable()

Returns:

LiveData containing a Throwable

getSharedUrl

public String getSharedUrl()

Returns:

a URL received by an Android Intent.

setSharedUrl

public void setSharedUrl(String string)

Parameters:

string - a URL received by an Android Intent.

resetData

public void resetData()

Returns all MutableLiveData values (except Status) to default to clear data from prior activities.

resetStatus

public void resetStatus()

Returns Status to default to clear progress from prior activities.

makeItGo

public void makeItGo(String url)

This method is called by the LoadingFragment on navigation from the HomeFragment to begin processing. It passes the user's url to RecipeRepository.connect(java.lang.String), and notifies the Loading Fragment by posting status values as MutableLiveData. On success, calls generateStrings() and updates status. On failure, a Throwable is posted instead.

Parameters:

url - is taken from user input on the HomeFragment.

generateStrings

public void generateStrings()

This method is called if makeItGo(String) completes successfully. It calls RecipeRepository.generateStrings().

On success, post the resulting Strings as MutableLiveData and updates status. On failure, a Throwable is posted instead.

processData

public void processData(String ingredient,
                        String instruction)

This method is called by the SelectionFragment when navigating back to the LoadingFragment. It passes user-selected Strings to the backend to help identify what text should be extracted from the HTML.

On success, finish(AssemblyRecipe) is called and the next status value is posted. On failure, a Throwable is posted.

Parameters:

ingredient - user-selected ingredient text.

instruction - user-selected instruction text.

finish

public void finish(AssemblyRecipe data)

Posts a completed Recipe and the final status value.

Parameters:

data - a completed AssemblyRecipe.

saveRecipe

public void saveRecipe(Recipe newRecipe)

Parameters:

newRecipe - is a Recipe to be saved as a new database entity.

updateRecipe

public void updateRecipe(Recipe recipe)

Parameters:

recipe - is a Recipe to be updated in the database.

loadRecipe

public void loadRecipe(Long id)

On success, posts a retrieved Recipe. On failure, a Throwable is posted.

Parameters:

id - is a RecipeId passed by either the EditingFragment or RecipeFragment.

deleteRecipe

public void deleteRecipe(Recipe r)