From 3fb6c131056e0eda326f993596a9d6381ba0f3d8 Mon Sep 17 00:00:00 2001 From: Kevin Date: Sun, 28 Aug 2016 17:21:38 +0530 Subject: [PATCH] GORA-469 fixing java docs issues for GoraCompiler and DistributedLogManager --- .../java/org/apache/gora/compiler/GoraCompiler.java | 3 ++- .../gora/tutorial/log/DistributedLogManager.java | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) 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 6e8707c8b..469bec21a 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 @@ private static Schema getRecordSchemaWithDirtySupport(Schema originalSchema, Map } /** - * 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); 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 87c9e8d91..02f588a49 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 @@ *

* 3. Now use CLIENT's command line console to forward cache queries to cluster. *

- * (a) -parse cache <-input_log_file-> - This will parse logs from logs file and put Pageview data beans to + * (a) -parse cache #input_log_file - This will parse logs from logs file and put Pageview data beans to * persistent store via the cache. Notice following logs *
INFO 19:46:34,833 Written data bean to persistent datastore on key 45. *
on SERVER instance of DistributedLogManager. *
Notice the persistent data bean writes are LOAD BALANCED among SERVER instances. *

- * (b) -parse persistent <-input_log_file-> - This will write parsed log data beans directly to persistent store. + * (b) -parse persistent #input_log_file - This will write parsed log data beans directly to persistent store. * NOT via cache. *

* (c) Executing with (a) will create cache entry per each data bean key on each SERVER and CLIENT instances. Since @@ -116,7 +116,7 @@ * (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 - *
get <-lineNum-> + *
-get #lineNum *
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 @@ *
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. - *
-get <-lineNum-> + *
-get #lineNum * Notice there will be NO log entry similar to below *
INFO 17:13:22,652 Loaded data bean from persistent datastore on key 4. *
Since there will be no data bean load from persistent data store and the data bean is now loaded from @@ -136,7 +136,7 @@ * dataStore - which call directly underline persistent data store. * cacheStore - which call same persistent data store via the caching layer. * Simple benchmarking purposes use - *
-benchmark <-startLineNum-> <-endLineNum-> <-iterations-> + *
-benchmark #startLineNum #endLineNum #iterations *
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