archive-access-cvs Mailing List for Web Archive Access Utilities (Page 30)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

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

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

Modified Paths:
--------------
    trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/PerformanceLogger.java
    trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/WaybackCollection.java

Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/PerformanceLogger.java
===================================================================

--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/PerformanceLogger.java	2010-04-27 22:35:18 UTC (rev 3079)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/PerformanceLogger.java	2010-04-27 22:45:40 UTC (rev 3080)
@@ -28,6 +28,9 @@
 import org.apache.log4j.Logger;
 
 /**
+ * Brutally simple, barely functional class to allow simple recording of 
+ * millisecond level timing within a particular request, enabling rough logging
+ * of the time spent in various parts of the handling of a WaybackRequest
  * @author brad
  *
  */
@@ -42,19 +45,41 @@
 	private long query = 0;
 	private long retrieve = -1;
 	private long render = 0;
+	/**
+	 * Construct a Performance logger with the specified String "type"
+	 * @param type the String type to report with the logged output
+	 */
 	public PerformanceLogger(String type) {
 		this.type = type;
 		this.start = System.currentTimeMillis();
 	}
+	/**
+	 * record the time when the query associated with this request completed
+	 */
 	public void queried() {
 		this.query = System.currentTimeMillis();
 	}
+	/**
+	 * record the time when the retrieval of a Resource required for this 
+	 * request completed, implies a Replay request...
+	 */
 	public void retrieved() {
 		this.retrieve = System.currentTimeMillis();
 	}
+	/**
+	 * record the time when the replayed resource, or the query results were
+	 * returned to the client, implies the bulk of the request processing is 
+	 * complete.
+	 */
 	public void rendered() {
 		this.render = System.currentTimeMillis();
 	}
+	/**
+	 * Produce a debug message to this classes logger, computing the time
+	 * taken to query the index, retrieve the resource (if a replay request)
+	 * and render the results to the client. 
+	 * @param info String suffix to append to the log message 
+	 */
 	public void write(String info) {
 		StringBuilder sb = new StringBuilder(40);
 		sb.append(type).append(delim);

Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/WaybackCollection.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/WaybackCollection.java	2010-04-27 22:35:18 UTC (rev 3079)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/webapp/WaybackCollection.java	2010-04-27 22:45:40 UTC (rev 3080)
@@ -33,8 +33,8 @@
 import org.archive.wayback.exception.ConfigurationException;
 
 /**
- * Abstraction point for sharing document collection and index across multiple
- * AccessPoints.
+ * Composite class containing a ResourceStore, and a ResourceIndex, to simplify
+ * sharing them as a pair across multiple AccessPoints.
  *
  * @author brad
  * @version $Date$, $Revision$
@@ -45,6 +45,10 @@
 	private List<Shutdownable> shutdownables = null;
 	private boolean shutdownDone = false;
 
+	/**
+	 * close/release any resources held by this WaybackCollection
+	 * @throws IOException when thrown by an internal class being shut down.
+	 */
 	public void shutdown() throws IOException {
 		if(shutdownDone) {
 			return;
@@ -63,29 +67,51 @@
 		shutdownDone = true;
 	}
 
+	/**
+	 * @return the ResourceStore used with this WaybackCollection
+	 * @throws ConfigurationException if none is configured
+	 */
 	public ResourceStore getResourceStore() throws ConfigurationException {
 		if(resourceStore == null) {
 			throw new ConfigurationException("No resourceStore declared");
 		}
 		return resourceStore;
 	}
+	/**
+	 * @param resourceStore the ResourceStore to use with this WaybackCollection
+	 */
 	public void setResourceStore(ResourceStore resourceStore) {
 		this.resourceStore = resourceStore;
 	}
+	/**
+	 * @return the ResourceIndex used with this WaybackCollection
+	 * @throws ConfigurationException if none is configured
+	 */
 	public ResourceIndex getResourceIndex() throws ConfigurationException {
 		if(resourceIndex == null) {
 			throw new ConfigurationException("No resourceIndex declared");
 		}
 		return resourceIndex;
 	}
+	/**
+	 * @param resourceIndex the ResourceIndex to use with this WaybackCollection
+	 */
 	public void setResourceIndex(ResourceIndex resourceIndex) {
 		this.resourceIndex = resourceIndex;
 	}
 
+	/**
+	 * @return List of Shutdownable objects associated with this 
+	 * WaybackCollection, or null, if none are configured
+	 */
 	public List<Shutdownable> getShutdownables() {
 		return shutdownables;
 	}
 
+	/**
+	 * @param shutdownables set a List of Shutdownable objects associated with
+	 * this WaybackCollection
+	 */
 	public void setShutdownables(List<Shutdownable> shutdownables) {
 		this.shutdownables = shutdownables;
 	}


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




2005	Jan	Feb	Mar	Apr	May	Jun	Jul (1)	Aug (10)	Sep (36)	Oct (339)	Nov (103)	Dec (152)
2006	Jan (141)	Feb (102)	Mar (125)	Apr (203)	May (57)	Jun (30)	Jul (139)	Aug (46)	Sep (64)	Oct (105)	Nov (34)	Dec (162)
2007	Jan (81)	Feb (57)	Mar (141)	Apr (72)	May (9)	Jun (1)	Jul (144)	Aug (88)	Sep (40)	Oct (43)	Nov (34)	Dec (20)
2008	Jan (44)	Feb (45)	Mar (16)	Apr (36)	May (8)	Jun (77)	Jul (177)	Aug (66)	Sep (8)	Oct (33)	Nov (13)	Dec (37)
2009	Jan (2)	Feb (5)	Mar (8)	Apr	May (36)	Jun (19)	Jul (46)	Aug (8)	Sep (1)	Oct (66)	Nov (61)	Dec (10)
2010	Jan (13)	Feb (16)	Mar (38)	Apr (76)	May (47)	Jun (32)	Jul (35)	Aug (45)	Sep (20)	Oct (61)	Nov (24)	Dec (16)
2011	Jan (22)	Feb (34)	Mar (11)	Apr (8)	May (24)	Jun (23)	Jul (11)	Aug (42)	Sep (81)	Oct (48)	Nov (21)	Dec (20)
2012	Jan (30)	Feb (25)	Mar (4)	Apr (6)	May (1)	Jun (5)	Jul (5)	Aug (8)	Sep (6)	Oct (6)	Nov	Dec

archive-access-cvs Mailing List for Web Archive Access Utilities (Page 30)

archive-access-cvs — CVS commits