beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bchamb...@apache.org
Subject [2/4] incubator-beam git commit: Normalize comments to refer to 'display data' rather than 'display metadata'
Date Tue, 26 Apr 2016 17:11:56 GMT
Normalize comments to refer to 'display data' rather than 'display metadata'


Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/9d45a4a1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/9d45a4a1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/9d45a4a1

Branch: refs/heads/master
Commit: 9d45a4a11dcf66434c3d434d31900487471dcbe3
Parents: 582befd
Author: Scott Wegner <swegner@google.com>
Authored: Mon Apr 25 09:34:58 2016 -0700
Committer: bchambers <bchambers@google.com>
Committed: Tue Apr 26 09:39:01 2016 -0700

----------------------------------------------------------------------
 .../main/java/org/apache/beam/sdk/io/Sink.java  |  2 +-
 .../java/org/apache/beam/sdk/io/Source.java     |  2 +-
 .../beam/sdk/transforms/CombineFnBase.java      |  4 +-
 .../org/apache/beam/sdk/transforms/DoFn.java    |  2 +-
 .../beam/sdk/transforms/DoFnWithContext.java    |  2 +-
 .../apache/beam/sdk/transforms/PTransform.java  |  2 +-
 .../org/apache/beam/sdk/transforms/ParDo.java   |  2 +-
 .../sdk/transforms/display/ClassForDisplay.java |  4 +-
 .../sdk/transforms/display/DisplayData.java     | 58 ++++++++++----------
 .../sdk/transforms/display/HasDisplayData.java  |  8 +--
 .../beam/sdk/transforms/windowing/WindowFn.java |  2 +-
 11 files changed, 44 insertions(+), 44 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
