fi.group6.dessertrecipeapp.classes

Class RecipeDao

java.lang.Object

fi.group6.dessertrecipeapp.classes.RecipeDao

public abstract class RecipeDao
extends java.lang.Object

Data access object class RecipeDao provides methods for app to use to query, insert, update, and delete data in the database

Constructor Summary

Constructors

Constructor and Description
RecipeDao()

Method Summary

Modifier and Type	Method and Description
abstract void	addRecipeToFavorites(int recipeId) This function to add a recipe which has is_favourite = 1 to Favourites
abstract int	countFavoriteRecipes() This function to count favourite recipes where is_favourite = 1
abstract int	countIngredients(int uid) This function to count ingredients in a recipe;
abstract int	countLocalRecipes() This function to count local recipes where is_custom = 1
abstract int	countRecipes() This function to count recipes
abstract void	deleteIngredient(Ingredient ingredient) This function to delete an ingredient
abstract void	deleteRecipe(Recipe recipe) This function to delete a recipe
abstract void	deleteRecipeFromFavorites(int recipeId) This function is used to delete a recipe which has is_favourite = 0 from Favourites
abstract void	deleteRecipeWithIngredients(Recipe recipe, java.util.List<Ingredient> ingredients) This function to delete recipe with all ingredients.
abstract java.util.List<Ingredient>	getAllIngredients() This function to get all ingredients
abstract java.util.List<Recipe>	getAllRecipes() This function is to get a all recipes as a list
abstract java.util.List<RecipeWithIngredients>	getFavoriteRecipeWithIngredients() This function to get list of Favourite recipes with ingredients
abstract java.util.List<Ingredient>	getIngredientsById(int uid) This function to get list of ingredients by using recipeId
abstract java.util.List<RecipeWithIngredients>	getLocalRecipeWithIngredients() This function to get list of local recipes with ingredients
abstract java.util.List<RecipeWithIngredients>	getPremadeRecipeWithIngredients() This function to get list of pre-made recipes with ingredients
abstract Recipe	getRecipeById(int uid) This function to get a recipe by its Id.
abstract java.util.List<RecipeWithIngredients>	getRecipeWithIngredients() This method returns all recipes with its ingredients
abstract RecipeWithIngredients	getRecipeWithIngredientsByRecipeId(int recipeId) This function to search for recipe by its Id
abstract void	insertAllIngredients(java.util.List<Ingredient> ingredients) This function to insert all ingredients for the List of ingredients
abstract void	insertIngredient(Ingredient ingredient) This function to insert ingredient
abstract long	insertRecipe(Recipe recipe) This function to insert recipe
void	insertRecipeWithIngredients(Recipe recipe, java.util.List<Ingredient> ingredients) This is a priority function.
abstract java.util.List<Recipe>	searchRecipeByName(java.lang.String search) This function to search for a recipe by its name.
abstract java.util.List<RecipeWithIngredients>	searchRecipeWithIngredientsByName(java.lang.String search) This function to search for a recipe by its name.
abstract void	updateIngredient(Ingredient Ingredient) This function is for update ingredient
abstract void	updateIngredientWithRecipe(Recipe recipe, java.util.List<Ingredient> ingredients) This function is for update all ingredients with corresponding recipe
abstract void	updateRecipe(Recipe recipe) This function is for update a recipe

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipeDao

public RecipeDao()

Method Detail

countRecipes

public abstract int countRecipes()

This function to count recipes

Returns:

number of recipes

countLocalRecipes

public abstract int countLocalRecipes()

This function to count local recipes where is_custom = 1

Returns:

number of local recipes

countFavoriteRecipes

public abstract int countFavoriteRecipes()

This function to count favourite recipes where is_favourite = 1

Returns:

number of favourite recipes

countIngredients

public abstract int countIngredients(int uid)

This function to count ingredients in a recipe;

Returns:

number of ingredients

getAllRecipes

public abstract java.util.List<Recipe> getAllRecipes()

This function is to get a all recipes as a list

Returns:

List list of recipe

getRecipeWithIngredients

public abstract java.util.List<RecipeWithIngredients> getRecipeWithIngredients()

This method returns all recipes with its ingredients

Returns:

List of recipes with its ingredients

getPremadeRecipeWithIngredients

public abstract java.util.List<RecipeWithIngredients> getPremadeRecipeWithIngredients()

This function to get list of pre-made recipes with ingredients

Returns:

