com.brein.api

Class BreinRecommendation

java.lang.Object

com.brein.api.BreinBase<BreinRecommendation>

com.brein.api.BreinRecommendation

All Implemented Interfaces:

IExecutable<BreinRecommendationResult>, ISecretStrategy

public class BreinRecommendation
extends BreinBase<BreinRecommendation>
implements IExecutable<BreinRecommendationResult>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_REC_ADDITIONAL_PARAMETERS
static java.lang.String	ATTR_REC_AT_TIME
static java.lang.String	ATTR_REC_CATEGORIES
static java.lang.String	ATTR_REC_CATEGORIES_BLACKLISTED
static java.lang.String	ATTR_REC_DISABLE_CACHE
static java.lang.String	ATTR_REC_FOR_ITEMS
static java.lang.String	ATTR_REC_MIN_QUANTITY
static java.lang.String	ATTR_REC_NUM_RESULTS
static java.lang.String	ATTR_REC_QUERY_NAME
static java.lang.String	ATTR_REC_SUB_BLOCKERS
static java.lang.String	ATTR_REC_SUB_INHIBITORS
static java.lang.String	ATTR_REC_SUB_RECOMMENDERS
static java.lang.String	ATTR_REC_UNTIL_TIME
static int	DEF_NUM_RESULTS
static java.lang.String	SUB_RECOMMENDER_CUSTOM_SORT Recommends items that have are ordered through some config-defined manner
static java.lang.String	SUB_RECOMMENDER_POPULAR_ITEMS Recommends items based on the currently popular items
static java.lang.String	SUB_RECOMMENDER_RECENTLY_PURCHASED Recommends previously purchased items
static java.lang.String	SUB_RECOMMENDER_SIMILAR_ITEMS Recommends a user items that are similar to what they previously interacted with
static java.lang.String	SUB_RECOMMENDER_TEMPORAL Recommends items that have historically trended during similar times
static java.lang.String	SUB_RECOMMENDER_USERS_LIKE_YOU Recommends items that similar users have bought

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, IP_ADDRESS, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinRecommendation()

Method Summary

Modifier and Type	Method and Description
BreinRecommendation	addRecommendationRequest(java.lang.String name, java.lang.Object value)
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Generates the signature for the request
BreinRecommendationResult	execute() Method to execute the request synchronous.
java.util.List<java.lang.String>	getBlockers()
java.util.List<java.lang.String>	getCategories() get the recommendation category
java.util.List<java.lang.String>	getCategoriesBlacklist() gets categories that should not be returned
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
java.util.List<java.lang.String>	getItemToItemRecs()
java.lang.Double	getMinQuantity()
int	getNumberOfRecommendations() get the number of recommendations
long	getRecEndTime()
java.util.Map<java.lang.String,java.lang.Object>	getRecommendationAdditionalParameters()
java.lang.String	getRecommendationQueryName()
java.util.Map<java.lang.String,java.lang.Object>	getRecommendationRequest()
long	getRecStartTime()
java.util.List<java.lang.String>	getSubInhibitors()
java.util.List<java.lang.String>	getSubRecommenders()
boolean	isDisableCaching() Should this request disable caching?
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
BreinRecommendation	setBlockers(java.util.List<java.lang.String> blockers)
BreinRecommendation	setCategories(java.lang.String... category) set the recommendation category
BreinRecommendation	setCategoriesBlacklist(java.lang.String... category) set the categories that should not be returned
BreinRecommendation	setDisableCaching(boolean disableCaching) Set if we want to disable caching
BreinRecommendation	setItemToItemRecs(java.util.List<java.lang.String> itemToItemRecs)
BreinRecommendation	setMinQuantity(java.lang.Double minQuantity)
BreinRecommendation	setNumberOfRecommendations(int numberOfRecommendations) set the number of recommendations
BreinRecommendation	setRecEndTime(long recEndTime)
BreinRecommendation	setRecommendationAdditionalParameters(java.util.Map<java.lang.String,java.lang.Object> params)
BreinRecommendation	setRecommendationQueryName(java.lang.String recommendationQueryName)
BreinRecommendation	setRecommendationRequest(java.util.Map<java.lang.String,java.lang.Object> recommendationRequest)
BreinRecommendation	setRecStartTime(long recStartTime)
BreinRecommendation	setSubInhibitors(java.util.List<java.lang.String> subInhibitors)
BreinRecommendation	setSubRecommenders(java.util.List<java.lang.String> subRecommenders)
BreinRecommendation	setSubRecommenders(java.lang.String... subRecomenders)

