Author: mes
Date: 2012-04-23 12:22:59 -0700 (Mon, 23 Apr 2012)
New Revision: 28951
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/BoundaryRangeValues.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMappingPoint.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/DiscreteMapping.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/PassthroughMapping.java
Log:
updated javadoc
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -5,23 +5,20 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
/**
- * All fields are immutable.
- *
- * @author kono
- *
+ * A base class for visual mapping functions where all fields are immutable.
* @param <K> Generic type of the attribute mapped.
* @param <V> Generic type of the {@link VisualProperty} used in this mapping.
* @CyAPI.Abstract.Class
*/
-public abstract class AbstractVisualMappingFunction<K, V> implements
- VisualMappingFunction<K, V> {
+public abstract class AbstractVisualMappingFunction<K, V> implements
VisualMappingFunction<K, V> {
- /** Mapping attribute name. This is immutable. */
+ /** Mapping attribute name.*/
protected final String attrName;
/** Type of attribute. */
protected final Class<K> attrType;
-
+
+ /** The table used for this mapping. */
protected final CyTable table;
/** Visual Property used in this mapping. */
@@ -30,8 +27,9 @@
/**
* Constructs this AbstractVisualMappingFunction.
- * @param attrName Mapping attribute name.
- * @param attrType Type of attribute.
+ * @param attrName Mapping attribute column name.
+ * @param attrType Type of attribute column.
+ * @param table The table used to find the column.
* @param vp Visual Property used in this mapping.
*/
public AbstractVisualMappingFunction(final String attrName, final
Class<K> attrType, final CyTable table,
@@ -42,20 +40,24 @@
this.table = table;
}
- @Override public String getMappingColumnName() {
+ @Override
+ public String getMappingColumnName() {
return attrName;
}
- @Override public Class<K> getMappingColumnType() {
+ @Override
+ public Class<K> getMappingColumnType() {
return attrType;
}
- @Override public VisualProperty<V> getVisualProperty() {
+ @Override
+ public VisualProperty<V> getVisualProperty() {
return vp;
}
- @Override public CyTable getMappingTable() {
+ @Override
+ public CyTable getMappingTable() {
return table;
}
}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/BoundaryRangeValues.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/BoundaryRangeValues.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/BoundaryRangeValues.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -35,16 +35,9 @@
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
-// BoundaryRangeValues.java
-//----------------------------------------------------------------------------
-// $Revision: 10059 $
-// $Date: 2007-04-20 16:29:49 -0700 (Fri, 20 Apr 2007) $
-// $Author: kono $
-//----------------------------------------------------------------------------
package org.cytoscape.view.vizmap.mappings;
-//----------------------------------------------------------------------------
/**
* This class defines a data object representing the range values associated
* with a particular domain value, called a boundary value. The domain value is
@@ -81,12 +74,9 @@
/**
* Creates a new BoundaryRangeValues object.
*
- * @param lesser
- * Object used for values less than this point.
- * @param equal
- * Object used for value equal to this point.
- * @param greater
- * Object used for values greater than this point.
+ * @param lesser Object used for values less than this point.
+ * @param equal Object used for value equal to this point.
+ * @param greater Object used for values greater than this point.
*/
public BoundaryRangeValues(T lesser, T equal, T greater) {
lesserValue = lesser;
@@ -105,9 +95,6 @@
this.greaterValue = original.greaterValue;
}
- /**
- * {@inheritDoc}
- */
@Override
public String toString() {
return "{" + lesserValue.toString() + "," +
equalValue.toString() +
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -5,13 +5,15 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
/**
- *
- * @param <K>
- * @param <V>
+ * An interface describing a continuous mapping from attribute value
+ * to visual property.
+ * @param <K> Generic type of the attribute mapped.
+ * @param <V> Generic type of the VisualProperty used in this mapping.
* @CyAPI.Api.Interface
*/
public interface ContinuousMapping<K, V> extends VisualMappingFunction<K,V>{
+ /** A label string for this mapping. */
public static final String CONTINUOUS = "Continuous Mapping";
/**
@@ -41,10 +43,9 @@
/**
* Gets Specified Point.
*
- * @param index
- * Index Value.
+ * @param index Index Value.
* @return ContinuousMappingPoint.
*/
public ContinuousMappingPoint<K, V> getPoint(int index);
-}
\ No newline at end of file
+}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMappingPoint.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMappingPoint.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMappingPoint.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -35,19 +35,14 @@
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
-//----------------------------------------------------------------------------
-// $Revision: 10980 $
-// $Date: 2007-07-17 10:16:16 -0700 (Tue, 17 Jul 2007) $
-// $Author: kono $
-//----------------------------------------------------------------------------
package org.cytoscape.view.vizmap.mappings;
import org.cytoscape.view.vizmap.mappings.BoundaryRangeValues;
-
/**
* Encapsulates a ContinuousMapping Point with a single point value
* and associated {@link BoundaryRangeValues}.
+ * @param <K> Generic type of the attribute mapped.
* @param <V> The generic type of associated {@link BoundaryRangeValues}.
* @CyAPI.Final.Class
*/
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/DiscreteMapping.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/DiscreteMapping.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/DiscreteMapping.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -5,13 +5,15 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
/**
- *
- * @param <K>
- * @param <V>
+ * An interface describing a discrete mapping from attribute value
+ * to visual property.
+ * @param <K> Generic type of the attribute mapped.
+ * @param <V> Generic type of the VisualProperty used in this mapping.
* @CyAPI.Api.Interface
*/
public interface DiscreteMapping<K, V> extends VisualMappingFunction<K,V>{
+ /** A label string describing the mapping. */
public static final String DISCRETE = "Discrete Mapping";
/**
@@ -47,4 +49,4 @@
*/
public Map<K, V> getAll();
-}
\ No newline at end of file
+}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/PassthroughMapping.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/PassthroughMapping.java
2012-04-23 19:13:14 UTC (rev 28950)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/PassthroughMapping.java
2012-04-23 19:22:59 UTC (rev 28951)
@@ -3,13 +3,15 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
/**
- *
- * @param <K>
- * @param <V>
+ * An interface describing a passthrough or identity mapping from attribute
value
+ * to visual property.
+ * @param <K> Generic type of the attribute mapped.
+ * @param <V> Generic type of the VisualProperty used in this mapping.
* @CyAPI.Api.Interface
*/
public interface PassthroughMapping<K, V> extends VisualMappingFunction<K,V> {
+ /** A label describing the mapping. */
public static final String PASSTHROUGH = "Passthrough Mapping";
-}
\ No newline at end of file
+}
--
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.
