Author: mkirby
Date: 2011-10-29 15:14:21 -0700 (Sat, 29 Oct 2011)
New Revision: 27345
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/NullDataType.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexiconNode.java
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/AbstractVisualProperty.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -39,7 +39,7 @@
* An abstract implementation of VisualProperty that omits the methods dealing
* with serializing data.
* @param <T> the generic type for this AbstractVisualProperty.
- *
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractVisualProperty<T> implements VisualProperty<T> {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/ContinuousRange.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -1,5 +1,10 @@
package org.cytoscape.view.model;
+/**
+ * Defines a continuous range of values for {@link VisualProperty}s.
+ *
+ * @param <T> The generic type of this ContinuousRange.
+ */
public class ContinuousRange<T> implements Range<T> {
private final Class<T> type;
@@ -11,6 +16,14 @@
private final Boolean includeMax;
+ /**
+ * Constructs this ContinuousRange.
+ * @param type the type of this ContinuousRange.
+ * @param min the minimum value of this range.
+ * @param max the maximum value of this range.
+ * @param includeMin Whether or not to include the minimum in the range.
+ * @param includeMax Whether or not to include the maximum in the range.
+ */
public ContinuousRange(final Class<T> type, final T min, final T max,
final Boolean includeMin, final Boolean includeMax) {
this.type = type;
this.min = min;
@@ -29,21 +42,34 @@
return false;
}
+ /**
+ * Returns the minimum value of this range.
+ * @return the minimum value of this range.
+ */
public T getMin() {
return min;
}
-
+ /**
+ * Returns the maximum value of this range.
+ * @return the maximum value of this range.
+ */
public T getMax() {
return max;
}
-
+ /**
+ * Returns true if the minimum value is included in this range.
+ * @return true if the minimum value is included in this range.
+ */
public boolean includeMin() {
return includeMin;
}
-
+ /**
+ * Returns true if the maximum value is included in this range.
+ * @return true if the maximum value is included in this range.
+ */
public boolean includeMax() {
return includeMax;
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkView.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -44,18 +44,17 @@
/**
*
* Additional methods for CyNetworkView. Network view should implement BOTH
View
- * and CyNetworkView.
+ * and CyNetworkView. #ASKMIKE
*
* Consolidated data structure for graph object views.
- *
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkView extends View<CyNetwork> {
/**
* Returns a View for a specified Node.
*
- * @param node
- * Node object
+ * @param node Node object
*
* @return View for the given node object.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewFactory.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -40,7 +40,7 @@
/**
* Factory for {@linkplain CyNetworkView} objects.
* Modules which need to create view models should import this as a service.
- *
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkViewFactory {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/CyNetworkViewManager.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -40,7 +40,7 @@
*/
public interface CyNetworkViewManager {
/**
- * Provides the set of network views that are currently known to the
network mananger.
+ * Provides the set of network views that are currently known to the
network manager.
*
* @return the set of all network views maintained by the network view
manager
*/
@@ -49,7 +49,7 @@
/**
* Returns the network view corresponding to an ID, if found.
*
- * @param network_id a unquite ID that hopefully corresponds to a
network view
+ * @param network_id a unique ID that hopefully corresponds to a
network view.
*
* @return null if no network view was found corresponding to
"network_id", else the network view
*/
@@ -72,7 +72,7 @@
public void destroyNetworkView(CyNetworkView view);
/**
- * Registers a network view with the network view mananger.
+ * Registers a network view with the network view manager.
*
* @param view a non-null network view
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/DiscreteRange.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -3,11 +3,21 @@
import java.util.Collections;
import java.util.Set;
+/**
+ * Defines a discrete range of values for {@link VisualProperty}s.
+ *
+ * @param <T> The generic type of this DiscreteRange.
+ */
public class DiscreteRange<T> implements Range<T> {
private final Class<T> type;
private final Set<T> values;
+ /**
+ * Constructor for this DiscreteRange.
+ * @param type the type of this DiscreteRange.
+ * @param values the initial values of this DiscreteRange.
+ */
public DiscreteRange(final Class<T> type, final Set<T> values) {
this.type = type;
this.values = values;
@@ -23,11 +33,19 @@
return true;
}
+ /**
+ * Returns a Set of all the values for this DiscreteRange.
+ * @return a Set of all the values for this DiscreteRange.
+ */
public Set<T> values() {
// This is immutable to prevent add/remove operation by 3rd
party developers.
return Collections.unmodifiableSet(values);
}
+ /**
+ * Add a value to this DiscreteRange.
+ * @param newValue the value to add to the range.
+ */
public void addRangeValue(final T newValue) {
values.add(newValue);
}
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/NullDataType.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/NullDataType.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/NullDataType.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -3,7 +3,7 @@
/**
* An empty/null data type marker interface for Visual Properties holding no
actual data.
* Root Visual Properties have this data type.
- *
+ * @CyAPI.Api.Interface
*/
public interface NullDataType {
// No methods are defined.
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/Range.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -1,5 +1,10 @@
package org.cytoscape.view.model;
+/**
+ * Defines a range of values for {@link VisualProperty}s.
+ *
+ * @param <T> The generic type of this Range.
+ */
public interface Range<T> {
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/View.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -66,7 +66,7 @@
*
* @param <T> Object type of the Visual Property (Color, Double, ...)
*
- * @param vp the VisualProperty
+ * @param vp the VisualProperty.
* @return Value associated with this View and Visual Property pair.
*/
<T> T getVisualProperty(VisualProperty<T> vp);
@@ -83,8 +83,9 @@
/**
+ * Returns true if current VisualProperty value is locked.
* @param vp the VisualProperty
- * @return true if current VisualProperty value is locked
+ * @return true if current VisualProperty value is locked.
*/
boolean isValueLocked(VisualProperty<?> vp);
@@ -92,7 +93,7 @@
/**
* Clear value lock for given VisualProperty.
*
- * @param vp the VisualProperty
+ * @param vp the VisualProperty.
*/
void clearValueLock(VisualProperty<?> vp);
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexicon.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -93,8 +93,7 @@
/**
* Get collection of visual properties for a given object type
(node/edge/network).
*
- * @param prop
- * any visual property
+ * @param prop any visual property
*
* @return Collection of visual properties for the type.
*/
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexiconNode.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexiconNode.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualLexiconNode.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -10,7 +10,7 @@
* <p>
* All data fields are immutable.
*
- *
+ * @CyAPI.Final.Class
*/
public final class VisualLexiconNode {
@@ -21,6 +21,11 @@
private boolean isDepend;
+ /**
+ * Constructs this VisualLexiconNode.
+ * @param vp the {@link VisualProperty} to wrap.
+ * @param parent this VisualLexiconNodes parent VisualLexiconNode.
+ */
public VisualLexiconNode(final VisualProperty<?> vp, final
VisualLexiconNode parent) {
if(vp == null)
throw new NullPointerException("Visual Property cannot
be null.");
@@ -36,10 +41,18 @@
}
+ /**
+ * Sets the dependency of this VisualLexiconNode.
+ * @param depend True to make this VisualLexiconNode dependent on its
parent, false otherwise.
+ */
public void setDependency(boolean depend) {
this.isDepend = depend;
}
+ /**
+ * Returns true if this VisualLexiconNode is dependent on its parent.
+ * @return true if this VisualLexiconNode is dependent on its parent.
+ */
public boolean isDepend() {
return isDepend;
}
@@ -70,7 +83,7 @@
/**
* Returns collection of all children of this node.
*
- * @return collection of all children
+ * @return collection of all children of this node.
*/
public Collection<VisualLexiconNode> getChildren() {
return children;
Modified:
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
===================================================================
---
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
2011-10-29 21:47:44 UTC (rev 27344)
+++
core3/api/trunk/viewmodel-api/src/main/java/org/cytoscape/view/model/VisualProperty.java
2011-10-29 22:14:21 UTC (rev 27345)
@@ -41,7 +41,8 @@
*
* Visual Property itself does NOT have any hierarchy/dependency. It will be
implemented in VisualLexicon.
*
- * @param <T> the dataType of the VisualProperty, ie. what kind of objects are
the values
+ * @param <T> the dataType of the VisualProperty, i.e. what kind of objects
are the values
+ * @CyAPI.Api.Interface
*/
public interface VisualProperty<T> {
@@ -53,24 +54,24 @@
/**
- * The default value of this property. This value is immutable.
- * @return The default value of this property.
+ * The default value of this property. This value is immutable.
+ * @return The default value of this property.
*/
T getDefault();
/**
- * A short string used to identify this visual property and suitable for
- * serializing to XML and other text formats.
- * @return A short string used to identify this visual property and
suitable for serialization.
+ * Returns a short string used to identify this visual property and
suitable for
+ * serializing to XML and other text formats.
+ * @return A short string used to identify this visual property and
suitable for serialization.
*/
String getIdString();
/**
- * A short string suitable for presentation to humans. Should not be
used
- * for serialization.
- * @return A short string suitable for presentation to humans.
+ * Returns a short string suitable for presentation to humans. Should
not be used
+ * for serialization.
+ * @return A short string suitable for presentation to humans.
*/
String getDisplayName();
@@ -98,8 +99,8 @@
/**
* In some cases, default value from visual style is not suitable, such
as x, y, z location of nodes.
- * If this flag is on, it will be ignored and it will be controlled by
mapping only.
- * @return true if the default value should be ignored (as with x,y,z
locations) and false otherwise.
+ * If this flag is on, it will be ignored and it will be controlled by
mapping only.
+ * @return true if the default value should be ignored (as with x,y,z
locations) and false otherwise.
*/
boolean shouldIgnoreDefault();
--
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.
