| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ByTopicRecordTranslator (Storm 2.4.0 API)</title> |
| <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="ByTopicRecordTranslator (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/ByTopicRecordTranslator.html">Use</a></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>Prev Class</li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/DefaultRecordTranslator.html" title="class in org.apache.storm.kafka.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" target="_top">Frames</a></li> |
| <li><a href="ByTopicRecordTranslator.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.storm.kafka.spout</div> |
| <h2 title="Class ByTopicRecordTranslator" class="title">Class ByTopicRecordTranslator<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.kafka.spout.ByTopicRecordTranslator<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<K,V>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>>, <a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><K,V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ByTopicRecordTranslator<K,V></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><K,V></pre> |
| <div class="block"><p>Based off of a given Kafka topic a ConsumerRecord came from it will be translated to a Storm tuple and emitted to a given stream.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.storm.kafka.spout.ByTopicRecordTranslator">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.storm.kafka.spout.RecordTranslator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.storm.kafka.spout.<a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a></h3> |
| <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#DEFAULT_STREAM">DEFAULT_STREAM</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#ByTopicRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-">ByTopicRecordTranslator</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to the default stream.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#ByTopicRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-">ByTopicRecordTranslator</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</code> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to stream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#ByTopicRecordTranslator-org.apache.storm.kafka.spout.RecordTranslator-">ByTopicRecordTranslator</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> defaultTranslator)</code> |
| <div class="block">Create a record translator with the given default translator.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#apply-org.apache.kafka.clients.consumer.ConsumerRecord-">apply</a></span>(org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> record)</code> |
| <div class="block">Translate the ConsumerRecord into a list of objects that can be emitted.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#forTopic-java.lang.String-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-">forTopic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">Configure a translator for a given topic with tuples to be emitted to the default stream.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#forTopic-java.lang.String-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-">forTopic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</code> |
| <div class="block">Configure a translator for a given topic.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#forTopic-java.lang.String-org.apache.storm.kafka.spout.RecordTranslator-">forTopic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> translator)</code> |
| <div class="block">Configure a translator for a given kafka topic.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#getFieldsFor-java.lang.String-">getFieldsFor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</code> |
| <div class="block">Get the fields associated with a stream.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#streams--">streams</a></span>()</code> |
| <div class="block">Get the list of streams this translator will handle.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ByTopicRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ByTopicRecordTranslator</h4> |
| <pre>public ByTopicRecordTranslator(<a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</pre> |
| <div class="block"><p>Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to stream. This will handle all topics not explicitly set elsewhere.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dd><code>stream</code> - the stream to emit these fields on.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ByTopicRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ByTopicRecordTranslator</h4> |
| <pre>public ByTopicRecordTranslator(<a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>Create a simple record translator that will use func to extract the fields of the tuple, named by fields, and emit them to the default stream. This will handle all topics not explicitly set elsewhere.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ByTopicRecordTranslator-org.apache.storm.kafka.spout.RecordTranslator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ByTopicRecordTranslator</h4> |
| <pre>public ByTopicRecordTranslator(<a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> defaultTranslator)</pre> |
| <div class="block"><p>Create a record translator with the given default translator.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>defaultTranslator</code> - a translator that will be used for all topics not explicitly set with one of the variants of <a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html#forTopic-java.lang.String-org.apache.storm.kafka.spout.RecordTranslator-"><code>forTopic(java.lang.String, org.apache.storm.kafka.spout.RecordTranslator)</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="forTopic-java.lang.String-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forTopic</h4> |
| <pre>public <a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> forTopic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>Configure a translator for a given topic with tuples to be emitted to the default stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topic</code> - the topic this should be used for</dd> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match any already configured Fields for the same stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forTopic-java.lang.String-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forTopic</h4> |
| <pre>public <a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> forTopic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</pre> |
| <div class="block"><p>Configure a translator for a given topic.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topic</code> - the topic this should be used for</dd> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dd><code>stream</code> - the stream to emit the tuples to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match any already configured Fields for the same stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forTopic-java.lang.String-org.apache.storm.kafka.spout.RecordTranslator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forTopic</h4> |
| <pre>public <a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> forTopic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| <a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> translator)</pre> |
| <div class="block"><p>Configure a translator for a given kafka topic.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topic</code> - the topic this translator should handle</dd> |
| <dd><code>translator</code> - the translator itself</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match any already configured Fields for the same stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="apply-org.apache.kafka.clients.consumer.ConsumerRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> apply(org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> record)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#apply-org.apache.kafka.clients.consumer.ConsumerRecord-">RecordTranslator</a></code></span></div> |
| <div class="block"><p>Translate the ConsumerRecord into a list of objects that can be emitted.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/kafka/spout/Func.html#apply-V-">apply</a></code> in interface <code><a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#apply-org.apache.kafka.clients.consumer.ConsumerRecord-">apply</a></code> in interface <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>record</code> - the record to translate</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects in the tuple. Return a <a href="../../../../../org/apache/storm/kafka/spout/KafkaTuple.html" title="class in org.apache.storm.kafka.spout"><code>KafkaTuple</code></a> if you want to route the tuple to a non-default stream. Return <code>null</code> to discard an invalid <code>ConsumerRecord</code> if <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setEmitNullTuples-boolean-"><code>KafkaSpoutConfig.Builder.setEmitNullTuples(boolean)</code></a> is set to <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldsFor-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldsFor</h4> |
| <pre>public <a href="../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> getFieldsFor(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#getFieldsFor-java.lang.String-">RecordTranslator</a></code></span></div> |
| <div class="block"><p>Get the fields associated with a stream. The streams passed in are returned by the <a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#streams--"><code>RecordTranslator.streams()</code></a> method.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#getFieldsFor-java.lang.String-">getFieldsFor</a></code> in interface <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream the fields are for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the fields for that stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="streams--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>streams</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> streams()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#streams--">RecordTranslator</a></code></span></div> |
| <div class="block"><p>Get the list of streams this translator will handle.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html#streams--">streams</a></code> in interface <code><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of streams that this will handle.</dd> |
| </dl> |
| </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="class-use/ByTopicRecordTranslator.html">Use</a></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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/DefaultRecordTranslator.html" title="class in org.apache.storm.kafka.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" target="_top">Frames</a></li> |
| <li><a href="ByTopicRecordTranslator.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
