public class BreinRecommendation extends BreinBase<BreinRecommendation> implements IExecutable<BreinRecommendationResult>
| 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
|
API_KEY_FIELD, GSON, IP_ADDRESS, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD| Constructor and Description |
|---|
BreinRecommendation() |
| 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) |
getClientIpAddress, getGson, getHeaders, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setHeader, setHeaders, setUnixTimestamp, setUser, setUser, setUser, toStringpublic static final int DEF_NUM_RESULTS
public static final java.lang.String ATTR_REC_CATEGORIES
public static final java.lang.String ATTR_REC_CATEGORIES_BLACKLISTED
public static final java.lang.String ATTR_REC_SUB_RECOMMENDERS
public static final java.lang.String ATTR_REC_SUB_INHIBITORS
public static final java.lang.String ATTR_REC_SUB_BLOCKERS
public static final java.lang.String ATTR_REC_AT_TIME
public static final java.lang.String ATTR_REC_UNTIL_TIME
public static final java.lang.String ATTR_REC_DISABLE_CACHE
public static final java.lang.String ATTR_REC_FOR_ITEMS
public static final java.lang.String ATTR_REC_QUERY_NAME
public static final java.lang.String ATTR_REC_MIN_QUANTITY
public static final java.lang.String ATTR_REC_NUM_RESULTS
public static final java.lang.String ATTR_REC_ADDITIONAL_PARAMETERS
public static final java.lang.String SUB_RECOMMENDER_SIMILAR_ITEMS
public static final java.lang.String SUB_RECOMMENDER_POPULAR_ITEMS
public static final java.lang.String SUB_RECOMMENDER_USERS_LIKE_YOU
public static final java.lang.String SUB_RECOMMENDER_RECENTLY_PURCHASED
public static final java.lang.String SUB_RECOMMENDER_TEMPORAL
public static final java.lang.String SUB_RECOMMENDER_CUSTOM_SORT
public java.util.Map<java.lang.String,java.lang.Object> getRecommendationRequest()
public BreinRecommendation setRecommendationRequest(java.util.Map<java.lang.String,java.lang.Object> recommendationRequest)
public BreinRecommendation addRecommendationRequest(java.lang.String name, java.lang.Object value)
public int getNumberOfRecommendations()
public BreinRecommendation setNumberOfRecommendations(int numberOfRecommendations)
numberOfRecommendations - number of recommendationspublic java.util.List<java.lang.String> getCategories()
public BreinRecommendation setCategories(java.lang.String... category)
category - contains the categorypublic java.util.List<java.lang.String> getCategoriesBlacklist()
public BreinRecommendation setCategoriesBlacklist(java.lang.String... category)
category - the blacklisted categoriespublic BreinRecommendation setSubRecommenders(java.util.List<java.lang.String> subRecommenders)
public BreinRecommendation setSubRecommenders(java.lang.String... subRecomenders)
public java.util.List<java.lang.String> getSubRecommenders()
public BreinRecommendation setMinQuantity(java.lang.Double minQuantity)
public java.lang.Double getMinQuantity()
public boolean isDisableCaching()
public BreinRecommendation setDisableCaching(boolean disableCaching)
disableCaching - the caching statepublic long getRecStartTime()
public BreinRecommendation setRecStartTime(long recStartTime)
recStartTime - When recommendations should startpublic long getRecEndTime()
public BreinRecommendation setRecEndTime(long recEndTime)
recEndTime - When recommendations should endpublic java.util.List<java.lang.String> getItemToItemRecs()
public BreinRecommendation setItemToItemRecs(java.util.List<java.lang.String> itemToItemRecs)
itemToItemRecs - the item(s) that an item to item recommendation should be done forpublic java.lang.String getRecommendationQueryName()
public BreinRecommendation setRecommendationQueryName(java.lang.String recommendationQueryName)
public BreinRecommendationResult execute()
IExecutableexecute in interface IExecutable<BreinRecommendationResult>public java.util.List<java.lang.String> getSubInhibitors()
public BreinRecommendation setSubInhibitors(java.util.List<java.lang.String> subInhibitors)
public java.util.List<java.lang.String> getBlockers()
public BreinRecommendation setBlockers(java.util.List<java.lang.String> blockers)
public java.util.Map<java.lang.String,java.lang.Object> getRecommendationAdditionalParameters()
public BreinRecommendation setRecommendationAdditionalParameters(java.util.Map<java.lang.String,java.lang.Object> params)
public java.lang.String getEndPoint(BreinConfig config)
BreinBasegetEndPoint in class BreinBase<BreinRecommendation>config - the current configurationBreinConfigpublic void prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData)
BreinBaserequestData. It is called by BreinBase.prepareRequestData(BreinConfig) after the request data of the base information is added.prepareRequestData in class BreinBase<BreinRecommendation>requestData - the request data to be sent to the endpointpublic java.lang.String createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData)
createSignature in interface ISecretStrategyconfig - the configurationrequestData - the data used for the request including all the data that will be sent, without the signatureCopyright © Breinify - All Rights Reserved.