MLHR-1892 Capitalization and other minor changes to comments
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/commit/0e205032 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/tree/0e205032 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/diff/0e205032 Branch: refs/heads/devel-3 Commit: 0e2050320e891f8e178a7c8f65a55dfcee131486 Parents: c9fd68d Author: Munagala V. Ramanath <[email protected]> Authored: Fri Dec 4 06:46:20 2015 -0800 Committer: Munagala V. Ramanath <[email protected]> Committed: Fri Dec 4 06:46:20 2015 -0800 ---------------------------------------------------------------------- .../wordcount/ApplicationWithQuerySupport.java | 6 ++-- .../demos/wordcount/FileWordCount.java | 32 ++++++++++---------- .../datatorrent/demos/wordcount/LineReader.java | 10 +++--- .../com/datatorrent/demos/wordcount/WCPair.java | 2 +- .../demos/wordcount/WindowWordCount.java | 6 ++-- .../demos/wordcount/WordCountWriter.java | 2 +- .../datatorrent/demos/wordcount/WordReader.java | 6 ++-- 7 files changed, 32 insertions(+), 32 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/ApplicationWithQuerySupport.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/ApplicationWithQuerySupport.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/ApplicationWithQuerySupport.java index 5492b5e..fd67bf6 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/ApplicationWithQuerySupport.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/ApplicationWithQuerySupport.java @@ -39,7 +39,7 @@ import com.datatorrent.lib.io.ConsoleOutputOperator; import org.apache.hadoop.conf.Configuration; /** - * Simple demo that counts word frequencies from any file dropped into a + * Simple demo that computes word frequencies from any file dropped into a * monitored directory. It outputs the top N word-frequency pairs for each file * as well globally across all files. * <p> @@ -55,7 +55,7 @@ public class ApplicationWithQuerySupport implements StreamingApplication private static final Logger LOG = LoggerFactory.getLogger(ApplicationWithQuerySupport.class); /** - * name of schema file + * Name of schema file. */ public static final String SNAPSHOT_SCHEMA = "WordDataSchema.json"; @@ -63,7 +63,7 @@ public class ApplicationWithQuerySupport implements StreamingApplication * Populates the DAG with operators and connecting streams * * @param dag The directed acyclic graph of operators to populate - * @param conf The directed acyclic graph of operators to populate + * @param conf The configuration */ @Override public void populateDAG(DAG dag, Configuration conf) http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/FileWordCount.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/FileWordCount.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/FileWordCount.java index a9d41f2..8eb004a 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/FileWordCount.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/FileWordCount.java @@ -36,8 +36,8 @@ import com.datatorrent.api.Context.OperatorContext; import com.datatorrent.common.util.BaseOperator; /** - * Monitors an input directory for text files, computes word frequency counts per file and globally, - * and writes the top N pairs to an output file and to snapshot servers for visualization. + * Computes word frequencies per file and globally, and writes the top N pairs to an output file + * and to snapshot servers for visualization. * Currently designed to work with only 1 file at a time; will be enhanced later to support * multiple files dropped into the monitored directory at the same time. * @@ -67,13 +67,13 @@ public class FileWordCount extends BaseOperator protected int topN; /** - * set to true when an EOF control tuple for the current input file is received; reset to false + * Set to true when an EOF control tuple for the current input file is received; reset to false * when the corresponding output file has been written. */ protected boolean eof = false; /** - * last component of path (just the file name) + * Last component of path (just the file name) * incoming value from control tuple */ protected String fileName; @@ -89,17 +89,17 @@ public class FileWordCount extends BaseOperator protected Map<String, WCPair> wordMapGlobal = new HashMap<>(); /** - * singleton list with per file data; sent on {@code outputPerFile} + * Singleton list with per file data; sent on {@code outputPerFile} */ protected transient List<Map<String, Object>> resultPerFile; /** - * singleton list with global data; sent on {@code outputGlobal} + * Singleton list with global data; sent on {@code outputGlobal} */ protected transient List<Map<String, Object>> resultGlobal; /** - * singleton map of {@code fileName} to sorted list of (word, frequency) pairs + * Singleton map of {@code fileName} to sorted list of (word, frequency) pairs */ protected transient Map<String, Object> resultFileFinal; @@ -109,7 +109,7 @@ public class FileWordCount extends BaseOperator protected transient List<WCPair> fileFinalList; /** - * input port on which per-window {@literal (word => frequency)} map is received; the map + * Input port on which per-window {@literal (word => frequency)} map is received; the map * is merged into {@code wordMapFile} and {@code wordMapGlobal}. */ public final transient DefaultInputPort<List<WCPair>> input = new DefaultInputPort<List<WCPair>>() @@ -147,7 +147,7 @@ public class FileWordCount extends BaseOperator }; /** - * control port on which the current file name is received to indicate EOF + * Control port on which the current file name is received to indicate EOF */ @InputPortFieldAnnotation(optional = true) public final transient DefaultInputPort<String> control = new DefaultInputPort<String>() @@ -166,20 +166,20 @@ public class FileWordCount extends BaseOperator }; /** - * output port for current file output + * Output port for current file output */ public final transient DefaultOutputPort<List<Map<String, Object>>> outputPerFile = new DefaultOutputPort<>(); /** - * output port for global output + * Output port for global output */ @OutputPortFieldAnnotation(optional = true) public final transient DefaultOutputPort<List<Map<String, Object>>> outputGlobal = new DefaultOutputPort<>(); /** - * tuple is singleton map {@code fileName => TopNMap} where {@code TopNMap} is the final + * Tuple is singleton map {@code fileName => TopNMap} where {@code TopNMap} is the final * top N pairs for current file and will be written to the output file; emitted in the * {@code endWindow()} call after an EOF */ @@ -187,14 +187,14 @@ public class FileWordCount extends BaseOperator fileOutput = new DefaultOutputPort<>(); /** - * get the number of top (word, frequency) pairs that will be output + * Get the number of top (word, frequency) pairs that will be output */ public int getTopN() { return topN; } /** - * set the number of top (word, frequency) pairs that will be output + * Set the number of top (word, frequency) pairs that will be output * @param n The new number */ public void setTopN(int n) { @@ -284,7 +284,7 @@ public class FileWordCount extends BaseOperator } /** - * get topN frequencies from map, convert each pair to a singleton map and append to result + * Get topN frequencies from map, convert each pair to a singleton map and append to result * This map is suitable input to AppDataSnapshotServer * MUST have {@code map.size() > 0} here */ @@ -319,7 +319,7 @@ public class FileWordCount extends BaseOperator } /** - * populate fileFinalList with topN frequencies from argument + * Populate fileFinalList with topN frequencies from argument * This list is suitable input to WordCountWriter which writes it to a file * MUST have {@code map.size() > 0} here */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/LineReader.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/LineReader.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/LineReader.java index 4dde0c5..fe10d73 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/LineReader.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/LineReader.java @@ -43,12 +43,12 @@ public class LineReader extends AbstractFileInputOperator<String> private static final Logger LOG = LoggerFactory.getLogger(LineReader.class); /** - * output port on which lines from current file name are emitted + * Output port on which lines from current file name are emitted */ public final transient DefaultOutputPort<String> output = new DefaultOutputPort<>(); /** - * control port on which the current file name is emitted to indicate EOF + * Control port on which the current file name is emitted to indicate EOF */ @OutputPortFieldAnnotation(optional = true) public final transient DefaultOutputPort<String> control = new DefaultOutputPort<>(); @@ -58,7 +58,7 @@ public class LineReader extends AbstractFileInputOperator<String> private Path path; /** - * file open callback; wrap the file input stream in a buffered reader for reading lines + * File open callback; wrap the file input stream in a buffered reader for reading lines * @param curPath The path to the file just opened */ @Override @@ -72,7 +72,7 @@ public class LineReader extends AbstractFileInputOperator<String> } /** - * file close callback; close buffered reader + * File close callback; close buffered reader * @param is File input stream that will imminently be closed */ @Override @@ -86,7 +86,7 @@ public class LineReader extends AbstractFileInputOperator<String> /** * {@inheritDoc} - * if we hit EOF, emit file name on control port + * If we hit EOF, emit file name on control port */ @Override protected String readEntity() throws IOException http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WCPair.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WCPair.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WCPair.java index 867ed13..1817f2b 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WCPair.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WCPair.java @@ -19,7 +19,7 @@ package com.datatorrent.demos.wordcount; /** - * a single (word, frequency) pair + * A single (word, frequency) pair * * @since 3.2.0 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WindowWordCount.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WindowWordCount.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WindowWordCount.java index a448366..999f32f 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WindowWordCount.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WindowWordCount.java @@ -31,7 +31,7 @@ import com.datatorrent.api.DefaultOutputPort; import com.datatorrent.common.util.BaseOperator; /** - * Computes word frequency counts per window and emits them at each endWindow. The output is a + * Computes word frequencies per window and emits them at each {@code endWindow()}. The output is a * list of (word, frequency) pairs * * @since 3.2.0 @@ -44,7 +44,7 @@ public class WindowWordCount extends BaseOperator protected Map<String, WCPair> wordMap = new HashMap<>(); /** - * input port on which words are received + * Input port on which words are received */ public final transient DefaultInputPort<String> input = new DefaultInputPort<String>() { @@ -66,7 +66,7 @@ public class WindowWordCount extends BaseOperator }; /** - * output port which emits the list of word frequencies for current window + * Output port which emits the list of word frequencies for current window */ public final transient DefaultOutputPort<List<WCPair>> output = new DefaultOutputPort<>(); http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordCountWriter.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordCountWriter.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordCountWriter.java index 2b9562d..62c41d3 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordCountWriter.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordCountWriter.java @@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory; import com.datatorrent.lib.io.fs.AbstractFileOutputOperator; /** - * write top N words and their frequencies to a file + * Write top N words and their frequencies to a file * * @since 3.2.0 */ http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/0e205032/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordReader.java ---------------------------------------------------------------------- diff --git a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordReader.java b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordReader.java index ed1f7bb..09b8d7b 100644 --- a/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordReader.java +++ b/demos/wordcount/src/main/java/com/datatorrent/demos/wordcount/WordReader.java @@ -26,7 +26,7 @@ import com.datatorrent.api.DefaultOutputPort; import com.datatorrent.common.util.BaseOperator; /** - * extracts words from input line + * Extracts words from input line */ public class WordReader extends BaseOperator { @@ -37,12 +37,12 @@ public class WordReader extends BaseOperator private transient Pattern nonWord; // compiled regex /** - * output port on which words from the current file are emitted + * Output port on which words from the current file are emitted */ public final transient DefaultOutputPort<String> output = new DefaultOutputPort<>(); /** - * input port on which lines from the current file are received + * Input port on which lines from the current file are received */ public final transient DefaultInputPort<String> input = new DefaultInputPort<String>() {
