Author: pwang
Date: 2010-10-26 13:47:44 -0700 (Tue, 26 Oct 2010)
New Revision: 22480
Modified:
core3/property-api/trunk/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
Log:
Update doc
Modified:
core3/property-api/trunk/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
===================================================================
---
core3/property-api/trunk/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
2010-10-26 20:31:06 UTC (rev 22479)
+++
core3/property-api/trunk/src/main/java/org/cytoscape/property/bookmark/BookmarksUtil.java
2010-10-26 20:47:44 UTC (rev 22480)
@@ -1,7 +1,9 @@
package org.cytoscape.property.bookmark;
import java.util.List;
-
+/**
+ * A set of utility methods to manipulate the bookmarks
+ */
public interface BookmarksUtil {
/**
@@ -24,56 +26,47 @@
public Category getCategory(String categoryName, List<Category>
categoryList);
/**
- * DOCUMENT ME!
+ * Given the attribute name, return the value in a bookmark
*
- * @param source
- * DOCUMENT ME!
- * @param attrName
- * DOCUMENT ME!
+ * @param source a bookmark object
+ * @param attrName an attribute name
*
- * @return DOCUMENT ME!
+ * @return The value related to the attribute name
*/
public String getAttribute(DataSource source, String attrName);
/**
- * DOCUMENT ME!
+ * Store a bookmark object in bookmarks object
*
- * @param pBookmarks
- * DOCUMENT ME!
- * @param pCategoryName
- * DOCUMENT ME!
- * @param pDataSource
- * DOCUMENT ME!
+ * @param pBookmarks bookmarks object
+ * @param pCategoryName category name
+ * @param pDataSource a single bookmark
*/
public void saveBookmark(Bookmarks pBookmarks, String pCategoryName,
DataSource pDataSource);
/**
- * DOCUMENT ME!
+ * Delete a bookmark (pDataSource) from the categoty (pCategoryName) in
the bookmarks object (pBookmarks)
*
- * @param pBookmarks
- * DOCUMENT ME!
- * @param pCategoryName
- * DOCUMENT ME!
- * @param pDataSource
- * DOCUMENT ME!
+ * @param pBookmarks Bookmark object, which hold a set of bookmark
+ *
+ * @param pCategoryName category name
*
- * @return DOCUMENT ME!
+ * @param pDataSource a single bookmark object
+ *
+ * @return True if the bookmark is deleted successfully, False
otherwise.
*/
public boolean deleteBookmark(Bookmarks pBookmarks, String
pCategoryName,
DataSource pDataSource);
/**
- * DOCUMENT ME!
+ * Check if a bookmark is in the bookmarks.
*
- * @param pBookmarks
- * DOCUMENT ME!
- * @param pCategoryName
- * DOCUMENT ME!
- * @param pDataSource
- * DOCUMENT ME!
+ * @param pBookmarks bookmarks object
+ * @param pCategoryName category name
+ * @param pDataSource a bookmark
*
- * @return DOCUMENT ME!
+ * @return True if the bookmark is in bookmarks, False otherwise
*/
public boolean isInBookmarks(Bookmarks pBookmarks, String pCategoryName,
DataSource pDataSource);
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
