net.myrrix.web.servlets

Class RecommendServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.myrrix.web.servlets.AbstractMyrrixServlet

net.myrrix.web.servlets.RecommendServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public final class RecommendServlet
extends AbstractMyrrixServlet

Responds to a GET request to /recommend/[userID](?howMany=n)(&considerKnownItems=true|false)(&rescorerParams=...) and in turn calls MyrrixRecommender.recommend(long, int). If howMany is not specified, defaults to AbstractMyrrixServlet.DEFAULT_HOW_MANY. If considerKnownItems is not specified, it is considered false.

Output is in CSV or JSON format. Select output format using the HTTP Accept header.

CSV output contains one recommendation per line, and each line is of the form itemID, strength, like 325, 0.53. Strength is an opaque indicator of the relative quality of the recommendation.

JSON output is an array of arrays, with each sub-array containing an item ID and strength. Example: [[325, 0.53], [98, 0.499]].

Author:

Sean Owen

See Also:

Serialized Form

Field Summary

Fields inherited from class net.myrrix.web.servlets.AbstractMyrrixServlet

ALL_PARTITIONS_REF_KEY, LOCAL_INPUT_DIR_KEY, PARTITION_KEY, READ_ONLY_KEY, RECOMMENDER_KEY, RESCORER_PROVIDER_KEY, TIMINGS_KEY

Constructor Summary

Constructors

Constructor and Description
RecommendServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Long	getUnnormalizedPartitionToServe(javax.servlet.http.HttpServletRequest request)

Methods inherited from class net.myrrix.web.servlets.AbstractMyrrixServlet

getConsiderKnownItems, getHowMany, getRecommender, getRescorerParams, getRescorerProvider, getTiming, init, output, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommendServlet

public RecommendServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

IOException

getUnnormalizedPartitionToServe

protected Long getUnnormalizedPartitionToServe(javax.servlet.http.HttpServletRequest request)

Overrides:

getUnnormalizedPartitionToServe in class AbstractMyrrixServlet

Parameters:

request - request containing info that may determine which partition needs to serve it

Returns:

null if any partition may serve, or an integral value that should be used to determine the partiiton. This is usually an ID value, which will be possibly hashed and reduced modulo the number of partitions.