Author: mkirby
Date: 2011-10-07 14:22:53 -0700 (Fri, 07 Oct 2011)
New Revision: 27089
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetworkTableManager.java
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetworkTableManager.java
===================================================================
---
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetworkTableManager.java
2011-10-07 21:20:11 UTC (rev 27088)
+++
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyNetworkTableManager.java
2011-10-07 21:22:53 UTC (rev 27089)
@@ -9,6 +9,8 @@
/**
* Associates the given table to the network using the specified
namespace and type.
* @param network the {@link CyNetwork} to associate the given table to.
+ * @param type Type of {@link CyTableEntry} associated with the table.
+ * @param namespace The name of the table relative to the network.
* @param table the table to associate to the network with the
specified namespace and type.
*/
void setTable(CyNetwork network, Class<? extends CyTableEntry> type,
String namespace, CyTable table);
@@ -17,6 +19,8 @@
* Returns the table with the specified namespace and type from the
* network.
* @param network the network to check for the table.
+ * @param type Type of {@link CyTableEntry} associated with the table.
+ * @param namespace The name of the table relative to the network.
* @return the table with the specified namespace and type from the
* network.
*/
@@ -26,6 +30,8 @@
* Removes the table with the specified namespace and type from
* the network.
* @param network the network to remove the table from.
+ * @param type Type of {@link CyTableEntry} associated with the table.
+ * @param namespace The name of the table relative to the network.
*/
void removeTable(CyNetwork network, Class<? extends CyTableEntry> type,
String namespace);
Modified:
core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
===================================================================
--- core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
2011-10-07 21:20:11 UTC (rev 27088)
+++ core3/api/trunk/model-api/src/main/java/org/cytoscape/model/CyTable.java
2011-10-07 21:22:53 UTC (rev 27089)
@@ -41,9 +41,22 @@
* types.
*/
public interface CyTable extends Identifiable {
+ /**
+ * Mutability of the table specifies whether or not it is able to be
deleted..
+ *
+ */
public static enum Mutability {
+ /**
+ * The table can be deleted.
+ */
MUTABLE("mutable"),
+ /**
+ * The table can not be deleted.
+ */
PERMANENTLY_IMMUTABLE("permanently immutable"),
+ /**
+ * The table can not be deleted because it currently has
virtual {@link CyColumn}s referencing it.
+ */
IMMUTABLE_DUE_TO_VIRT_COLUMN_REFERENCES("immutable due to
virtual column references");
private String humanReadableRepresentation;
@@ -56,8 +69,13 @@
final public String toString() { return
humanReadableRepresentation; }
}
+ /**
+ * The SavePolicy of a table specifies whether or not it will be saved.
+ */
public static enum SavePolicy {
- DO_NOT_SAVE, /* i.e. this table should not be serialized */
+ /** This table should not be saved i.e. this table should not
be serialized. */
+ DO_NOT_SAVE,
+ /** This table should be saved. */
SESSION_FILE,
}
@@ -207,7 +225,7 @@
/** Adds a "virtual" column to the the current table.
* @param virtualColumn the name of the new virtual column, if this
name already exists,
* new column names with -1, -2 and so appended
to this name on will
- * be tried until a nonexisting name will be
found
+ * be tried until a non-existing name will be
found
* @param sourceColumn the name of the column in "sourceTable" that
will be mapped to
* "virtualColumn"
* @param sourceTable the table that really contains the column
that we're adding (all
@@ -242,7 +260,7 @@
/**
* Sets how (or if) this CyTable should be saved.
- * @param policy the policy to follow during the lifecycle of the
CyTable.
+ * @param policy the policy to follow during the life-cycle of the
CyTable.
*/
void setSavePolicy(SavePolicy policy);
--
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.
