com.semartinez.projects.choppit.model.entity

Class Recipe

java.lang.Object

androidx.databinding.BaseObservable

com.semartinez.projects.choppit.model.entity.Recipe

All Implemented Interfaces:

androidx.databinding.Observable

public class Recipe
extends androidx.databinding.BaseObservable

Recipe is the top-level entity in the database. It gets a non-editable url if it was loaded from a website. title, favorite and the lists of Steps and Ingredients can be customized by the user.

Nested Class Summary

Nested classes/interfaces inherited from interface androidx.databinding.Observable

androidx.databinding.Observable.OnPropertyChangedCallback

Constructor Summary

Constructors

Constructor and Description
Recipe()
Recipe(AssemblyRecipe data) This constructor creates a Recipe Entity from the data gathered and processed by Jsoup
Recipe(RecipePojo recipePojo) This constructor recreates a Recipe entity from the RecipePojo data returned by a database query.

Method Summary

Modifier and Type	Method and Description
static Recipe	getEmptyRecipe()
List<Ingredient>	getIngredients()
long	getRecipeId()
List<Step>	getSteps()
@NotNull String	getTitle() This getter is marked Bindable for Data Binding to the EditingFragment.
String	getUrl()
boolean	isFavorite() This getter is marked Bindable for Data Binding to the EditingFragment.
static Recipe[]	populateData() This array populates the database with dummy Recipes.
void	setFavorite(boolean favorite)
void	setIngredient(Ingredient ingredient)
void	setIngredients(List<Ingredient> ingredients)
void	setRecipeId(long recipeId)
void	setStep(Step step)
void	setSteps(List<Step> steps)
void	setTitle(@NotNull String title)
void	setUrl(String url)
String	toString()

Methods inherited from class androidx.databinding.BaseObservable

addOnPropertyChangedCallback, notifyChange, notifyPropertyChanged, removeOnPropertyChangedCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

Recipe

public Recipe()

Recipe

public Recipe(RecipePojo recipePojo)

This constructor recreates a Recipe entity from the RecipePojo data returned by a database query.

Parameters:

recipePojo - is returned by RecipeDao.loadRecipeData(long).

Recipe

public Recipe(AssemblyRecipe data)

This constructor creates a Recipe Entity from the data gathered and processed by Jsoup

Parameters:

data - is the completed AssemblyRecipe that results from scraping and processing HTML.

Method Detail

getRecipeId

public long getRecipeId()

Returns:

the RecipeId.

setRecipeId

public void setRecipeId(long recipeId)

Parameters:

recipeId - is generated when a recipe is inserted into the database.

getUrl

public String getUrl()

Returns:

the URL of the site the Recipe was created from.

setUrl

public void setUrl(String url)

Parameters:

url - is set when a recipe is created from a URL.

getTitle

@NotNull
public @NotNull String getTitle()

This getter is marked Bindable for Data Binding to the EditingFragment.

Returns:

the title of the Recipe.

setTitle

public void setTitle(@NotNull
                     @NotNull String title)

Parameters:

title - is set by the user in the EditingFragment.

isFavorite

public boolean isFavorite()

This getter is marked Bindable for Data Binding to the EditingFragment.

Returns:

if the user has marked the Recipe as a favorite.

setFavorite

public void setFavorite(boolean favorite)

Parameters:

favorite - is set by the user in the CookbookFragment.

getSteps

public List<Step> getSteps()

Returns:

the list of Steps in the recipe.

setSteps

public void setSteps(List<Step> steps)

Parameters:

steps - is a new list of Steps.

setStep

public void setStep(Step step)

Parameters:

step - is a single new Step

getIngredients

public List<Ingredient> getIngredients()

Returns:

the list of Ingredients.

setIngredients

public void setIngredients(List<Ingredient> ingredients)

Parameters:

ingredients - is a new list of Ingredients.

setIngredient

public void setIngredient(Ingredient ingredient)

Parameters:

ingredient - is a single new Ingredient.

getEmptyRecipe

public static Recipe getEmptyRecipe()

Returns:

a Recipe with empty or default fields.

toString

@NonNull
public String toString()

Overrides:

toString in class Object

Returns:

the title of the Recipe.

populateData

public static Recipe[] populateData()

This array populates the database with dummy Recipes.

Returns:

a list of dummy Recipes.