You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@roller.apache.org by ag...@apache.org on 2006/04/19 01:29:33 UTC
svn commit: r395086 -
/incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java
Author: agilliland
Date: Tue Apr 18 16:29:32 2006
New Revision: 395086
URL: http://svn.apache.org/viewcvs?rev=395086&view=rev
Log:
code reformatting.
Modified:
incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java
Modified: incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java
URL: http://svn.apache.org/viewcvs/incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java?rev=395086&r1=395085&r2=395086&view=diff
==============================================================================
--- incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java (original)
+++ incubator/roller/branches/roller-newbackend/src/org/roller/model/WeblogManager.java Tue Apr 18 16:29:32 2006
@@ -1,5 +1,10 @@
package org.roller.model;
+
+import java.io.Serializable;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
import org.roller.RollerException;
import org.roller.pojos.Assoc;
import org.roller.pojos.CommentData;
@@ -7,195 +12,34 @@
import org.roller.pojos.WeblogCategoryData;
import org.roller.pojos.WeblogEntryData;
import org.roller.pojos.WebsiteData;
-import org.roller.pojos.UserData;
-
-import java.io.Serializable;
-import java.util.Date;
-import java.util.List;
-import java.util.Map;
/**
* Interface to weblog entry, category and comment management.
*/
-public interface WeblogManager extends Serializable
-{
- public static final String CATEGORY_ATT = "category.att";
-
- /**
- * Release all resources associated with Roller session.
- */
- public void release();
-
- //------------------------------------------------ WeblogCategoryData CRUD
-
- /** Create new weblog category, NOT a persistent instance. */
- public WeblogCategoryData createWeblogCategory();
-
- /** Create new weblog category, NOT a persistent instance. */
- public WeblogCategoryData createWeblogCategory(
- WebsiteData website,
- WeblogCategoryData parent,
- String name,
- String description,
- String image) throws RollerException;
-
- /**
- * Get category by ID
- */
- public WeblogCategoryData retrieveWeblogCategory(String id)
- throws RollerException;
+public interface WeblogManager extends Serializable {
+ public static final String CATEGORY_ATT = "category.att";
- /**
- * Recategorize all entries with one category to another.
- * @param srcId
- * @param destId
- * @throws org.roller.RollerException
- */
- public void moveWeblogCategoryContents(String srcId, String destId)
- throws RollerException;
-
- //--------------------------------------------- WeblogCategoryData Queries
-
- public void storeWeblogCategory(WeblogCategoryData cat) throws RollerException;
+ public void storeWeblogEntry(WeblogEntryData entry) throws RollerException;
- public void removeWeblogCategory(WeblogCategoryData cat) throws RollerException;
-
+ public void removeWeblogEntry(WeblogEntryData entry) throws RollerException;
- /** Get WebLogCategory objects for a website. */
- public List getWeblogCategories(WebsiteData website)
- throws RollerException;
-
- /** Get WebLogCategory objects for a website. */
- public List getWeblogCategories(WebsiteData website, boolean includeRoot)
- throws RollerException;
-
- /**
- * Get top level categories for a website.
- * @param website Website.
- */
- public WeblogCategoryData getRootWeblogCategory(WebsiteData website)
- throws RollerException;
-
- /**
- * Get absolute path to category, appropriate for use by getWeblogCategoryByPath().
- * @param category WeblogCategoryData.
- * @return Forward slash separated path string.
- */
- public String getPath(WeblogCategoryData category) throws RollerException;
-
- /**
- * Get category specified by website and categoryPath.
- * @param website Website of WeblogCategory.
- * @param categoryPath Path of WeblogCategory, relative to category root.
- */
- public WeblogCategoryData getWeblogCategoryByPath(
- WebsiteData website, String categoryPath)
- throws RollerException;
-
- /**
- * Get sub-category by path relative to specified category.
- * @param category Root of path or null to start at top of category tree.
- * @param path Path of category to be located.
- * @param website Website of categories.
- * @return Category specified by path or null if not found.
- */
- public WeblogCategoryData getWeblogCategoryByPath(
- WebsiteData wd, WeblogCategoryData category, String string)
- throws RollerException;
-
- //----------------------------------------------- WeblogCategoryAssoc CRUD
-
- /** Create new weblog category assoc, NOT a persistent instance. */
- public WeblogCategoryAssoc createWeblogCategoryAssoc();
-
- /** Create new weblog category assoc, NOT a persistent instance. */
- public WeblogCategoryAssoc createWeblogCategoryAssoc(
- WeblogCategoryData category,
- WeblogCategoryData ancestor,
- String relation) throws RollerException;
-
- /**
- * Get category assoc. by ID
- */
- public WeblogCategoryAssoc retrieveWeblogCategoryAssoc(String id)
- throws RollerException;
-
- //------------------------------------------------------- CommentData CRUD
-
- /**
- * Get comment by ID
- */
- public CommentData retrieveComment(String id)
- throws RollerException;
-
- /**
- * Remove comment by ID
- */
- public void removeComment(String id)
- throws RollerException;
-
- /**
- * Remove comments specified by array of IDs
- * @param ids
- * @throws org.roller.RollerException
- */
- public void removeComments(String[] ids)
- throws RollerException;
-
- public void saveComment(CommentData comment) throws RollerException;
/**
- * Remove all comments of entry specified by ID
- */
- public void removeCommentsForEntry(String entryId)
- throws RollerException;
-
- /**
- * Generic comments query method
- * @param website Website or null for all comments on site
- * @param entry Entry or null to include all comments
- * @param startDate Start date or null for no restriction
- * @param endDate End date or null for no restriction
- * @param pending Pending flag value or null for no restriction
- * @param pending Approved flag value or null for no restriction
- * @param reverseChrono True for results in reverse chrono order
- * @param spam Spam flag value or null for no restriction
- * @param offset Offset into results for paging
- * @param length Max comments to return (or -1 for no limit)
- */
- public List getComments(
- WebsiteData website,
- WeblogEntryData entry,
- String searchString,
- Date startDate,
- Date endDate,
- Boolean pending,
- Boolean approved,
- Boolean spam,
- boolean reverseChrono,
- int offset,
- int length
- ) throws RollerException;
-
- //------------------------------------------------------- WeblogEntry CRUD
-
- /**
* Get weblog entry by ID
*/
public WeblogEntryData retrieveWeblogEntry(String id) throws RollerException;
- public void storeWeblogEntry(WeblogEntryData entry) throws RollerException;
-
-
- public void removeWeblogEntry(WeblogEntryData entry) throws RollerException;
+ /**
+ * Get weblog entry by anchor.
+ */
+ public WeblogEntryData getWeblogEntryByAnchor(WebsiteData website, String anchor)
+ throws RollerException;
-
- //------------------------------------------------ WeblogEntryData Queries
/**
* Get WeblogEntries by offset/length as list in reverse chronological order.
@@ -212,15 +56,17 @@
* @throws RollerException
*/
public List getWeblogEntries(
- WebsiteData website,
- Date startDate,
- Date endDate,
- String catName,
- String status,
- String sortBy,
- int offset,
- int range)
- throws RollerException;
+ WebsiteData website,
+ Date startDate,
+ Date endDate,
+ String catName,
+ String status,
+ String sortBy,
+ int offset,
+ int range)
+ throws RollerException;
+
+
/**
* Get WeblogEntries up to limit as list in reverse chronological order.
* The range offset and list arguments enable paging through query results.
@@ -236,18 +82,19 @@
* @throws RollerException
*/
public List getWeblogEntries(
- WebsiteData website,
- Date startDate,
- Date endDate,
- String catName,
- String status,
- String sortBy,
- Integer maxEntries)
- throws RollerException;
+ WebsiteData website,
+ Date startDate,
+ Date endDate,
+ String catName,
+ String status,
+ String sortBy,
+ Integer maxEntries)
+ throws RollerException;
+
/**
- * Get Weblog Entries grouped by day. This method returns a Map that
- * contains Lists, each List contains WeblogEntryData objects, and the
+ * Get Weblog Entries grouped by day. This method returns a Map that
+ * contains Lists, each List contains WeblogEntryData objects, and the
* Lists are keyed by Date objects.
* @param userName User name or null to get for all users.
* @param startDate Start date or null for no start date.
@@ -259,17 +106,18 @@
* @throws RollerException
*/
public Map getWeblogEntryObjectMap(
- WebsiteData website,
- Date startDate,
- Date endDate,
- String catName,
- String status,
- Integer maxEntries)
- throws RollerException;
-
+ WebsiteData website,
+ Date startDate,
+ Date endDate,
+ String catName,
+ String status,
+ Integer maxEntries)
+ throws RollerException;
+
+
/**
- * Get Weblog Entry date strings grouped by day. This method returns a Map
- * that contains Lists, each List contains YYYYMMDD date strings objects,
+ * Get Weblog Entry date strings grouped by day. This method returns a Map
+ * that contains Lists, each List contains YYYYMMDD date strings objects,
* and the Lists are keyed by Date objects.
* @param userName User name or null to get for all users.
* @param startDate Start date or null for no start date.
@@ -281,14 +129,15 @@
* @throws RollerException
*/
public Map getWeblogEntryStringMap(
- WebsiteData website,
- Date startDate,
- Date endDate,
- String catName,
- String status,
- Integer maxEntries)
- throws RollerException;
-
+ WebsiteData website,
+ Date startDate,
+ Date endDate,
+ String catName,
+ String status,
+ Integer maxEntries)
+ throws RollerException;
+
+
/**
* Get weblog entries with given category or, optionally, any sub-category
* of that category.
@@ -296,64 +145,65 @@
* @param subcats True if sub-categories are to be fetched.
* @return List of weblog entries in category.
*/
- public List retrieveWeblogEntries(WeblogCategoryData cat, boolean subcats)
- throws RollerException;
-
+ public List retrieveWeblogEntries(WeblogCategoryData cat, boolean subcats)
+ throws RollerException;
+
+
/**
- * Get the WeblogEntry following, chronologically, the current entry.
+ * Get the WeblogEntry following, chronologically, the current entry.
* Restrict by the Category, if named.
- *
+ *
* @param current The "current" WeblogEntryData.
* @param catName The value of the requested Category Name.
* @return
*/
public WeblogEntryData getNextEntry(WeblogEntryData current, String catName)
- throws RollerException;
-
+ throws RollerException;
+
+
/**
* Get the WeblogEntry prior to, chronologically, the current entry.
* Restrict by the Category, if named.
- *
+ *
* @param current The "current" WeblogEntryData.
* @param catName The value of the requested Category Name.
* @return
*/
- public WeblogEntryData getPreviousEntry(WeblogEntryData current, String catName)
- throws RollerException;
-
+ public WeblogEntryData getPreviousEntry(WeblogEntryData current,
+ String catName) throws RollerException;
+
+
/**
* Get entries next after current entry.
* @param entry Current entry.
* @param catName Only return entries in this category (if not null).
* @param maxEntries Maximum number of entries to return.
*/
- public List getNextEntries(
- WeblogEntryData entry, String catName, int maxEntries) throws RollerException;
-
+ public List getNextEntries(WeblogEntryData entry,
+ String catName, int maxEntries) throws RollerException;
+
+
/**
* Get entries previous to current entry.
* @param entry Current entry.
* @param catName Only return entries in this category (if not null).
* @param maxEntries Maximum number of entries to return.
*/
- public List getPreviousEntries(
- WeblogEntryData entry, String catName, int maxEntries) throws RollerException;
-
+ public List getPreviousEntries(WeblogEntryData entry,
+ String catName, int maxEntries) throws RollerException;
+
+
/**
* Get specified number of most recent pinned and published Weblog Entries.
* @param max Maximum number to return.
* @return Collection of WeblogEntryData objects.
*/
- public List getWeblogEntriesPinnedToMain(Integer max)
- throws RollerException;
-
- /** Get weblog entry by anchor. */
- public WeblogEntryData getWeblogEntryByAnchor(
- WebsiteData website, String anchor ) throws RollerException;
-
+ public List getWeblogEntriesPinnedToMain(Integer max) throws RollerException;
+
+
/** Get time of last update for a weblog specified by username */
- public Date getWeblogLastPublishTime(WebsiteData website)
- throws RollerException;
+ public Date getWeblogLastPublishTime(WebsiteData website) throws RollerException;
+
/**
* Gets returns most recent pubTime, optionally restricted by category.
@@ -363,48 +213,208 @@
* @throws RollerException
*/
public Date getWeblogLastPublishTime(WebsiteData website, String catName )
- throws RollerException;
+ throws RollerException;
+
+
+ /** Create new weblog category, NOT a persistent instance. */
+ public WeblogCategoryData createWeblogCategory();
+
+ /** Create new weblog category, NOT a persistent instance. */
+ public WeblogCategoryData createWeblogCategory(
+ WebsiteData website,
+ WeblogCategoryData parent,
+ String name,
+ String description,
+ String image) throws RollerException;
+
+
+ public void storeWeblogCategory(WeblogCategoryData cat) throws RollerException;
+
+
+ /**
+ * Recategorize all entries with one category to another.
+ * @param srcId
+ * @param destId
+ * @throws org.roller.RollerException
+ */
+ public void moveWeblogCategoryContents(String srcId, String destId)
+ throws RollerException;
+
+
+ public void removeWeblogCategory(WeblogCategoryData cat) throws RollerException;
+
+
+ /**
+ * Get category by ID
+ */
+ public WeblogCategoryData retrieveWeblogCategory(String id) throws RollerException;
+
+
+ /**
+ * Get top level categories for a website.
+ * @param website Website.
+ */
+ public WeblogCategoryData getRootWeblogCategory(WebsiteData website) throws RollerException;
+
+
+ /**
+ * Get category specified by website and categoryPath.
+ * @param website Website of WeblogCategory.
+ * @param categoryPath Path of WeblogCategory, relative to category root.
+ */
+ public WeblogCategoryData getWeblogCategoryByPath(WebsiteData website,
+ String categoryPath) throws RollerException;
+
+ /**
+ * Get sub-category by path relative to specified category.
+ * @param category Root of path or null to start at top of category tree.
+ * @param path Path of category to be located.
+ * @param website Website of categories.
+ * @return Category specified by path or null if not found.
+ */
+ public WeblogCategoryData getWeblogCategoryByPath(WebsiteData wd,
+ WeblogCategoryData category, String string) throws RollerException;
+
+
+ /** Get WebLogCategory objects for a website. */
+ public List getWeblogCategories(WebsiteData website) throws RollerException;
+
+
+ /** Get WebLogCategory objects for a website. */
+ public List getWeblogCategories(WebsiteData website, boolean includeRoot)
+ throws RollerException;
+
+
+ /**
+ * Get absolute path to category, appropriate for use by getWeblogCategoryByPath().
+ * @param category WeblogCategoryData.
+ * @return Forward slash separated path string.
+ */
+ public String getPath(WeblogCategoryData category) throws RollerException;
+
+
+ /** Create new weblog category assoc, NOT a persistent instance. */
+ public WeblogCategoryAssoc createWeblogCategoryAssoc();
+
+
+ /** Create new weblog category assoc, NOT a persistent instance. */
+ public WeblogCategoryAssoc createWeblogCategoryAssoc(
+ WeblogCategoryData category,
+ WeblogCategoryData ancestor,
+ String relation) throws RollerException;
+
+ /**
+ * Get category assoc. by ID
+ */
+ public WeblogCategoryAssoc retrieveWeblogCategoryAssoc(String id)
+ throws RollerException;
+
+
+ public Assoc getWeblogCategoryParentAssoc(WeblogCategoryData data) throws RollerException;
+
+ public List getWeblogCategoryChildAssocs(WeblogCategoryData data) throws RollerException;
+
+ public List getAllWeblogCategoryDecscendentAssocs(WeblogCategoryData data) throws RollerException;
+
+ public List getWeblogCategoryAncestorAssocs(WeblogCategoryData data) throws RollerException;
+
+
+ public void saveComment(CommentData comment) throws RollerException;
+
+
+ /**
+ * Remove comment by ID
+ */
+ public void removeComment(String id) throws RollerException;
+
+ /**
+ * Remove comments specified by array of IDs
+ * @param ids
+ * @throws org.roller.RollerException
+ */
+ public void removeComments(String[] ids) throws RollerException;
+
+
+ /**
+ * Remove all comments of entry specified by ID
+ */
+ public void removeCommentsForEntry(String entryId) throws RollerException;
+
+
+ /**
+ * Get comment by ID
+ */
+ public CommentData retrieveComment(String id) throws RollerException;
+
+
+ /**
+ * Generic comments query method
+ * @param website Website or null for all comments on site
+ * @param entry Entry or null to include all comments
+ * @param startDate Start date or null for no restriction
+ * @param endDate End date or null for no restriction
+ * @param pending Pending flag value or null for no restriction
+ * @param pending Approved flag value or null for no restriction
+ * @param reverseChrono True for results in reverse chrono order
+ * @param spam Spam flag value or null for no restriction
+ * @param offset Offset into results for paging
+ * @param length Max comments to return (or -1 for no limit)
+ */
+ public List getComments(
+ WebsiteData website,
+ WeblogEntryData entry,
+ String searchString,
+ Date startDate,
+ Date endDate,
+ Boolean pending,
+ Boolean approved,
+ Boolean spam,
+ boolean reverseChrono,
+ int offset,
+ int length
+ ) throws RollerException;
/**
* Create unique anchor for weblog entry.
*/
- public String createAnchor(WeblogEntryData data)
- throws RollerException;
-
+ public String createAnchor(WeblogEntryData data) throws RollerException;
+
+
/**
* Check for duplicate category name.
*/
public boolean isDuplicateWeblogCategoryName(WeblogCategoryData data)
- throws RollerException;
-
+ throws RollerException;
+
+
/**
* Check if weblog category is in use.
*/
public boolean isWeblogCategoryInUse(WeblogCategoryData data)
- throws RollerException;
-
+ throws RollerException;
+
+
/**
* Returns true if ancestor is truly an ancestor of child.
*/
- public boolean isDescendentOf(
- WeblogCategoryData child, WeblogCategoryData ancestor) throws RollerException;
-
+ public boolean isDescendentOf(WeblogCategoryData child,
+ WeblogCategoryData ancestor) throws RollerException;
+
+
/**
* Get the URL of a website.
* @param website The website
- * @param contextUrl The context url, this is prepended and can be absolute
+ * @param contextUrl The context url, this is prepended and can be absolute
* or relative depending on what is desired.
* @return The url of the user's weblog
*/
public String getUrl(WebsiteData website, String contextUrl) throws RollerException;
- public Assoc getWeblogCategoryParentAssoc(WeblogCategoryData data) throws RollerException;
-
- public List getWeblogCategoryChildAssocs(WeblogCategoryData data) throws RollerException;
-
- public List getAllWeblogCategoryDecscendentAssocs(WeblogCategoryData data) throws RollerException;
-
- public List getWeblogCategoryAncestorAssocs(WeblogCategoryData data) throws RollerException;
+ /**
+ * Release all resources associated with Roller session.
+ */
+ public void release();
+
}