index 8b6b637..20b1631 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Sink.java
@@ -139,7 +139,7 @@ public abstract class Sink<T> implements Serializable, HasDisplayData
{
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(DisplayData.Builder builder) {}

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Source.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Source.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Source.java
index 2ab0d4e..b8902f9 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Source.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/Source.java
@@ -72,7 +72,7 @@ public abstract class Source<T> implements Serializable, HasDisplayData
{
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(DisplayData.Builder builder) {}

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFnBase.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFnBase.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFnBase.java
index 1b64bb2..c73ba54 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFnBase.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/CombineFnBase.java
@@ -225,7 +225,7 @@ public class CombineFnBase {
      * {@inheritDoc}
      *
      * <p>By default, does not register any display data. Implementors may override
this method
-     * to provide their own display metadata.
+     * to provide their own display data.
      */
     @Override
     public void populateDisplayData(DisplayData.Builder builder) {
@@ -300,7 +300,7 @@ public class CombineFnBase {
      * {@inheritDoc}
      *
      * <p>By default, does not register any display data. Implementors may override
this method
-     * to provide their own display metadata.
+     * to provide their own display data.
      */
     @Override
     public void populateDisplayData(DisplayData.Builder builder) {

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
index 04f272d..6d5d1ed 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
@@ -374,7 +374,7 @@ public abstract class DoFn<InputT, OutputT> implements Serializable,
HasDisplayD
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(DisplayData.Builder builder) {

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnWithContext.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnWithContext.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnWithContext.java
index 7143626..8a83e44 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnWithContext.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnWithContext.java
@@ -421,7 +421,7 @@ public abstract class DoFnWithContext<InputT, OutputT> implements
Serializable,
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(DisplayData.Builder builder) {

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/PTransform.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/PTransform.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/PTransform.java
index d502b93..4bcfb29 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/PTransform.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/PTransform.java
@@ -317,7 +317,7 @@ public abstract class PTransform<InputT extends PInput, OutputT extends
POutput>
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(Builder builder) {

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
index 02464ac..cb1df18 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ParDo.java
@@ -808,7 +808,7 @@ public class ParDo {
     /**
      * {@inheritDoc}
      *
-     * <p>{@link ParDo} registers its internal {@link DoFn} as a subcomponent for display
metadata.
+     * <p>{@link ParDo} registers its internal {@link DoFn} as a subcomponent for display
data.
      * {@link DoFn} implementations can register display data by overriding
      * {@link DoFn#populateDisplayData}.
      */

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/ClassForDisplay.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/ClassForDisplay.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/ClassForDisplay.java
index 455d6e1..3e31c1e 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/ClassForDisplay.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/ClassForDisplay.java
@@ -23,9 +23,9 @@ import java.io.Serializable;
 import java.util.Objects;
 
 /**
- * Display metadata representing a Java class.
+ * Display data representing a Java class.
  *
- * <p>Java classes can be registered as display metadata via
+ * <p>Java classes can be registered as display data via
  * {@link DisplayData.Builder#add(String, ClassForDisplay)}. {@link ClassForDisplay} is
  * serializable, unlike {@link Class} which can fail to serialize for Java 8 lambda functions.
  */

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
index a1037a8..c119057 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/DisplayData.java
@@ -44,7 +44,7 @@ import java.util.Objects;
 import java.util.Set;
 
 /**
- * Static display metadata associated with a pipeline component. Display data is useful for
+ * Static display data associated with a pipeline component. Display data is useful for
  * pipeline runner UIs and diagnostic dashboards to display details about
  * {@link PTransform PTransforms} that make up a pipeline.
  *
@@ -148,41 +148,41 @@ public class DisplayData {
   }
 
   /**
-   * Utility to build up display metadata from a component and its included
+   * Utility to build up display data from a component and its included
    * subcomponents.
    */
   public interface Builder {
     /**
-     * Register display metadata from the specified subcomponent.
+     * Register display data from the specified subcomponent.
      *
      * @see #include(HasDisplayData, String)
      */
     Builder include(HasDisplayData subComponent);
 
     /**
-     * Register display metadata from the specified subcomponent, using the specified namespace.
+     * Register display data from the specified subcomponent, using the specified namespace.
      *
      * @see #include(HasDisplayData, String)
      */
     Builder include(HasDisplayData subComponent, Class<?> namespace);
 
     /**
-     * Register display metadata from the specified subcomponent, using the specified namespace.
+     * Register display data from the specified subcomponent, using the specified namespace.
      *
      * @see #include(HasDisplayData, String)
      */
     Builder include(HasDisplayData subComponent, ClassForDisplay namespace);
 
     /**
-     * Register display metadata from the specified subcomponent, using the specified namespace.
+     * Register display data from the specified subcomponent, using the specified namespace.
      *
-     * <p>For example, a {@link ParDo} transform includes display metadata from the
encapsulated
+     * <p>For example, a {@link ParDo} transform includes display data from the encapsulated
      * {@link DoFn}.
      */
     Builder include(HasDisplayData subComponent, String namespace);
 
     /**
-     * Register the given string display metadata. The metadata item will be registered with
type
+     * Register the given string display data. The metadata item will be registered with
type
      * {@link DisplayData.Type#STRING}, and is identified by the specified key and namespace
from
      * the current transform or component.
      */
@@ -203,7 +203,7 @@ public class DisplayData {
     ItemBuilder addIfNotDefault(String key, @Nullable String value, @Nullable String defaultValue);
 
     /**
-     * Register the given numeric display metadata. The metadata item will be registered
with type
+     * Register the given numeric display data. The metadata item will be registered with
type
      * {@link DisplayData.Type#INTEGER}, and is identified by the specified key and namespace
from
      * the current transform or component.
      */
@@ -224,7 +224,7 @@ public class DisplayData {
     ItemBuilder addIfNotDefault(String key, long value, long defaultValue);
 
     /**
-     * Register the given floating point display metadata. The metadata item will be registered
with
+     * Register the given floating point display data. The metadata item will be registered
with
      * type {@link DisplayData.Type#FLOAT}, and is identified by the specified key and namespace
      * from the current transform or component.
      */
@@ -246,7 +246,7 @@ public class DisplayData {
     ItemBuilder addIfNotDefault(String key, double value, double defaultValue);
 
     /**
-     * Register the given boolean display metadata. The metadata item will be registered
with
+     * Register the given boolean display data. The metadata item will be registered with
      * type {@link DisplayData.Type#BOOLEAN}, and is identified by the specified key and
namespace
      * from the current transform or component.
      */
@@ -267,7 +267,7 @@ public class DisplayData {
     ItemBuilder addIfNotDefault(String key, boolean value, boolean defaultValue);
 
     /**
-     * Register the given timestamp display metadata. The metadata item will be registered
with type
+     * Register the given timestamp display data. The metadata item will be registered with
type
      * {@link DisplayData.Type#TIMESTAMP}, and is identified by the specified key and namespace
from
      * the current transform or component.
      */
@@ -290,7 +290,7 @@ public class DisplayData {
         String key, @Nullable Instant value, @Nullable Instant defaultValue);
 
     /**
-     * Register the given duration display metadata. The metadata item will be registered
with type
+     * Register the given duration display data. The metadata item will be registered with
type
      * {@link DisplayData.Type#DURATION}, and is identified by the specified key and namespace
from
      * the current transform or component.
      */
@@ -313,14 +313,14 @@ public class DisplayData {
         String key, @Nullable Duration value, @Nullable Duration defaultValue);
 
     /**
-     * Register the given class display metadata. The metadata item will be registered with
type
+     * Register the given class display data. The metadata item will be registered with type
      * {@link DisplayData.Type#JAVA_CLASS}, and is identified by the specified key and namespace
      * from the current transform or component.
      */
     ItemBuilder add(String key, Class<?> value);
 
     /**
-     * Register the given class display metadata. The metadata item will be registered with
type
+     * Register the given class display data. The metadata item will be registered with type
      * {@link DisplayData.Type#JAVA_CLASS}, and is identified by the specified key and namespace
      * from the current transform or component.
      */
@@ -356,7 +356,7 @@ public class DisplayData {
     ItemBuilder addIfNotDefault(
         String key, @Nullable ClassForDisplay value, @Nullable ClassForDisplay defaultValue);
   /**
-   * Register the given display metadata with the specified type.
+   * Register the given display data with the specified type.
    *
    * <p> The added display data is identified by the specified key and namespace from
the current
    * transform or component.
@@ -369,7 +369,7 @@ public class DisplayData {
   }
 
   /**
-   * Utility to append optional fields to display metadata, or register additional display
metadata
+   * Utility to append optional fields to display data, or register additional display data
    * items.
    */
   public interface ItemBuilder extends Builder {
@@ -383,7 +383,7 @@ public class DisplayData {
     ItemBuilder withLabel(@Nullable String label);
 
     /**
-     * Add a link URL to the most-recently added display metadata. A link URL is optional
and
+     * Add a link URL to the most-recently added display data. A link URL is optional and
      * can be provided to point the reader to additional details about the metadata.
      *
      * <p>Specifying a null value will clear the URL if it was previously defined.
@@ -391,16 +391,16 @@ public class DisplayData {
     ItemBuilder withLinkUrl(@Nullable String url);
 
     /**
-     * Adds an explicit namespace to the most-recently added display metadata. The namespace
-     * and key uniquely identify the display metadata.
+     * Adds an explicit namespace to the most-recently added display data. The namespace
+     * and key uniquely identify the display data.
      *
      * <p>Leaving the namespace unspecified will default to the registering instance's
class.
      */
     ItemBuilder withNamespace(Class<?> namespace);
 
     /**
-     * Adds an explicit namespace to the most-recently added display metadata. The namespace
-     * and key uniquely identify the display metadata.
+     * Adds an explicit namespace to the most-recently added display data. The namespace
+     * and key uniquely identify the display data.
      *
      * <p>Leaving the namespace unspecified will default to the registering instance's
class.
      */
@@ -408,7 +408,7 @@ public class DisplayData {
   }
 
   /**
-   * A display metadata item. DisplayData items are registered via {@link Builder#add} within
+   * A display data item. DisplayData items are registered via {@link Builder#add} within
    * {@link HasDisplayData#populateDisplayData} implementations. Each metadata item is uniquely
    * identified by the specified key and namespace generated from the registering component's
    * class name.
@@ -456,7 +456,7 @@ public class DisplayData {
     }
 
     /**
-     * Retrieve the {@link DisplayData.Type} of display metadata. All metadata conforms to
a
+     * Retrieve the {@link DisplayData.Type} of display data. All metadata conforms to a
      * predefined set of allowed types.
      */
     @JsonGetter("type")
@@ -501,7 +501,7 @@ public class DisplayData {
 
     /**
      * Retrieve the optional link URL for an item. The URL points to an address where the
reader
-     * can find additional context for the display metadata.
+     * can find additional context for the display data.
      *
      * <p>If no URL was specified, this will return {@code null}.
      */
@@ -561,11 +561,11 @@ public class DisplayData {
   }
 
   /**
-   * Unique identifier for a display metadata item within a component.
+   * Unique identifier for a display data item within a component.
    * Identifiers are composed of the key they are registered with and a namespace generated
from
    * the class of the component which registered the item.
    *
-   * <p>Display metadata registered with the same key from different components will
have different
+   * <p>Display data registered with the same key from different components will have
different
    * namespaces and thus will both be represented in the composed {@link DisplayData}. If
a
    * single component registers multiple metadata items with the same key, only the most
recent
    * item will be retained; previous versions are discarded.
@@ -618,7 +618,7 @@ public class DisplayData {
   }
 
   /**
-   * Display metadata type.
+   * Display data type.
    */
   public enum Type {
     STRING {
@@ -689,7 +689,7 @@ public class DisplayData {
     }
 
     /**
-     * Format the display metadata value into a long string representation, and optionally
+     * Format the display data value into a long string representation, and optionally
      * a shorter representation for display.
      *
      * <p>Internal-only. Value objects can be safely cast to the expected Java type.

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/HasDisplayData.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/HasDisplayData.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/HasDisplayData.java
index b295d97..b264a14 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/HasDisplayData.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/display/HasDisplayData.java
@@ -21,16 +21,16 @@ import org.apache.beam.sdk.transforms.PTransform;
 
 /**
  * Marker interface for {@link PTransform PTransforms} and components used within
- * {@link PTransform PTransforms} to specify display metadata to be used within UIs and diagnostic
+ * {@link PTransform PTransforms} to specify display data to be used within UIs and diagnostic
  * tools.
  *
- * <p>Display metadata is optional and may be collected during pipeline construction.
It should
+ * <p>Display data is optional and may be collected during pipeline construction. It
should
  * only be used to informational purposes. Tools and components should not assume that display
data
  * will always be collected, or that collected display data will always be displayed.
  */
 public interface HasDisplayData {
   /**
-   * Register display metadata for the given transform or component. Metadata can be registered
+   * Register display data for the given transform or component. Metadata can be registered
    * directly on the provided builder, as well as via included sub-components.
    *
    * <pre>
@@ -49,7 +49,7 @@ public interface HasDisplayData {
    * }
    * </pre>
    *
-   * @param builder The builder to populate with display metadata.
+   * @param builder The builder to populate with display data.
    */
   void populateDisplayData(DisplayData.Builder builder);
 }

http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/9d45a4a1/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/WindowFn.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/WindowFn.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/WindowFn.java
index 2eac936..e291bee 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/WindowFn.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/WindowFn.java
@@ -184,7 +184,7 @@ public abstract class WindowFn<T, W extends BoundedWindow>
    * {@inheritDoc}
    *
    * <p>By default, does not register any display data. Implementors may override this
method
-   * to provide their own display metadata.
+   * to provide their own display data.
    */
   @Override
   public void populateDisplayData(DisplayData.Builder builder) {


Mime
View raw message