Methods inherited from class com.brein.api.BreinBase

getClientIpAddress, getGson, getHeaders, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setHeader, setHeaders, setUnixTimestamp, setUser, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEF_NUM_RESULTS

public static final int DEF_NUM_RESULTS

See Also:

Constant Field Values

ATTR_REC_CATEGORIES

public static final java.lang.String ATTR_REC_CATEGORIES

See Also:

Constant Field Values

ATTR_REC_CATEGORIES_BLACKLISTED

public static final java.lang.String ATTR_REC_CATEGORIES_BLACKLISTED

See Also:

Constant Field Values

ATTR_REC_SUB_RECOMMENDERS

public static final java.lang.String ATTR_REC_SUB_RECOMMENDERS

See Also:

Constant Field Values

ATTR_REC_SUB_INHIBITORS

public static final java.lang.String ATTR_REC_SUB_INHIBITORS

See Also:

Constant Field Values

ATTR_REC_SUB_BLOCKERS

public static final java.lang.String ATTR_REC_SUB_BLOCKERS

See Also:

Constant Field Values

ATTR_REC_AT_TIME

public static final java.lang.String ATTR_REC_AT_TIME

See Also:

Constant Field Values

ATTR_REC_UNTIL_TIME

public static final java.lang.String ATTR_REC_UNTIL_TIME

See Also:

Constant Field Values

ATTR_REC_DISABLE_CACHE

public static final java.lang.String ATTR_REC_DISABLE_CACHE

See Also:

Constant Field Values

ATTR_REC_FOR_ITEMS

public static final java.lang.String ATTR_REC_FOR_ITEMS

See Also:

Constant Field Values

ATTR_REC_QUERY_NAME

public static final java.lang.String ATTR_REC_QUERY_NAME

See Also:

Constant Field Values

ATTR_REC_MIN_QUANTITY

public static final java.lang.String ATTR_REC_MIN_QUANTITY

See Also:

Constant Field Values

ATTR_REC_NUM_RESULTS

public static final java.lang.String ATTR_REC_NUM_RESULTS

See Also:

Constant Field Values

ATTR_REC_ADDITIONAL_PARAMETERS

public static final java.lang.String ATTR_REC_ADDITIONAL_PARAMETERS

See Also:

Constant Field Values

SUB_RECOMMENDER_SIMILAR_ITEMS

public static final java.lang.String SUB_RECOMMENDER_SIMILAR_ITEMS

Recommends a user items that are similar to what they previously interacted with

See Also:

Constant Field Values

SUB_RECOMMENDER_POPULAR_ITEMS

public static final java.lang.String SUB_RECOMMENDER_POPULAR_ITEMS

Recommends items based on the currently popular items

See Also:

Constant Field Values

SUB_RECOMMENDER_USERS_LIKE_YOU

public static final java.lang.String SUB_RECOMMENDER_USERS_LIKE_YOU

Recommends items that similar users have bought

See Also:

Constant Field Values

SUB_RECOMMENDER_RECENTLY_PURCHASED

public static final java.lang.String SUB_RECOMMENDER_RECENTLY_PURCHASED

Recommends previously purchased items

See Also:

Constant Field Values

SUB_RECOMMENDER_TEMPORAL

public static final java.lang.String SUB_RECOMMENDER_TEMPORAL

Recommends items that have historically trended during similar times

See Also:

Constant Field Values

SUB_RECOMMENDER_CUSTOM_SORT

public static final java.lang.String SUB_RECOMMENDER_CUSTOM_SORT

Recommends items that have are ordered through some config-defined manner

See Also:

Constant Field Values

Constructor Detail

BreinRecommendation

public BreinRecommendation()

Method Detail

getRecommendationRequest

public java.util.Map<java.lang.String,java.lang.Object> getRecommendationRequest()

setRecommendationRequest

public BreinRecommendation setRecommendationRequest(java.util.Map<java.lang.String,java.lang.Object> recommendationRequest)

addRecommendationRequest

public BreinRecommendation addRecommendationRequest(java.lang.String name,
                                                    java.lang.Object value)

getNumberOfRecommendations

public int getNumberOfRecommendations()

get the number of recommendations

