Author: mkirby
Date: 2011-11-04 00:06:08 -0700 (Fri, 04 Nov 2011)
New Revision: 27403
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunction.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyleFactory.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedEvent.java
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
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:
Fixed Javadoc.
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunction.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunction.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunction.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -65,7 +65,7 @@
* be any objects)
* @param <V>
* Visual property value type. (can be any type)
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualMappingFunction<K, V> {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingFunctionFactory.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -5,7 +5,7 @@
/**
* Factory for {@linkplain VisualMappingFunction}s. Implementation of this will
* be provided as an service. One mapping type should have one factory.
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualMappingFunctionFactory {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualMappingManager.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -52,7 +52,7 @@
* JavaDoc for {@linkplain VisualStyleAddedEvent} and
* {@linkplain VisualStyleAboutToBeRemovedEvent}.
* </p>
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualMappingManager {
@@ -109,6 +109,9 @@
*/
VisualStyle getDefaultVisualStyle();
+ /** Returns a Set of all {@link VisualLexicon}s.
+ * @return a Set of all {@link VisualLexicon}s.
+ */
Set<VisualLexicon> getAllVisualLexicon();
}
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyle.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -44,7 +44,7 @@
/**
* A VisualStyle is a collection of {@linkplain VisualMappingFunction}s and
default values
* that define how a set of attributes is mapped to visual properties of View
objects.
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualStyle {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyleFactory.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyleFactory.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/VisualStyleFactory.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -3,7 +3,7 @@
/**
* Factory for {@linkplain VisualStyle}s. This object will be provided as an
OSGi service.
- *
+ * @CyAPI.Api.Interface
*/
public interface VisualStyleFactory {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedEvent.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -41,6 +41,7 @@
/**
* This event will be fired when {@linkplain VisualStyle} object is removed
from
* {@linkplain VisualMappingManager}.
+ * @CyAPI.Final.Class
*/
public final class VisualStyleAboutToBeRemovedEvent extends
AbstractCyEvent<VisualMappingManager> {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAboutToBeRemovedListener.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -38,6 +38,7 @@
/**
* Listener for {@linkplain VisualStyleAboutToBeRemovedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface VisualStyleAboutToBeRemovedListener extends CyListener {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedEvent.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedEvent.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedEvent.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -41,7 +41,7 @@
/**
* When new {@linkplain VisualStyle} is added to the {@link
VisualMappingManager},
* it fires this event.
- *
+ * @CyAPI.Final.Class
*/
public final class VisualStyleAddedEvent extends
AbstractCyEvent<VisualMappingManager> {
Modified:
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
===================================================================
---
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/events/VisualStyleAddedListener.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -38,6 +38,7 @@
/**
* Listener for {@linkplain VisualStyleAddedEvent}.
+ * @CyAPI.Spi.Interface
*/
public interface VisualStyleAddedListener extends CyListener {
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/AbstractVisualMappingFunction.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -8,8 +8,9 @@
*
* @author kono
*
- * @param <K>
- * @param <V>
+ * @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> {
@@ -24,6 +25,12 @@
protected final VisualProperty<V> vp;
+ /**
+ * Constructs this AbstractVisualMappingFunction.
+ * @param attrName Mapping attribute name.
+ * @param attrType Type of attribute.
+ * @param vp Visual Property used in this mapping.
+ */
public AbstractVisualMappingFunction(final String attrName, final
Class<K> attrType,
final VisualProperty<V> vp) {
this.attrType = attrType;
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/BoundaryRangeValues.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -59,6 +59,7 @@
* interpolation above and below the same domain value, plus allow a distinctly
* different value for exact matches.
* @param <T> the generic type for this BoundaryRangeValues.
+ * @CyAPI.Final.Class
*/
public final class BoundaryRangeValues<T> {
/**
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMapping.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -4,6 +4,12 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
+/**
+ *
+ * @param <K>
+ * @param <V>
+ * @CyAPI.Api.Interface
+ */
public interface ContinuousMapping<K, V> extends VisualMappingFunction<K,V>{
public static final String CONTINUOUS = "Continuous Mapping";
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/ContinuousMappingPoint.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -47,8 +47,9 @@
/**
* Encapsulates a ContinuousMapping Point with a single point value
- * and associated BoundaryRangeValues.
- *
+ * and associated {@link BoundaryRangeValues}.
+ * @param <V> The generic type of associated {@link BoundaryRangeValues}.
+ * @CyAPI.Final.Class
*/
public final class ContinuousMappingPoint<K, V> {
private K value;
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/DiscreteMapping.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -4,6 +4,12 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
+/**
+ *
+ * @param <K>
+ * @param <V>
+ * @CyAPI.Api.Interface
+ */
public interface DiscreteMapping<K, V> extends VisualMappingFunction<K,V>{
public static final String DISCRETE = "Discrete Mapping";
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
2011-11-04 06:58:00 UTC (rev 27402)
+++
core3/api/trunk/vizmap-api/src/main/java/org/cytoscape/view/vizmap/mappings/PassthroughMapping.java
2011-11-04 07:06:08 UTC (rev 27403)
@@ -2,6 +2,12 @@
import org.cytoscape.view.vizmap.VisualMappingFunction;
+/**
+ *
+ * @param <K>
+ * @param <V>
+ * @CyAPI.Api.Interface
+ */
public interface PassthroughMapping<K, V> extends VisualMappingFunction<K,V> {
public static final String PASSTHROUGH = "Passthrough Mapping";
--
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.
