[hive-mrc] r628 committed - Added documentation

[hive...@googlecode.com]

Revision: 628
Author: craig....@unc.edu
Date: Fri May 11 16:23:18 2012
Log: Added documentation
http://code.google.com/p/hive-mrc/source/detail?r=628

Modified:
/trunk/hive-web/src/org/unc/hive/servlet/AutocompleteServlet.java
/trunk/hive-web/src/org/unc/hive/servlet/TermSuggestionServlet.java

=======================================
--- /trunk/hive-web/src/org/unc/hive/servlet/AutocompleteServlet.java Fri
May 11 12:40:36 2012
+++ /trunk/hive-web/src/org/unc/hive/servlet/AutocompleteServlet.java Fri
May 11 16:23:18 2012
@@ -16,7 +16,12 @@
import edu.unc.ils.mrc.hive.ir.lucene.search.AutocompleteTerm;

/**
- * Servlet implementation class Search
+ * Autocomplete servlet returns JSON/JSONP formatted data for use with
JQuery
+ *
+ * Parameters:
+ * cv: vocabulary name (required)
+ * term: text (required)
+ * callback: callback function for JSONP support (optional)
*/
public class AutocompleteServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
@@ -32,7 +37,6 @@
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
response)
*/
protected void doGet(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {
- System.out.println("doGet");

ServletContext context = this.getServletContext();
String path = context.getRealPath("");
@@ -46,7 +50,6 @@
try {
terms = service.suggestTermsFor(vocab, term, 15);
} catch (Exception e) {
- // TODO Auto-generated catch block
e.printStackTrace();
}
StringBuffer json = new StringBuffer("\n[");
=======================================
--- /trunk/hive-web/src/org/unc/hive/servlet/TermSuggestionServlet.java Fri
May 11 12:40:36 2012
+++ /trunk/hive-web/src/org/unc/hive/servlet/TermSuggestionServlet.java Fri
May 11 16:23:18 2012
@@ -24,7 +24,15 @@
import edu.unc.ils.mrc.hive.api.ConceptNode;

/**
+ * Term suggestion servlet returns JSON/JSONP formatted data for use with
JQuery/Dynatree component.
*
+ * Parameters:
+ * cv: comma separated list of vocabularies (required)
+ * txt: text (required)
+ * fmt: "tree" or "list" (optional, default "tree")
+ * mp: minimum phrase occurrences (optional, default 1)
+ * ex: pipe delimited list of c.v. terms to exclude (optional)
+ * callback: callback function for JSONP support (optional)
*/
public class TermSuggestionServlet extends HttpServlet
{