com.hybris.ymkt.recommendation.services

Class ImpressionService

java.lang.Object

com.hybris.ymkt.recommendation.services.ImpressionService

public class ImpressionService
extends java.lang.Object

This service is responsible to record/track, aggregate and send recommendations seen/printed to the users.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	aggregationTimeWindow
protected static int	MAX_FAILURE
protected ModelService	modelService
protected ODataService	oDataService
protected int	readBatchSize
protected RecommendationBufferService	recommendationBufferService
protected int	sendBatchSize

Constructor Summary

Constructors

Constructor and Description
ImpressionService()

Method Summary

Modifier and Type	Method and Description
void	aggregateImpressions() Aggregate individual impressions, save the aggregated impressions and delete the individual impressions.
protected java.util.List<SAPRecoImpressionAggrModel>	aggregateImpressionsByScenario(java.util.List<SAPRecoImpressionModel> impressionsList) Aggregates impressions by scenario and aggregationTimeStamp Aggregation timestamp is the midpoint of the time window based on the current time e.g. Current time = 1:04:32.512 Time window = 5 minutes AggregatedTimeStamp = 1:02:30 (midpoint between 1:00 and 1:05)
protected long	calcMidTimeStamp(long datetime)
boolean	postImpression(SAPRecoImpressionAggrModel aggregatedImpression) Send aggregated impression via oData
void	saveImpression(ImpressionContext impressionContext) Save individual impressions when UI component is viewed
void	sendAggregatedImpressions() Get aggregated impressions for sending via oData. If successfully sent, delete it.
void	setAggregationTimeWindow(long aggregationTimeWindow)
void	setModelService(ModelService modelService)
void	setODataService(ODataService oDataService)
void	setReadBatchSize(int readBatchSize)
void	setRecommendationBufferService(RecommendationBufferService recommendationBufferService)
void	setSendBatchSize(int sendBatchSize)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FAILURE

protected static final int MAX_FAILURE

See Also:

Constant Field Values

aggregationTimeWindow

protected long aggregationTimeWindow

modelService

protected ModelService modelService

oDataService

protected ODataService oDataService

readBatchSize

protected int readBatchSize

recommendationBufferService

protected RecommendationBufferService recommendationBufferService

sendBatchSize

protected int sendBatchSize

Constructor Detail

ImpressionService

public ImpressionService()

Method Detail

aggregateImpressions

public void aggregateImpressions()

Aggregate individual impressions, save the aggregated impressions and delete the individual impressions. Exceptions must be handles by the caller.

aggregateImpressionsByScenario

protected java.util.List<SAPRecoImpressionAggrModel> aggregateImpressionsByScenario(java.util.List<SAPRecoImpressionModel> impressionsList)

Aggregates impressions by scenario and aggregationTimeStamp
Aggregation timestamp is the midpoint of the time window based on the current time
e.g.
Current time = 1:04:32.512
Time window = 5 minutes
AggregatedTimeStamp = 1:02:30 (midpoint between 1:00 and 1:05)

Parameters:

impressionsList - List of SAPRecoImpressionModel

Returns:

aggregatedImpressionsList

calcMidTimeStamp

protected long calcMidTimeStamp(long datetime)

postImpression

public boolean postImpression(SAPRecoImpressionAggrModel aggregatedImpression)

Send aggregated impression via oData

Parameters:

aggregatedImpression - SAPRecoImpressionAggrModel

Returns:

true if posting was a success, false otherwise.

saveImpression

public void saveImpression(ImpressionContext impressionContext)

Save individual impressions when UI component is viewed

Parameters:

impressionContext - the impression data to save

sendAggregatedImpressions

public void sendAggregatedImpressions()

Get aggregated impressions for sending via oData.
If successfully sent, delete it. If sending failed, keep it for next time

setAggregationTimeWindow

public void setAggregationTimeWindow(long aggregationTimeWindow)

setModelService

public void setModelService(ModelService modelService)

setODataService

public void setODataService(ODataService oDataService)

setReadBatchSize

public void setReadBatchSize(int readBatchSize)

setRecommendationBufferService

public void setRecommendationBufferService(RecommendationBufferService recommendationBufferService)

setSendBatchSize

public void setSendBatchSize(int sendBatchSize)