Returns:

number

setNumberOfRecommendations

public BreinRecommendation setNumberOfRecommendations(int numberOfRecommendations)

set the number of recommendations

Parameters:

numberOfRecommendations - number of recommendations

Returns:

self

getCategories

public java.util.List<java.lang.String> getCategories()

get the recommendation category

Returns:

category

setCategories

public BreinRecommendation setCategories(java.lang.String... category)

set the recommendation category

Parameters:

category - contains the category

Returns:

self

getCategoriesBlacklist

public java.util.List<java.lang.String> getCategoriesBlacklist()

gets categories that should not be returned

Returns:

the blacklisted categories

setCategoriesBlacklist

public BreinRecommendation setCategoriesBlacklist(java.lang.String... category)

set the categories that should not be returned

Parameters:

category - the blacklisted categories

Returns:

self

setSubRecommenders

public BreinRecommendation setSubRecommenders(java.util.List<java.lang.String> subRecommenders)

setSubRecommenders

public BreinRecommendation setSubRecommenders(java.lang.String... subRecomenders)

getSubRecommenders

public java.util.List<java.lang.String> getSubRecommenders()

setMinQuantity

public BreinRecommendation setMinQuantity(java.lang.Double minQuantity)

getMinQuantity

public java.lang.Double getMinQuantity()

isDisableCaching

public boolean isDisableCaching()

Should this request disable caching?

Returns:

if caching should be disabled

setDisableCaching

public BreinRecommendation setDisableCaching(boolean disableCaching)

Set if we want to disable caching

Parameters:

disableCaching - the caching state

getRecStartTime

public long getRecStartTime()

Returns:

When recommendations should start

setRecStartTime

public BreinRecommendation setRecStartTime(long recStartTime)

Parameters:

recStartTime - When recommendations should start

getRecEndTime

public long getRecEndTime()

Returns:

When recommendations should end

setRecEndTime

public BreinRecommendation setRecEndTime(long recEndTime)

Parameters:

recEndTime - When recommendations should end

getItemToItemRecs

public java.util.List<java.lang.String> getItemToItemRecs()

Returns:

Items for an item(s) to items recommendation

setItemToItemRecs

public BreinRecommendation setItemToItemRecs(java.util.List<java.lang.String> itemToItemRecs)

Parameters:

itemToItemRecs - the item(s) that an item to item recommendation should be done for

getRecommendationQueryName

public java.lang.String getRecommendationQueryName()

setRecommendationQueryName

public BreinRecommendation setRecommendationQueryName(java.lang.String recommendationQueryName)

execute

public BreinRecommendationResult execute()

Description copied from interface: IExecutable

Method to execute the request synchronous.

Specified by:

execute in interface IExecutable<BreinRecommendationResult>

Returns:

the returned value

getSubInhibitors

public java.util.List<java.lang.String> getSubInhibitors()

setSubInhibitors

public BreinRecommendation setSubInhibitors(java.util.List<java.lang.String> subInhibitors)

getBlockers

public java.util.List<java.lang.String> getBlockers()

setBlockers

public BreinRecommendation setBlockers(java.util.List<java.lang.String> blockers)

getRecommendationAdditionalParameters

public java.util.Map<java.lang.String,java.lang.Object> getRecommendationAdditionalParameters()

setRecommendationAdditionalParameters

public BreinRecommendation setRecommendationAdditionalParameters(java.util.Map<java.lang.String,java.lang.Object> params)

getEndPoint

public java.lang.String getEndPoint(BreinConfig config)

Description copied from class: BreinBase

Gets the endpoint to be used to send the request to

Specified by:

getEndPoint in class BreinBase<BreinRecommendation>

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

prepareRequestData

public void prepareRequestData(BreinConfig config,
                               java.util.Map<java.lang.String,java.lang.Object> requestData)

Description copied from class: BreinBase

This method adds the request specific information to the requestData. It is called by BreinBase.prepareRequestData(BreinConfig) after the request data of the base information is added.

Specified by:

prepareRequestData in class BreinBase<BreinRecommendation>

requestData - the request data to be sent to the endpoint

createSignature

public java.lang.String createSignature(BreinConfig config,
                                        java.util.Map<java.lang.String,java.lang.Object> requestData)

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Parameters:

config - the configuration

requestData - the data used for the request including all the data that will be sent, without the signature

Returns:

full signature