[Archive-access-cvs] SF.net SVN: archive-access:[3069] trunk/archive-access/projects/wayback/ wayback-core/src/main/java/org/archive/wayback/requestparser/ BaseRequestParser.java

[<bra...@us...>]

Revision: 3069
          http://archive-access.svn.sourceforge.net/archive-access/?rev=3069&view=rev
Author:   bradtofel
Date:     2010-04-27 22:02:07 +0000 (Tue, 27 Apr 2010)

Log Message:
-----------
JAVADOC

Modified Paths:
--------------
    trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/requestparser/BaseRequestParser.java

Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/requestparser/BaseRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/requestparser/BaseRequestParser.java	2010-04-27 20:52:20 UTC (rev 3068)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/requestparser/BaseRequestParser.java	2010-04-27 22:02:07 UTC (rev 3069)
@@ -47,12 +47,26 @@
  */
 public abstract class BaseRequestParser implements RequestParser {
 
+	/**
+	 * String path matching a query request, by form or OpenSearch
+	 */
 	public final static String QUERY_BASE = "query";
 
+	/**
+	 * String path matching a query request, by form or OpenSearch, indicating
+	 * user requests XML data in response
+	 */
 	public final static String XQUERY_BASE = "xmlquery";
 
+	/**
+	 * String path matching a replay request, by form or OpenSearch
+	 */
 	public final static String REPLAY_BASE = "replay";
 	
+	/**
+	 * Default maximum number of records to assume, overridden by configuration,
+	 * when not specified in the client request
+	 */
 	public final static int DEFAULT_MAX_RECORDS = 10;
 
 	
@@ -60,9 +74,6 @@
 	private String earliestTimestamp = null;
 	private String latestTimestamp = null;
 
-	/* (non-Javadoc)
-	 * @see org.archive.wayback.RequestParser#parse(javax.servlet.http.HttpServletRequest)
-	 */
 	public abstract WaybackRequest parse(HttpServletRequest httpRequest, 
 			AccessPoint wbContext) throws BadQueryException, 
 			BetterRequestException;
@@ -96,42 +107,46 @@
 	}
 
 	/**
-	 * @return the maxRecords
+	 * @return the maxRecords to use with this RequestParser, when not specified
+	 * by the client request
 	 */
 	public int getMaxRecords() {
 		return maxRecords;
 	}
 
 	/**
-	 * @param maxRecords the maxRecords to set
+	 * @param maxRecords the maxRecords to use with this RequestParser, when not
+	 * specified by the client request
 	 */
 	public void setMaxRecords(int maxRecords) {
 		this.maxRecords = maxRecords;
 	}
 
 	/**
-	 * @param default earliest timestamp
+	 * @param timestamp the earliest timestamp to use with this RequestParser 
+	 * when none is supplied by the user request
 	 */
 	public void setEarliestTimestamp(String timestamp) {
 		earliestTimestamp = Timestamp.parseBefore(timestamp).getDateStr();
 	}
 
 	/**
-	 * @return the default earliest timestamp
+	 * @return the default earliest timestamp to use with this RequestParser
 	 */
 	public String getEarliestTimestamp() {
 		return earliestTimestamp;
 	}
 
 	/**
-	 * @param default latest timestamp
+	 * @return default latest timestamp for this RequestParser
 	 */
 	public String getLatestTimestamp() {
 		return latestTimestamp;
 	}
 
 	/**
-	 * @return the default latest timestamp
+	 * @param timestamp the default latest timestamp to use with this 
+	 * RequestParser
 	 */
 	public void setLatestTimestamp(String timestamp) {
 		this.latestTimestamp = Timestamp.parseAfter(timestamp).getDateStr();


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.