Refactor ViewDescriptor. (#424)

Author: songy23

core/src/main/java/io/opencensus/stats/RpcViewConstants.java

@@ -21,21 +21,21 @@
 import javax.annotation.concurrent.Immutable;
 
 /**
- * A ViewDescriptor specifies an aggregation and a set of tag keys. The aggregation will be broken
- * down by the unique set of matching tag values for each measurement.
+ * A View specifies an aggregation and a set of tag keys. The aggregation will be broken
+ * down by the unique set of matching tag values for each measure.
  */
 @Immutable
-public abstract class ViewDescriptor {
+public abstract class View {
   /**
    * Name of view. Must be unique.
    */
-  public abstract Name getViewDescriptorName();
+  public abstract Name getViewName();
 
   /**
    * Name of view, as a {@code String}.
    */
   public final String getName() {
-    return getViewDescriptorName().asString();
+    return getViewName().asString();
   }
 
   /**
@@ -44,30 +44,30 @@ public final String getName() {
   public abstract String getDescription();
 
   /**
-   * Measurement type of this view.
+   * Measure type of this view.
    */
   public abstract Measure getMeasure();
 
   /**
-   * Tag keys to match with the associated {@link Measure}. If no keys are specified,
-   * then all stats are recorded. Keys must be unique.
+   * Dimensions (a.k.a Tag Keys) to match with the associated {@link Measure}.
+   * If no dimensions are specified, then all stats are recorded. Dimensions must be unique.
    *
    * <p>Note: The returned list is unmodifiable, attempts to update it will throw an
    * UnsupportedOperationException.
    */
-  public abstract List<TagKey> getTagKeys();
+  public abstract List<TagKey> getDimensions();
 
   /**
    * Applies the given match function to the underlying data type.
    */
   public abstract <T> T match(
-      Function<DistributionViewDescriptor, T> p0,
-      Function<IntervalViewDescriptor, T> p1);
+      Function<? super DistributionView, T> p0,
+      Function<? super IntervalView, T> p1);
 
   /**
-   * The name of a {@code ViewDescriptor}.
+   * The name of a {@code View}.
    */
-  // This type should be used as the key when associating data with ViewDescriptors.
+  // This type should be used as the key when associating data with Views.
   @Immutable
   @AutoValue
   public abstract static class Name {
@@ -82,26 +82,26 @@ public abstract static class Name {
     public abstract String asString();
 
     /**
-     * Creates a {@code ViewDescriptor.Name} from a {@code String}.
+     * Creates a {@code View.Name} from a {@code String}.
      *
      * @param name the name {@code String}.
-     * @return a {@code ViewDescriptor.Name} with the given name {@code String}.
+     * @return a {@code View.Name} with the given name {@code String}.
      */
     public static Name create(String name) {
-      return new AutoValue_ViewDescriptor_Name(name);
+      return new AutoValue_View_Name(name);
     }
   }
 
   /**
-   * A {@link ViewDescriptor} for distribution-base aggregations.
+   * A {@link View} for distribution-base aggregations.
    */
   @Immutable
   @AutoValue
-  public abstract static class DistributionViewDescriptor extends ViewDescriptor {
+  public abstract static class DistributionView extends View {
     /**
-     * Constructs a new {@link DistributionViewDescriptor}.
+     * Constructs a new {@link DistributionView}.
      */
-    public static DistributionViewDescriptor create(
+    public static DistributionView create(
         String name,
         String description,
         Measure measure,
@@ -116,15 +116,15 @@ public static DistributionViewDescriptor create(
     }
 
     /**
-     * Constructs a new {@link DistributionViewDescriptor}.
+     * Constructs a new {@link DistributionView}.
      */
-    public static DistributionViewDescriptor create(
+    public static DistributionView create(
         Name name,
         String description,
         Measure measure,
         DistributionAggregationDescriptor distributionAggregationDescriptor,
         List<TagKey> tagKeys) {
-      return new AutoValue_ViewDescriptor_DistributionViewDescriptor(
+      return new AutoValue_View_DistributionView(
           name,
           description,
           measure,
@@ -134,28 +134,28 @@ public static DistributionViewDescriptor create(
 
     /**
      * The {@link DistributionAggregationDescriptor} associated with this
-     * {@link DistributionViewDescriptor}.
+     * {@link DistributionView}.
      */
     public abstract DistributionAggregationDescriptor getDistributionAggregationDescriptor();
 
     @Override
     public <T> T match(
-        Function<DistributionViewDescriptor, T> p0,
-        Function<IntervalViewDescriptor, T> p1) {
+        Function<? super DistributionView, T> p0,
+        Function<? super IntervalView, T> p1) {
       return p0.apply(this);
     }
   }
 
   /**
-   * A {@link ViewDescriptor} for interval-based aggregations.
+   * A {@link View} for interval-based aggregations.
    */
   @Immutable
   @AutoValue
-  public abstract static class IntervalViewDescriptor extends ViewDescriptor {
+  public abstract static class IntervalView extends View {
     /**
-     * Constructs a new {@link IntervalViewDescriptor}.
+     * Constructs a new {@link IntervalView}.
      */
-    public static IntervalViewDescriptor create(
+    public static IntervalView create(
         String name,
         String description,
         Measure measure,
@@ -170,15 +170,15 @@ public static IntervalViewDescriptor create(
     }
 
     /**
-     * Constructs a new {@link IntervalViewDescriptor}.
+     * Constructs a new {@link IntervalView}.
      */
-    public static IntervalViewDescriptor create(
+    public static IntervalView create(
         Name name,
         String description,
         Measure measure,
         IntervalAggregationDescriptor intervalAggregationDescriptor,
         List<TagKey> tagKeys) {
-      return new AutoValue_ViewDescriptor_IntervalViewDescriptor(
+      return new AutoValue_View_IntervalView(
           name,
           description,
           measure,
@@ -188,14 +188,14 @@ public static IntervalViewDescriptor create(
 
     /**
      * The {@link IntervalAggregationDescriptor} associated with this
-     * {@link IntervalViewDescriptor}.
+     * {@link IntervalView}.
      */
     public abstract IntervalAggregationDescriptor getIntervalAggregationDescriptor();
 
     @Override
     public <T> T match(
-        Function<DistributionViewDescriptor, T> p0,
-        Function<IntervalViewDescriptor, T> p1) {
+        Function<? super DistributionView, T> p0,
+        Function<? super IntervalView, T> p1) {
       return p1.apply(this);
     }
   }

…/io/opencensus/stats/ViewDescriptor.java …/main/java/io/opencensus/stats/View.javacore/src/main/java/io/opencensus/stats/ViewDescriptor.java renamed to core/src/main/java/io/opencensus/stats/View.java core/src/main/java/io/opencensus/stats/ViewDescriptor.java renamed to core/src/main/java/io/opencensus/stats/View.java

@@ -16,22 +16,22 @@
 import com.google.auto.value.AutoValue;
 import io.opencensus.common.Function;
 import io.opencensus.common.Timestamp;
-import io.opencensus.stats.ViewDescriptor.DistributionViewDescriptor;
-import io.opencensus.stats.ViewDescriptor.IntervalViewDescriptor;
+import io.opencensus.stats.View.DistributionView;
+import io.opencensus.stats.View.IntervalView;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import javax.annotation.concurrent.Immutable;
 
 /**
- * The aggregated data for a particular {@link ViewDescriptor}.
+ * The aggregated data for a particular {@link View}.
  */
 @Immutable
 public abstract class ViewData {
   /**
-   * The {@link ViewDescriptor} associated with this {@link ViewData}.
+   * The {@link View} associated with this {@link ViewData}.
    */
-  public abstract ViewDescriptor getViewDescriptor();
+  public abstract View getView();
 
   /**
    * Applies the given match function to the underlying data type.
@@ -53,7 +53,7 @@ public abstract static class DistributionViewData extends ViewData {
     /**
      * Constructs a new {@link DistributionViewData}.
      */
-    public static DistributionViewData create(DistributionViewDescriptor distributionView,
+    public static DistributionViewData create(DistributionView distributionView,
         List<DistributionAggregation> distributionAggregations, Timestamp start, Timestamp end) {
       return new AutoValue_ViewData_DistributionViewData(
           distributionView,
@@ -64,7 +64,7 @@ public static DistributionViewData create(DistributionViewDescriptor distributio
     }
 
     @Override
-    public abstract DistributionViewDescriptor getViewDescriptor();
+    public abstract DistributionView getView();
 
     /**
      * The {@link DistributionAggregation}s associated with this {@link DistributionViewData}.
@@ -101,15 +101,15 @@ public abstract static class IntervalViewData extends ViewData {
     /**
      * Constructs a new {@link IntervalViewData}.
      */
-    public static IntervalViewData create(IntervalViewDescriptor intervalView,
+    public static IntervalViewData create(IntervalView intervalView,
         List<IntervalAggregation> intervalAggregations) {
       return new AutoValue_ViewData_IntervalViewData(
           intervalView,
           Collections.unmodifiableList(new ArrayList<IntervalAggregation>(intervalAggregations)));
     }
 
     @Override
-    public abstract IntervalViewDescriptor getViewDescriptor();
+    public abstract IntervalView getView();
 
     /**
      * The {@link IntervalAggregation}s associated with this {@link IntervalViewData}.

core/src/main/java/io/opencensus/stats/ViewData.java

@@ -14,19 +14,19 @@
 package io.opencensus.stats;
 
 /**
- * Provides facilities to register {@link ViewDescriptor}s for collecting stats and retrieving
+ * Provides facilities to register {@link View}s for collecting stats and retrieving
  * stats data as a {@link ViewData}.
  */
 public abstract class ViewManager {
   /**
-   * Pull model for stats. Registers a {@link ViewDescriptor} that will collect data to be accessed
-   * via {@link #getView(ViewDescriptor)}.
+   * Pull model for stats. Registers a {@link View} that will collect data to be accessed
+   * via {@link #getView(View)}.
    */
-  public abstract void registerView(ViewDescriptor viewDescriptor);
+  public abstract void registerView(View view);
 
   /**
    * Returns the current stats data, {@link ViewData}, associated with the given
-   * {@link ViewDescriptor}.
+   * {@link View}.
    */
-  public abstract ViewData getView(ViewDescriptor viewDescriptor);
+  public abstract ViewData getView(View view);
 }

core/src/main/java/io/opencensus/stats/ViewManager.java

@@ -24,8 +24,8 @@
 import io.opencensus.stats.IntervalAggregation.Interval;
 import io.opencensus.stats.ViewData.DistributionViewData;
 import io.opencensus.stats.ViewData.IntervalViewData;
-import io.opencensus.stats.ViewDescriptor.DistributionViewDescriptor;
-import io.opencensus.stats.ViewDescriptor.IntervalViewDescriptor;
+import io.opencensus.stats.View.DistributionView;
+import io.opencensus.stats.View.IntervalView;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -40,8 +40,8 @@ public final class ViewDataTest {
   public void testDistributionViewData() {
     DistributionAggregationDescriptor aggregationDescriptor =
         DistributionAggregationDescriptor.create(Arrays.asList(10.0, 20.0, 30.0, 40.0));
-    final DistributionViewDescriptor view =
-        DistributionViewDescriptor.create(
+    final DistributionView view =
+        DistributionView.create(
             name, description, measure, aggregationDescriptor, tagKeys);
     final List<DistributionAggregation> aggregations = Arrays.asList(
         DistributionAggregation.create(5, 5.0, 15.0, Range.create(1.0, 5.0), tags1,
@@ -52,12 +52,12 @@ public void testDistributionViewData() {
     final Timestamp end = Timestamp.fromMillis(2000);
     final ViewData viewData = DistributionViewData.create(view, aggregations, start, end);
 
-    assertThat(viewData.getViewDescriptor()).isEqualTo(view);
+    assertThat(viewData.getView()).isEqualTo(view);
     assertTrue(viewData.match(
         new Function<DistributionViewData, Boolean> () {
           @Override public Boolean apply(DistributionViewData dViewData) {
             return dViewData == viewData
-                && dViewData.getViewDescriptor().equals(view)
+                && dViewData.getView().equals(view)
                 && shallowListEquals(dViewData.getDistributionAggregations(), aggregations)
                 && dViewData.getStart().equals(start)
                 && dViewData.getEnd().equals(end);
@@ -74,8 +74,8 @@ && shallowListEquals(dViewData.getDistributionAggregations(), aggregations)
   public void testIntervalViewData() {
     IntervalAggregationDescriptor aggregationDescriptor =
         IntervalAggregationDescriptor.create(Arrays.asList(Duration.fromMillis(111)));
-    final IntervalViewDescriptor view =
-        IntervalViewDescriptor.create(
+    final IntervalView view =
+        IntervalView.create(
             name, description, measure, aggregationDescriptor, tagKeys);
     final List<IntervalAggregation> aggregations = Arrays.asList(
         IntervalAggregation.create(tags1, Arrays.asList(
@@ -84,7 +84,7 @@ public void testIntervalViewData() {
             Interval.create(Duration.fromMillis(111), 10, 100))));
 
     final ViewData viewData = IntervalViewData.create(view, aggregations);
-    assertThat(viewData.getViewDescriptor()).isEqualTo(view);
+    assertThat(viewData.getView()).isEqualTo(view);
     assertTrue(viewData.match(
         new Function<DistributionViewData, Boolean> () {
           @Override public Boolean apply(DistributionViewData dViewData) {
@@ -94,16 +94,16 @@ public void testIntervalViewData() {
         new Function<IntervalViewData, Boolean> () {
           @Override public Boolean apply(IntervalViewData iViewData) {
             return iViewData == viewData
-                && iViewData.getViewDescriptor().equals(view)
+                && iViewData.getView().equals(view)
                 && shallowListEquals(iViewData.getIntervalAggregations(), aggregations);
           }
         }));
   }
 
   @Test
   public void testViewDataEquals() {
-    DistributionViewDescriptor dView =
-        DistributionViewDescriptor.create(
+    DistributionView dView =
+        DistributionView.create(
             name,
             description,
             measure,
@@ -113,8 +113,8 @@ public void testViewDataEquals() {
         Arrays.asList(
             DistributionAggregation.create(
                 5, 5.0, 15.0, Range.create(1.0, 5.0), tags1, Arrays.asList(1L)));
-    IntervalViewDescriptor iView =
-        IntervalViewDescriptor.create(
+    IntervalView iView =
+        IntervalView.create(
             name,
             description,
             measure,