edu.cnm.deepdive.smartcheff.service

Class RecipeRepository

java.lang.Object

edu.cnm.deepdive.smartcheff.service.RecipeRepository

public class RecipeRepository
extends Object

This class holds the logic for the queries to the SmartCheff database involving a recipe.

Constructor Summary

Constructors

Constructor and Description
RecipeRepository(Context context) This is the constructor for the RecipeRepository.

Method Summary

Modifier and Type	Method and Description
Completable	delete(Recipe recipe) This is the method used to delete a recipe from the SmartCheff database.
LiveData<List<Recipe>>	findById(Recipe id) This method finds a recipe by id.
LiveData<Recipe>	findByName(Recipe name) This is the method used to find a recipe by name.
LiveData<List<Recipe>>	findRecipeUsingIngredient(Recipe id) This method is used to find a recipe the uses specific ingredients.
LiveData<List<Recipe>>	getAll() This method is used to get all the recipes in the SmartCheff database.
Single<RecipeDto>	retrieve(long id) This method makes a request to the api service using the recipes id to get all the details of the recipe.
Completable	save(Recipe recipe) This is the method used to save a recipe to the SmartCheff database.
Single<List<RecipeDto>>	search(Collection<String> ingredients) This method makes a request to the api service using ingredients to find recipes.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipeRepository

public RecipeRepository(Context context)

This is the constructor for the RecipeRepository.

Parameters:

context - is reference to a Context object.

Method Detail

save

public Completable save(Recipe recipe)

This is the method used to save a recipe to the SmartCheff database.

Parameters:

recipe - is a reference to a Recipe object.

Returns:

a saved recipe.

delete

public Completable delete(Recipe recipe)

This is the method used to delete a recipe from the SmartCheff database.

Parameters:

recipe - is a reference to a Recipe object.

Returns:

a deleted recipe.

getAll

public LiveData<List<Recipe>> getAll()

This method is used to get all the recipes in the SmartCheff database.

Returns:

recipes.

findByName

public LiveData<Recipe> findByName(Recipe name)

This is the method used to find a recipe by name.

Parameters:

name - is the name of a recipe.

Returns:

a recipe.

findRecipeUsingIngredient

public LiveData<List<Recipe>> findRecipeUsingIngredient(Recipe id)

This method is used to find a recipe the uses specific ingredients.

Parameters:

id - is the primary key of a recipe.

Returns:

a recipe.

findById

public LiveData<List<Recipe>> findById(Recipe id)

This method finds a recipe by id.

Parameters:

id - is the primary key of a recipe.

Returns:

a recipe.

search

public Single<List<RecipeDto>> search(Collection<String> ingredients)

This method makes a request to the api service using ingredients to find recipes.

Parameters:

ingredients - is the ingredients inputted by the user.

Returns:

a collection of recipes

retrieve

public Single<RecipeDto> retrieve(long id)

This method makes a request to the api service using the recipes id to get all the details of the recipe.

Parameters:

id - is the id of a recipe.

Returns:

details of a recipe.