Author: kono
Date: 2011-05-03 11:15:50 -0700 (Tue, 03 May 2011)
New Revision: 24901
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkView.java
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
Log:
Method names and JavaDocs are updated.
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkView.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-05-03 18:15:01 UTC (rev 24900)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-05-03 18:15:50 UTC (rev 24901)
@@ -48,8 +48,6 @@
*
* Consolidated data structure for graph object views.
*
- * @author kono
- *
*/
public interface CyNetworkView extends View<CyNetwork> {
@@ -95,7 +93,15 @@
Collection<View<? extends CyTableEntry>> getAllViews();
- Boolean isNullView();
+ /**
+ * Returns true if this is an empty view object.
+ * Usually, the empty view is used when network model is too big to
visualize.
+ * {@link CyNetworkViewFactory} checks viewThreshold property value to
create regular
+ * view model implementation or empty view model.
+ *
+ * @return true if this is an empty view model.
+ */
+ Boolean isEmptyView();
/**
Modified:
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
===================================================================
---
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
2011-05-03 18:15:01 UTC (rev 24900)
+++
core3/viewmodel-api/trunk/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
2011-05-03 18:15:50 UTC (rev 24901)
@@ -47,10 +47,21 @@
/**
* Create a {@linkplain CyNetworkView} from a {@linkplain
org.cytoscape.model.CyNetwork} object.
*
+ * This method always checks viewThreshold property value and returns
empty view if number of
+ * graph objects (nodes and edges) is above the threshold.
+ *
* @param network for which the CyNetworkView is to be created
* @return the view model for the network data model
*/
public CyNetworkView getNetworkView(final CyNetwork network);
+ /**
+ * Creates view with or without using viewThreshold property.
+ *
+ * @param network network data model for this view.
+ * @param useThreshold if false, this factory creates actual view model
by ignoring threshold.
+ *
+ * @return View model for the given data model.
+ */
public CyNetworkView getNetworkView(final CyNetwork network, final
Boolean useThreshold);
}
--
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.
