Author: agilliland
Date: Wed Apr 19 11:07:55 2006
New Revision: 395329
URL: http://svn.apache.org/viewcvs?rev=395329&view=rev
Log:
code reformatting.
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/RefererManager.java
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/RefererManager.java
URL:
http://svn.apache.org/viewcvs/incubator/roller/branches/roller-newbackend/src/org/roller/model/RefererManager.java?rev=395329&r1=395328&r2=395329&view=diff
==============================================================================
---
incubator/roller/branches/roller-newbackend/src/org/roller/model/RefererManager.java
(original)
+++
incubator/roller/branches/roller-newbackend/src/org/roller/model/RefererManager.java
Wed Apr 19 11:07:55 2006
@@ -1,31 +1,72 @@
package org.roller.model;
-import org.roller.RollerException;
-import org.roller.pojos.RefererData;
-import org.roller.pojos.WebsiteData;
import java.io.Serializable;
import java.util.List;
-import org.roller.pojos.WeblogEntryData;
+import org.roller.RollerException;
+import org.roller.pojos.RefererData;
+import org.roller.pojos.WebsiteData;
-/////////////////////////////////////////////////////////////////////////////
/**
* Interface to Referer management.
- * @author David M Johnson
*/
-public interface RefererManager extends Serializable
-{
- //------------------------------------------ Access to Referer information
-
+public interface RefererManager extends Serializable {
+
+
+ /**
+ * Store the referer.
+ */
+ public void storeReferer(RefererData referer) throws RollerException;
+
+
+ /**
+ * Remove referer specified by ID.
+ */
+ public void removeReferer( String id ) throws RollerException;
+
+
+ /**
+ * Remove a single referer.
+ */
+ public void removeReferer(RefererData referer) throws RollerException;
+
+
+ /**
+ * Remove all referers for the specific weblog entry.
+ * @param entryId Weblog entry ID
+ * @throws RollerException
+ */
+ public void removeReferersForEntry(String entryid) throws RollerException;
+
+
+ /**
+ * Clear referrer dayhits and remove referrers without excerpts.
+ */
+ public void clearReferrers() throws RollerException;
+
+
+ /**
+ * Clear referrer dayhits and remove referrers without excerpts.
+ */
+ public void clearReferrers(WebsiteData website) throws RollerException;
+
+
+ /**
+ * Retrieve referer specifie by ID.
+ */
+ public RefererData retrieveReferer(String id) throws RollerException;
+
+
/**
* Get all referers for specified weblog.
- * @param weblog
+ * @param weblog
* @return List of type RefererData
* @throws RollerException
*/
public List getReferers(WebsiteData weblog) throws RollerException;
-
+
+
/**
* Get all referers for specified user that were made today.
* @param userName Name of user.
@@ -33,7 +74,8 @@
* @throws RollerException
*/
public List getTodaysReferers(WebsiteData website) throws RollerException;
-
+
+
/**
* Get referers for a specified date.
* @param userName Name of user.
@@ -42,100 +84,74 @@
* @throws RollerException
*/
public List getReferersToDate(WebsiteData website, String date) throws
RollerException;
-
+
+
/**
* Get most popular websites based on referer day hits.
* @return List of WebsiteDisplayData objects.
*/
public List getDaysPopularWebsites(int max) throws RollerException;
-
+
+
/**
* Get referers that refer to a specific weblog entry.
* @param entryid Weblog entry ID
* @return List of RefererData objects.
* @throws RollerException
*/
- public List getReferersToEntry(String entryid)
- throws RollerException;
-
- /**
- * Remove all referers for the specific weblog entry.
- * @param entryId Weblog entry ID
- * @throws RollerException
- */
- public void removeReferersForEntry(String entryid) throws RollerException;
+ public List getReferersToEntry(String entryid) throws RollerException;
+
/**
- * Apply ignoreWord/spam filters to all referers in system.
+ * Get referers that refer to a specific weblog entry.
+ * @param entryId Weblog entry ID
+ * @param authorized Is the current user authorized to edit these Referers.
+ * @return List of RefererData objects.
+ * @throws RollerException
*/
- public void applyRefererFilters() throws RollerException;
-
- /**
- * Apply ignoreWord/spam filters to all referers in website.
+ public List getEntryReferers(String entryId, boolean authorized)
+ throws RollerException;
+
+
+ /**
+ * Get user's day hits
*/
- public void applyRefererFilters(WebsiteData website) throws
RollerException;
-
- /**
- * Get referers that refer to a specific weblog entry.
- * @param entryId Weblog entry ID
- * @param authorized Is the current user authorized to edit these
Referers.
- * @return List of RefererData objects.
- * @throws RollerException
- */
- public List getEntryReferers(String entryId, boolean authorized)
- throws RollerException;
-
- /** Get user's day hits */
public int getDayHits(WebsiteData website) throws RollerException;
-
- /** Get user's all-time total hits */
- public int getTotalHits(WebsiteData website) throws RollerException;
-
- //--------------------------------------------- Referer processing methods
-
- public void processReferrer(
- String requestUrl,
- String referrerUrl,
- String weblogHandle,
- String weblogAnchor,
- String weblogDateString);
- //---------------------------------------------- Referer tracking turnover
-
- /**
- * Clear referrer dayhits and remove referrers without excerpts.
- */
- public void clearReferrers() throws RollerException;
- /**
- * Clear referrer dayhits and remove referrers without excerpts.
+ /**
+ * Get user's all-time total hits
*/
- public void clearReferrers(WebsiteData website) throws RollerException;
+ public int getTotalHits(WebsiteData website) throws RollerException;
+
- //----------------------------------------------- Standard manager methods
-
/**
- * Retrieve referer specifie by ID.
+ * Apply ignoreWord/spam filters to all referers in system.
*/
- public RefererData retrieveReferer(String id) throws RollerException;
-
+ public void applyRefererFilters() throws RollerException;
+
+
/**
- * Remove referer specified by ID.
+ * Apply ignoreWord/spam filters to all referers in website.
*/
- public void removeReferer( String id ) throws RollerException;
-
-
- public void removeReferer(RefererData referer) throws RollerException;
+ public void applyRefererFilters(WebsiteData website) throws
RollerException;
/**
- * Store the referer.
+ * Process an incoming referer.
*/
- public void storeReferer(RefererData referer) throws RollerException;
+ public void processReferrer(
+ String requestUrl,
+ String referrerUrl,
+ String weblogHandle,
+ String weblogAnchor,
+ String weblogDateString);
+
/**
* Release all resources associated with Roller session.
*/
public void release();
+
}
