Author: jm
Date: 2011-05-11 13:14:56 -0700 (Wed, 11 May 2011)
New Revision: 25010
Modified:
core3/model-api/trunk/src/main/java/org/cytoscape/model/CyTableMetadata.java
Log:
Added documentation for CyTableMetadata
Modified:
core3/model-api/trunk/src/main/java/org/cytoscape/model/CyTableMetadata.java
===================================================================
---
core3/model-api/trunk/src/main/java/org/cytoscape/model/CyTableMetadata.java
2011-05-11 18:41:00 UTC (rev 25009)
+++
core3/model-api/trunk/src/main/java/org/cytoscape/model/CyTableMetadata.java
2011-05-11 20:14:56 UTC (rev 25010)
@@ -2,9 +2,35 @@
import java.util.Set;
+/**
+ * A snapshot of information about the relationships shared between a CyTable
+ * instance and any associated CyNetworks.
+ */
public interface CyTableMetadata {
+ /**
+ * Returns the type of the data associated with this object's table.
+ * This is typically either <code>CyNetwork.class</code>,
+ * <code>CyNode.class</code>, or <code>CyEdge.class</code>.
+ * @return the type of the data associated with this object's table.
+ */
Class<?> getType();
+
+ /**
+ * Returns the table whose metadata is described by this instance.
+ * @return the table whose metadata is described by this instance.
+ */
CyTable getCyTable();
+
+ /**
+ * Returns all the networks associated with this object's table.
+ * @return all the networks associated with this object's table.
+ */
Set<CyNetwork> getCyNetworks();
+
+ /**
+ * Returns the namespace used as the key to this object's table in
+ * {@link CyTableManager.getTableMap()}.
+ * @return
+ */
String getNamespace();
}
--
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.