List list of recipe (is_custom = 0) with ingredients

getLocalRecipeWithIngredients

public abstract java.util.List<RecipeWithIngredients> getLocalRecipeWithIngredients()

This function to get list of local recipes with ingredients

Returns:

List list of recipe (is_custom = 1) with ingredients

getFavoriteRecipeWithIngredients

public abstract java.util.List<RecipeWithIngredients> getFavoriteRecipeWithIngredients()

This function to get list of Favourite recipes with ingredients

Returns:

List list of recipe (is_favourite = 1) with ingredients

getAllIngredients

public abstract java.util.List<Ingredient> getAllIngredients()

This function to get all ingredients

Returns:

List all ingredients

getIngredientsById

public abstract java.util.List<Ingredient> getIngredientsById(int uid)

This function to get list of ingredients by using recipeId

Parameters:

uid - recipeId of the attached recipe

Returns:

List

insertRecipe

public abstract long insertRecipe(Recipe recipe)

This function to insert recipe

Parameters:

recipe - Recipe to insert

Returns:

recipeId

insertIngredient

public abstract void insertIngredient(Ingredient ingredient)

This function to insert ingredient

Parameters:

ingredient - Ingredient to insert

insertAllIngredients

public abstract void insertAllIngredients(java.util.List<Ingredient> ingredients)

This function to insert all ingredients for the List of ingredients

Parameters:

ingredients - List of ingredients to insert

insertRecipeWithIngredients

public void insertRecipeWithIngredients(Recipe recipe,
                                        java.util.List<Ingredient> ingredients)

This is a priority function. It inserts recipe with all ingredients. For each ingredient, recipeId will be identified to match with the recipe it belongs to.

Parameters:

recipe - Recipe to insert

ingredients - List of ingredients to attach to that recipe and insert

deleteRecipe

public abstract void deleteRecipe(Recipe recipe)

This function to delete a recipe

Parameters:

recipe - Recipe to delete

deleteIngredient

public abstract void deleteIngredient(Ingredient ingredient)

This function to delete an ingredient

Parameters:

ingredient - Ingredients to delete

deleteRecipeWithIngredients

public abstract void deleteRecipeWithIngredients(Recipe recipe,
                                                 java.util.List<Ingredient> ingredients)

This function to delete recipe with all ingredients.

Parameters:

recipe - Recipe to delete

ingredients - List of ingredients to delete

getRecipeById

public abstract Recipe getRecipeById(int uid)

This function to get a recipe by its Id.

Parameters:

uid - id of the recipe

Returns:

the recipe with Id correspondingly

searchRecipeByName

public abstract java.util.List<Recipe> searchRecipeByName(java.lang.String search)

This function to search for a recipe by its name.

Parameters:

search - Name to search for

Returns:

a list of recipes with names where search keyword is present(anywhere in the name)

searchRecipeWithIngredientsByName

public abstract java.util.List<RecipeWithIngredients> searchRecipeWithIngredientsByName(java.lang.String search)

This function to search for a recipe by its name.

Parameters:

search - Name to search for

Returns:

a list of recipes with names and all of its ingredients where search keyword is present(anywhere in the name)

getRecipeWithIngredientsByRecipeId

public abstract RecipeWithIngredients getRecipeWithIngredientsByRecipeId(int recipeId)

This function to search for recipe by its Id

Parameters:

recipeId - recipeId to search for

Returns:

recipe with its ingredients

addRecipeToFavorites

public abstract void addRecipeToFavorites(int recipeId)

This function to add a recipe which has is_favourite = 1 to Favourites

Parameters:

recipeId - recipeId of a recipe to update

deleteRecipeFromFavorites

public abstract void deleteRecipeFromFavorites(int recipeId)

This function is used to delete a recipe which has is_favourite = 0 from Favourites

Parameters:

recipeId - recipeId of a recipe to update

updateRecipe

public abstract void updateRecipe(Recipe recipe)

This function is for update a recipe

Parameters:

recipe - Recipe to update

updateIngredient

public abstract void updateIngredient(Ingredient Ingredient)

This function is for update ingredient

Parameters:

Ingredient - Ingredient to update

updateIngredientWithRecipe

public abstract void updateIngredientWithRecipe(Recipe recipe,
                                                java.util.List<Ingredient> ingredients)

This function is for update all ingredients with corresponding recipe

Parameters:

recipe - Recipe to update

ingredients - Ingredients to update