Daniel Kinzler has submitted this change and it was merged.
Change subject: Added doc comments to Servlet classes and their methods
......................................................................
Added doc comments to Servlet classes and their methods
Change-Id: I85701bb396d745c840e2db2ec3671310e33ac58f
---
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/DataIngestServlet.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/EntitySuggesterServlet.java
3 files changed, 67 insertions(+), 4 deletions(-)
Approvals:
Daniel Kinzler: Verified; Looks good to me, approved
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
index 6569913..0fa634a 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
@@ -20,6 +20,7 @@
import
org.wikimedia.wikibase.entitysuggester.client.recommender.WebClientRecommender;
/**
+ * Base class for all client servlets
*
* @author nilesh
*/
@@ -28,6 +29,13 @@
static final Splitter SLASH = Splitter.on('/').omitEmptyStrings();
private WebClientRecommender recommender = null;
+ /**
+ *
+ * @param request
+ * @param response
+ * @throws IOException
+ * @throws ServletException
+ */
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse
response) throws IOException, ServletException {
if (recommender == null) {
@@ -35,6 +43,13 @@
}
}
+ /**
+ *
+ * @param request
+ * @param response
+ * @throws IOException
+ * @throws ServletException
+ */
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse
response) throws IOException, ServletException {
if (recommender == null) {
@@ -42,10 +57,22 @@
}
}
+ /**
+ *
+ * @return
+ */
protected final WebClientRecommender getClientRecommender() {
return recommender;
}
+ /**
+ * Used to find the path of the file with the of wikibaseProperties. The
+ * file name is set in the WAR's web.xml
+ *
+ * @param name
+ * @return
+ * @throws NamingException
+ */
protected final URL getPropFilePath(String name) throws NamingException {
Context initCtx = new InitialContext();
Context envCtx = (Context) initCtx.lookup("java:comp/env");
@@ -54,7 +81,14 @@
return filePath;
}
- private void initializeClientRecommender(HttpServletRequest request,
HttpServletResponse response) throws IOException {
+ /**
+ * Initialize the WebClientRecommender instance for one time only.
+ *
+ * @param request
+ * @param response
+ * @throws IOException
+ */
+ public void initializeClientRecommender(HttpServletRequest request,
HttpServletResponse response) throws IOException {
synchronized (this) {
if (recommender == null) {
try {
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/DataIngestServlet.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/DataIngestServlet.java
index 136135f..d8abd81 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/DataIngestServlet.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/DataIngestServlet.java
@@ -15,11 +15,24 @@
import org.apache.mahout.cf.taste.common.TasteException;
/**
+ * This is part of the actual REST API - client servlet to feed/train the
Myrrix
+ * engine with a csv file.
*
- * @author nilesh
+ * @see WebClientRecommender.ingest()
+ *
+ * @author Nilesh Chakraborty
*/
public class DataIngestServlet extends AbstractEntitySuggesterServlet {
+ /**
+ * Handle a HTTP POST request where the training file contents are sent in
+ * the POST body.
+ *
+ * @param request
+ * @param response
+ * @throws IOException
+ * @throws ServletException
+ */
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse
response) throws IOException, ServletException {
super.doPost(request, response);
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/EntitySuggesterServlet.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/EntitySuggesterServlet.java
index 7a8e59e..a6135af 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/EntitySuggesterServlet.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/EntitySuggesterServlet.java
@@ -16,11 +16,20 @@
import org.apache.mahout.cf.taste.common.TasteException;
/**
- *
- * @author nilesh
+ * This is part of the actual REST API - client servlet to suggest
+ * wikibaseProperties for already existing (TODO) or anonymous wikibaseItems
+ * @author Nilesh Chakraborty
*/
public class EntitySuggesterServlet extends AbstractEntitySuggesterServlet {
+ /**
+ * Handle a HTTP GET request to suggest wikibaseProperties for anonymous
+ * wikibaseItems (that don't exist in the dataset)
+ * @param request
+ * @param response
+ * @throws IOException
+ * @throws ServletException
+ */
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse
response) throws IOException, ServletException {
super.doGet(request, response);
@@ -41,6 +50,13 @@
}
}
+ /**
+ * Output JSON-formatted results.
+ * @param request
+ * @param response
+ * @param items
+ * @throws IOException
+ */
protected final void output(HttpServletRequest request,
ServletResponse response,
List<TranslatedRecommendedItem> items) throws IOException {
--
To view, visit https://gerrit.wikimedia.org/r/75373
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I85701bb396d745c840e2db2ec3671310e33ac58f
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataEntitySuggester
Gerrit-Branch: master
Gerrit-Owner: Nilesh <[email protected]>
Gerrit-Reviewer: Daniel Kinzler <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
