Package com.tccc.kos.ext.freestyle.service.brandset.beans

Class Ingredient

java.lang.Object

com.tccc.kos.ext.dispense.service.ingredient.BaseIngredient

com.tccc.kos.ext.freestyle.service.brandset.beans.Ingredient

All Implemented Interfaces:

Cloneable

public class Ingredient
extends com.tccc.kos.ext.dispense.service.ingredient.BaseIngredient
implements Cloneable

This defines the characteristics of a single ingredient. This bean matches the Ingredients table in the master recipe database.

Since:

1.0

Version:

Apr-6-17

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMBIENT_WATER
static final String	CARB
static final String	FIS
static final String	HFCS
static final String	K5
static final String	NNS
static final String	NNS_BIB
static final String	ORANGE_GBR2
static final String	ORANGE_V2
static final String	SANITIZER_A
static final String	SANITIZER_B
static final String	TYPE_BIB
static final String	TYPE_MICRODOSE
static final String	WATER

Constructor Summary

Constructors

Constructor	Description
Ingredient()

Method Summary

Modifier and Type	Method	Description
Object	clone()
int	getChangeOutRule(String toIngredientId, int defaultRule)	Return the change out rule for switching to the specified ingredientId.
String	getDisplayName()
Date	getEnjoyByDateFromExpirationDate(Date expDate)	Given an expiration date, subtract the ingredient defined offset to return the enjoy by date.
Date	getExpirationDateFromEnjoyByDate(Date enjoyByDate)	Given an enjoy by date, add the ingredient defined offset to return the actual expiration date.
static boolean	isFIS(String ingredientId)	return true if the specified ingredientId is FIS
static boolean	isHFCS(String ingredientId)	return true if the specified ingredientId is HFCS
boolean	isMicro()	Return true if the ingredient is a micro ingredient.
static boolean	isNNS(String ingredientId)	return true if the specified ingredientId is NNS
static boolean	isNS(String ingredientId)	return true if the specified ingredientId is NS
static boolean	isSanitizer(String ingredientId)	Return true if the specified ingredientId is sanitizer.
static boolean	isSweetener(String ingredientId)	Return true if the specified ingredientId is a type of sweetener.
static boolean	isWater(String ingredientId)	Return true if the specified ingredientId is a type of water.

Methods inherited from class com.tccc.kos.ext.dispense.service.ingredient.BaseIngredient

getId, getName, getSource, getSourceId, getType, setId, setName, setType

Methods inherited from class java.lang.Object

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

Field Details

K5

public static final String K5

See Also:

• Constant Field Values

SANITIZER_A

public static final String SANITIZER_A

See Also:

• Constant Field Values

SANITIZER_B

public static final String SANITIZER_B

See Also:

• Constant Field Values

WATER

public static final String WATER

See Also:

• Constant Field Values

CARB

public static final String CARB

See Also:

• Constant Field Values

AMBIENT_WATER

public static final String AMBIENT_WATER

See Also:

• Constant Field Values

NNS_BIB

public static final String NNS_BIB

See Also:

• Constant Field Values

NNS

public static final String NNS

See Also:

• Constant Field Values

HFCS

public static final String HFCS

See Also:

• Constant Field Values

FIS

public static final String FIS

See Also:

• Constant Field Values

ORANGE_V2

public static final String ORANGE_V2

See Also:

• Constant Field Values

ORANGE_GBR2

public static final String ORANGE_GBR2

See Also:

• Constant Field Values

TYPE_MICRODOSE

public static final String TYPE_MICRODOSE

See Also:

• Constant Field Values

TYPE_BIB

public static final String TYPE_BIB

See Also:

• Constant Field Values

Constructor Details

Ingredient

public Ingredient()

Method Details

getDisplayName

public String getDisplayName()

isWater

public static boolean isWater(String ingredientId)

Return true if the specified ingredientId is a type of water.

Parameters:

ingredientId - the ingredientId to check

isSweetener

public static boolean isSweetener(String ingredientId)

Return true if the specified ingredientId is a type of sweetener.

Parameters:

ingredientId - the ingredientId to check

isSanitizer

public static boolean isSanitizer(String ingredientId)

Return true if the specified ingredientId is sanitizer.

Parameters:

ingredientId - the ingredientId to check

isHFCS

public static boolean isHFCS(String ingredientId)

return true if the specified ingredientId is HFCS

Parameters:

ingredientId - the ingredientId to check

isFIS

public static boolean isFIS(String ingredientId)

return true if the specified ingredientId is FIS

Parameters:

ingredientId - the ingredientId to check

isNS

public static boolean isNS(String ingredientId)

return true if the specified ingredientId is NS

Parameters:

ingredientId - the ingredientId to check

isNNS

public static boolean isNNS(String ingredientId)

return true if the specified ingredientId is NNS

Parameters:

ingredientId - the ingredientId to check

isMicro

public boolean isMicro()

Return true if the ingredient is a micro ingredient.

getChangeOutRule

public int getChangeOutRule(String toIngredientId,
 int defaultRule)

Return the change out rule for switching to the specified ingredientId. Returns the rule, or the default if no rule was found.

Parameters:

toIngredientId - the ingredient to switch to

defaultRule - the default to return if no rule is found

Returns:

the matching rule (ChangeOutRule.VAL)

getExpirationDateFromEnjoyByDate

public Date getExpirationDateFromEnjoyByDate(Date enjoyByDate)

Given an enjoy by date, add the ingredient defined offset to return the actual expiration date.

Parameters:

enjoyByDate - the enjoy by date for the ingredient

Returns:

the expiration date

getEnjoyByDateFromExpirationDate

public Date getEnjoyByDateFromExpirationDate(Date expDate)

Given an expiration date, subtract the ingredient defined offset to return the enjoy by date.

Parameters:

expDate - the expiration date for the ingredient

Returns:

the enjoy by date

clone

public Object clone()
             throws CloneNotSupportedException

Throws:

CloneNotSupportedException