[jira] [Commented] (BEAM-767) Add DisplayData builder '.nested(..)' operation

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/BEAM-767?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15612210#comment-15612210 ] 

ASF GitHub Bot commented on BEAM-767:
-------------------------------------

GitHub user swegner opened a pull request:

    https://github.com/apache/incubator-beam/pull/1208

    (WIP) [BEAM-767] Convert DisplayData include(..) API to nested(..)

    Be sure to do all of the following to help us incorporate your contribution
    quickly and easily:
    
     - [ ] Make sure the PR title is formatted like:
       `[BEAM-<Jira issue #>] Description of pull request`
     - [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
           Travis-CI on your fork and ensure the whole test matrix passes).
     - [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
           number, if there is one.
     - [ ] If this contribution is large, please file an Apache
           [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.txt).
    
    ---
    
    In the Java SDK, components can register display data directly, as well as include display data from sub-components via the `include(..)` operation. In #1008, we add 'paths' to display data metadata and also include a `delegate(..)` action.
    
    During the change for paths, we noticed an emerging pattern where components will typically add the `.getClass()` of a subcomponent before including it. We can support this convention better by embedding it in a single configurable operation, `.nested(..)`
    
    So this:
    ```java
    @Override
    public void populateDisplayData(DisplayData.Builder builder) {
      builder
        .add(DisplayData.item("windowFn", windowFn.getClass()))
        .include("windowFn", windowFn)
        .add(DisplayData.item("otherProperty", otherProp));
    }
    ```
    
    becomes this:
    ```java
    @Override
    public void populateDisplayData(DisplayData.Builder builder) {
      builder
        .add(DisplayData.nested("windowFn", windowFn.getClass()))
        .add(DisplayData.item("otherProperty", otherProp));
    }
    ```
    
    See https://github.com/apache/incubator-beam/pull/1088#discussion_r83332515 for more context.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/swegner/incubator-beam displaydata-nested

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-beam/pull/1208.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1208
    
----
commit 5c2125f583a74ba8aa00df79641905063e22ac24
Author: Scott Wegner <sw...@google.com>
Date:   2016-10-27T15:20:56Z

    Convert DisplayData include(..) API to nested(..)

----


> Add DisplayData builder '.nested(..)' operation
> -----------------------------------------------
>
>                 Key: BEAM-767
>                 URL: https://issues.apache.org/jira/browse/BEAM-767
>             Project: Beam
>          Issue Type: Bug
>          Components: sdk-java-core
>            Reporter: Scott Wegner
>            Assignee: Scott Wegner
>
> See: https://github.com/apache/incubator-beam/pull/1088#discussion_r83332515
> In the Java SDK, components can register display data directly, as well as include display data from sub-components via the 'include(..)' operation. In [PR #1008|https://github.com/apache/incubator-beam/pull/1088], we add 'paths' to display data metadata and also include a 'delegate(..)' action.
> During the change for paths, we noticed an emerging pattern where components will typically add the .getClass() of a subcomponent before including it. We can support this convention better by embedding it in a single configurable operation, '.nested(..)'



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)