Repository: gora Updated Branches: refs/heads/master ad7b3074a -> b0735a714
GORA-469 fixing java docs issues for GoraCompiler and DistributedLogManager Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/3fb6c131 Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/3fb6c131 Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/3fb6c131 Branch: refs/heads/master Commit: 3fb6c131056e0eda326f993596a9d6381ba0f3d8 Parents: e943b5a Author: Kevin <[email protected]> Authored: Sun Aug 28 17:21:38 2016 +0530 Committer: Kevin <[email protected]> Committed: Sun Aug 28 17:21:38 2016 +0530 ---------------------------------------------------------------------- .../main/java/org/apache/gora/compiler/GoraCompiler.java | 3 ++- .../apache/gora/tutorial/log/DistributedLogManager.java | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/3fb6c131/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java ---------------------------------------------------------------------- diff --git a/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java b/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java index 6e8707c..469bec2 100644 --- a/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java +++ b/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java @@ -275,9 +275,10 @@ public class GoraCompiler extends SpecificCompiler { } /** - * Utility method by velocity templates to generate serialVersionUID on AVRO beans. + * Utility method used by velocity templates to generate serialVersionUID on AVRO beans. * * @param schema Data bean AVRO schema. + * @return serialVersionUID for Serializable AVRO databeans. */ public static long fingerprint64(Schema schema) { return SchemaNormalization.parsingFingerprint64(schema); http://git-wip-us.apache.org/repos/asf/gora/blob/3fb6c131/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/DistributedLogManager.java ---------------------------------------------------------------------- diff --git a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/DistributedLogManager.java b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/DistributedLogManager.java index 87c9e8d..02f588a 100644 --- a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/DistributedLogManager.java +++ b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/DistributedLogManager.java @@ -98,13 +98,13 @@ import java.util.StringTokenizer; * <p> * 3. Now use CLIENT's command line console to forward cache queries to cluster. * <p> - * (a) <b>-parse cache <-input_log_file-></b> - This will parse logs from logs file and put Pageview data beans to + * (a) <b>-parse cache #input_log_file</b> - This will parse logs from logs file and put Pageview data beans to * persistent store via the cache. Notice following logs * <br><b>INFO 19:46:34,833 Written data bean to persistent datastore on key 45.</b> * <br>on SERVER instance of DistributedLogManager. * <br>Notice the persistent data bean writes are LOAD BALANCED among SERVER instances. * <p> - * (b) <b>-parse persistent <-input_log_file-></b> - This will write parsed log data beans directly to persistent store. + * (b) <b>-parse persistent #input_log_file</b> - This will write parsed log data beans directly to persistent store. * NOT via cache. * <p> * (c) Executing with (a) will create cache entry per each data bean key on each SERVER and CLIENT instances. Since @@ -116,7 +116,7 @@ import java.util.StringTokenizer; * (d) Executing with (b) will not create cache entries on keys since the data beans were directly put into * to persistent store. * Executing following command - * <br><b>get <-lineNum-></b> + * <br><b>-get #lineNum</b> * <br>Data will be first loaded from persistent store to cache from one of SERVER instances. Then cache * entry on given key will be created on all SERVER/CLIENT instances. * Notice the persistent data bean load on SINGLE SERVER instance. Only one SERVER instance will handle this work. @@ -126,7 +126,7 @@ import java.util.StringTokenizer; * <br>Once the cache entry is created, data bean is now available to be retrieved from cache without reaching the * persistent store. * Execute the above command consecutively for several times. - * <br><b>-get <-lineNum-></b> + * <br><b>-get #lineNum</b> * Notice there will be NO log entry similar to below * <br><b>INFO 17:13:22,652 Loaded data bean from persistent datastore on key 4.</b> * <br>Since there will be no data bean load from persistent data store and the data bean is now loaded from @@ -136,7 +136,7 @@ import java.util.StringTokenizer; * dataStore - which call directly underline persistent data store. * cacheStore - which call same persistent data store via the caching layer. * Simple benchmarking purposes use - * <br><b>-benchmark <-startLineNum-> <-endLineNum-> <-iterations-></b> + * <br><b>-benchmark #startLineNum #endLineNum #iterations</b> * <br>to compare data beans read for two cases. ( Cache layer is present and Not present when executing * consecutive data reads for same data items in nearby intervals ) * It generates LOG entries similar to below which indicates time spent for two cases in milliseconds
