| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Wed Aug 14 17:37:15 PDT 2019 --> |
| <title>DisplayData.Builder (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DisplayData.Builder (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html" title="class in org.apache.beam.sdk.transforms.display"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Identifier.html" title="class in org.apache.beam.sdk.transforms.display"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" target="_top">Frames</a></li> |
| <li><a href="DisplayData.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.transforms.display</div> |
| <h2 title="Interface DisplayData.Builder" class="title">Interface DisplayData.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">DisplayData.Builder</span></pre> |
| <div class="block">Utility to build up display data from a component and its included subcomponents.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html#add-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-">add</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><?> item)</code> |
| <div class="block">Register the given display item.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html#addIfNotDefault-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-T-">addIfNotDefault</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><T> item, |
| T defaultValue)</code> |
| <div class="block">Register the given display item if the value is different than the specified default.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html#addIfNotNull-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-">addIfNotNull</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><?> item)</code> |
| <div class="block">Register the given display item if the value is not null.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html#delegate-org.apache.beam.sdk.transforms.display.HasDisplayData-">delegate</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a> component)</code> |
| <div class="block">Register display data from the specified component on behalf of the current component.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html#include-java.lang.String-org.apache.beam.sdk.transforms.display.HasDisplayData-">include</a></span>(java.lang.String path, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a> subComponent)</code> |
| <div class="block">Register display data from the specified subcomponent at the given path.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="include-java.lang.String-org.apache.beam.sdk.transforms.display.HasDisplayData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>include</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> include(java.lang.String path, |
| <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a> subComponent)</pre> |
| <div class="block">Register display data from the specified subcomponent at the given path. For example, a |
| <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> which delegates to a user-provided function can implement <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a> on the function and include it from the <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>: |
| |
| <pre><code> @Override |
| public void populateDisplayData(DisplayData.Builder builder) { |
| super.populateDisplayData(builder); |
| |
| builder |
| // To register the class name of the userFn |
| .add(DisplayData.item("userFn", userFn.getClass())) |
| // To allow the userFn to register additional display data |
| .include("userFn", userFn); |
| } |
| </code></pre> |
| |
| <p>Using <code>include(path, subcomponent)</code> will associate each of the registered items with |
| the namespace of the <code>subcomponent</code> being registered, with the specified path element |
| relative to the current path. To register display data in the current path and namespace, |
| such as from a base class implementation, use <code>subcomponent.populateDisplayData(builder)</code> instead.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"><code>HasDisplayData.populateDisplayData(DisplayData.Builder)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delegate-org.apache.beam.sdk.transforms.display.HasDisplayData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delegate</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> delegate(<a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a> component)</pre> |
| <div class="block">Register display data from the specified component on behalf of the current component. |
| Display data items will be added with the subcomponent namespace but the current component |
| path. |
| |
| <p>This is useful for components which simply wrap other components and wish to retain the |
| display data from the wrapped component. Such components should implement <code>populateDisplayData</code> as: |
| |
| <pre><code> @Override |
| public void populateDisplayData(DisplayData.Builder builder) { |
| builder.delegate(wrapped); |
| } |
| </code></pre></div> |
| </li> |
| </ul> |
| <a name="add-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> add(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><?> item)</pre> |
| <div class="block">Register the given display item.</div> |
| </li> |
| </ul> |
| <a name="addIfNotNull-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIfNotNull</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> addIfNotNull(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><?> item)</pre> |
| <div class="block">Register the given display item if the value is not null.</div> |
| </li> |
| </ul> |
| <a name="addIfNotDefault-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-java.lang.Object-"> |
| <!-- --> |
| </a><a name="addIfNotDefault-org.apache.beam.sdk.transforms.display.DisplayData.ItemSpec-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addIfNotDefault</h4> |
| <pre><T> <a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> addIfNotDefault(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.ItemSpec.html" title="class in org.apache.beam.sdk.transforms.display">DisplayData.ItemSpec</a><T> item, |
| @Nullable |
| T defaultValue)</pre> |
| <div class="block">Register the given display item if the value is different than the specified default.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html" title="class in org.apache.beam.sdk.transforms.display"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Identifier.html" title="class in org.apache.beam.sdk.transforms.display"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" target="_top">Frames</a></li> |
| <li><a href="DisplayData.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
