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 <[email protected]>
Date: 2016-10-27T15:20:56Z
Convert DisplayData include(..) API to nested(..)
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
