This is an automated email from the ASF dual-hosted git repository.
djkevincr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/gora.git
The following commit(s) were added to refs/heads/master by this push:
new 0be0dc4 GORA-560:Fix Java doc comments to stabalize the build
new e325402 Merge pull request #154 from madhawa-gunasekara/GORA-560
0be0dc4 is described below
commit 0be0dc4618498c33e1f1c6105e45276c4c9143e4
Author: madhawa-gunasekara <[email protected]>
AuthorDate: Sun Mar 24 18:33:45 2019 +0530
GORA-560:Fix Java doc comments to stabalize the build
---
.../generated/AvroSerialization/CassandraKey.java | 4 -
.../AvroSerialization/CassandraRecord.java | 26 ------
.../org/apache/gora/compiler/GoraCompiler.java | 16 ++--
.../main/java/org/apache/gora/store/DataStore.java | 74 ++++++++++-------
.../org/apache/gora/store/DataStoreFactory.java | 96 ++++++++++++++++------
.../gora/store/DataStoreMetadataFactory.java | 32 +++++---
.../org/apache/gora/pig/GoraDeleteStorage.java | 6 +-
.../main/java/org/apache/gora/pig/GoraStorage.java | 14 ++--
8 files changed, 155 insertions(+), 113 deletions(-)
diff --git
a/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraKey.java
b/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraKey.java
index 57c06ab..132b59c 100644
---
a/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraKey.java
+++
b/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraKey.java
@@ -115,7 +115,6 @@ public class CassandraKey extends
org.apache.gora.persistency.impl.PersistentBas
/**
* Checks the dirty status of the 'url' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isUrlDirty() {
return isDirty(0);
@@ -139,7 +138,6 @@ public class CassandraKey extends
org.apache.gora.persistency.impl.PersistentBas
/**
* Checks the dirty status of the 'timestamp' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isTimestampDirty() {
return isDirty(1);
@@ -313,7 +311,6 @@ public class CassandraKey extends
org.apache.gora.persistency.impl.PersistentBas
/**
* Checks the dirty status of the 'url' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isUrlDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -336,7 +333,6 @@ public class CassandraKey extends
org.apache.gora.persistency.impl.PersistentBas
/**
* Checks the dirty status of the 'timestamp' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isTimestampDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
diff --git
a/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraRecord.java
b/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraRecord.java
index 601148e..b2f5090 100644
---
a/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraRecord.java
+++
b/gora-cassandra/src/examples/java/org/apache/gora/cassandra/example/generated/AvroSerialization/CassandraRecord.java
@@ -170,7 +170,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataString' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataStringDirty() {
return isDirty(0);
@@ -194,7 +193,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataInt' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataIntDirty() {
return isDirty(1);
@@ -218,7 +216,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataLong' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataLongDirty() {
return isDirty(2);
@@ -242,7 +239,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataDouble' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataDoubleDirty() {
return isDirty(3);
@@ -266,7 +262,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataBytes' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataBytesDirty() {
return isDirty(4);
@@ -290,7 +285,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayInt' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayIntDirty() {
return isDirty(5);
@@ -314,7 +308,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayString' field. A field is dirty if
it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayStringDirty() {
return isDirty(6);
@@ -338,7 +331,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayLong' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayLongDirty() {
return isDirty(7);
@@ -362,7 +354,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayDouble' field. A field is dirty if
it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayDoubleDirty() {
return isDirty(8);
@@ -386,7 +377,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapInt' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapIntDirty() {
return isDirty(9);
@@ -410,7 +400,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapString' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapStringDirty() {
return isDirty(10);
@@ -434,7 +423,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapLong' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapLongDirty() {
return isDirty(11);
@@ -458,7 +446,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapDouble' field. A field is dirty if it
represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapDoubleDirty() {
return isDirty(12);
@@ -973,7 +960,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataString' field. A field is
dirty if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataStringDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -996,7 +982,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataInt' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataIntDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1019,7 +1004,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataLong' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataLongDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1042,7 +1026,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataDouble' field. A field is
dirty if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataDoubleDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1065,7 +1048,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'dataBytes' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isDataBytesDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1088,7 +1070,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayInt' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayIntDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1111,7 +1092,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayString' field. A field is
dirty if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayStringDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1134,7 +1114,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayLong' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayLongDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1157,7 +1136,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'arrayDouble' field. A field is
dirty if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isArrayDoubleDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1180,7 +1158,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapInt' field. A field is dirty if
it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapIntDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1203,7 +1180,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapString' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapStringDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1226,7 +1202,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapLong' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapLongDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
@@ -1249,7 +1224,6 @@ public class CassandraRecord extends
org.apache.gora.persistency.impl.Persistent
/**
* Checks the dirty status of the 'mapDouble' field. A field is dirty
if it represents a change that has not yet been written to the database.
- * @param value the value to set.
*/
public boolean isMapDoubleDirty() {
throw new java.lang.UnsupportedOperationException("IsDirty is not
supported on tombstones");
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 29fca71..003301e 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
@@ -91,11 +91,11 @@ public class GoraCompiler extends SpecificCompiler {
/**
* Compiles a single schema. Any subschemas must be included in the own
schema.
*
- * @param sourceSchema String with the schema definition in json (avro)
- * @param dest Path where .java classes will be written
- * @param templatesPath Path where Gora's velocity templates are. If null,
will use DEFAULT_TEMPLATES_PATH
- * @return The compiled resulting Schema
- * @throws IOException
+ * @param sourceSchema String with the schema definition in json (avro).
+ * @param dest Path where .java classes will be written.
+ * @param templatesPath Path where Gora's velocity templates are. If null,
will use DEFAULT_TEMPLATES_PATH.
+ * @return The compiled resulting Schema.
+ * @throws IOException If there's an issue with compiling to the destination.
*/
public static Schema compileSchema(String sourceSchema, File dest, String
templatesPath) throws IOException {
Schema.Parser parser = new Schema.Parser();
@@ -183,10 +183,10 @@ public class GoraCompiler extends SpecificCompiler {
}
/**
- * Recognizes camel case
+ * Recognizes camel case.
*
- * @param s converts the given input string to camel case
- * @return the converted camel case string
+ * @param s converts the given input string to camel case.
+ * @return the converted camel case string.
*/
public static String toUpperCase(String s) {
StringBuilder builder = new StringBuilder();
diff --git a/gora-core/src/main/java/org/apache/gora/store/DataStore.java
b/gora-core/src/main/java/org/apache/gora/store/DataStore.java
index 4830ab0..a54a9f3 100644
--- a/gora-core/src/main/java/org/apache/gora/store/DataStore.java
+++ b/gora-core/src/main/java/org/apache/gora/store/DataStore.java
@@ -42,46 +42,47 @@ import org.apache.gora.util.GoraException;
* with from within this interface.
* </p>
*
- * @param <K> the class of keys in the datastore
- * @param <T> the class of persistent objects in the datastore
+ * @param <K> the class of keys in the datastore.
+ * @param <T> the class of persistent objects in the datastore.
*/
public interface DataStore<K, T extends Persistent> {
/**
* Initializes this DataStore.
- * @param keyClass the class of the keys
- * @param persistentClass the class of the persistent objects
- * @param properties extra metadata
+ * @param keyClass the class of the keys.
+ * @param persistentClass the class of the persistent objects.
+ * @param properties extra metadata.
+ * @throws GoraException If any error occurred.
*/
void initialize(Class<K> keyClass, Class<T> persistentClass, Properties
properties) throws GoraException;
/**
- * Sets the class of the keys
- * @param keyClass the class of keys
+ * Sets the class of the keys.
+ * @param keyClass the class of keys.
*/
void setKeyClass(Class<K> keyClass);
/**
- * Returns the class of the keys
- * @return class of the keys
+ * Returns the class of the keys.
+ * @return class of the keys.
*/
Class<K> getKeyClass();
/**
- * Sets the class of the persistent objects
- * @param persistentClass class of persistent objects
+ * Sets the class of the persistent objects.
+ * @param persistentClass class of persistent objects.
*/
void setPersistentClass(Class<T> persistentClass);
/**
- * Returns the class of the persistent objects
- * @return class of the persistent objects
+ * Returns the class of the persistent objects.
+ * @return class of the persistent objects.
*/
Class<T> getPersistentClass();
/**
- * Returns the schema name given to this DataStore
- * @return schema name
+ * Returns the schema name given to this DataStore.
+ * @return schema name.
*/
String getSchemaName();
@@ -90,6 +91,7 @@ public interface DataStore<K, T extends Persistent> {
* to hold the objects. If the schema is already created previously,
* or the underlying data model does not support
* or need this operation, the operation is ignored.
+ * @throws GoraException If any error occurred.
*/
void createSchema() throws GoraException;
@@ -98,18 +100,21 @@ public interface DataStore<K, T extends Persistent> {
* that holds the objects. This also deletes all the data associated with
* the schema.
* If the schema does not exists, this operation is ignored.
+ * @throws GoraException If any error occurred.
*/
void deleteSchema() throws GoraException;
/**
* Deletes all the data associated with the schema, but keeps the
* schema (table or similar) intact.
+ * @throws GoraException If any error occurred.
*/
void truncateSchema() throws GoraException;
/**
* Returns whether the schema that holds the data exists in the datastore.
- * @return whether schema exists
+ * @return whether schema exists.
+ * @throws GoraException If any error occurred.
*/
boolean schemaExists() throws GoraException;
@@ -119,27 +124,31 @@ public interface DataStore<K, T extends Persistent> {
* constructor) it throws an exception. Only use this function if you can
* make sure that the key class has a no-arg constructor.
* @return a new instance of the key object.
+ * @throws GoraException If any error occurred.
*/
K newKey() throws GoraException;
/**
* Returns a new instance of the managed persistent object.
* @return a new instance of the managed persistent object.
+ * @throws GoraException If any error occurred.
*/
T newPersistent() throws GoraException;
/**
* Returns the object corresponding to the given key fetching all the fields.
- * @param key the key of the object
- * @return the Object corresponding to the key or null if it cannot be found
+ * @param key the key of the object.
+ * @return the Object corresponding to the key or null if it cannot be found.
+ * @throws GoraException If any error occurred.
*/
T get(K key) throws GoraException;
/**
* Returns the object corresponding to the given key.
- * @param key the key of the object
- * @param fields the fields required in the object. Pass null, to retrieve
all fields
- * @return the Object corresponding to the key or null if it cannot be found
+ * @param key the key of the object.
+ * @param fields the fields required in the object. Pass null, to retrieve
all fields.
+ * @return the Object corresponding to the key or null if it cannot be found.
+ * @throws GoraException If any error occurred.
*/
T get(K key, String[] fields) throws GoraException;
@@ -149,23 +158,26 @@ public interface DataStore<K, T extends Persistent> {
* be replaced. See also the note on
* <a href="#visibility">visibility</a>.
*
- * @param key the key of the object
- * @param obj the {@link Persistent} object
+ * @param key the key of the object.
+ * @param obj the {@link Persistent} object.
+ * @throws GoraException If any error occurred.
*/
void put(K key, T obj) throws GoraException;
/**
- * Deletes the object with the given key
- * @param key the key of the object
- * @return whether the object was successfully deleted
+ * Deletes the object with the given key.
+ * @param key the key of the object.
+ * @return whether the object was successfully deleted.
+ * @throws GoraException If any error occurred.
*/
boolean delete(K key) throws GoraException;
/**
* Deletes all the objects matching the query.
* See also the note on <a href="#visibility">visibility</a>.
- * @param query matching records to this query will be deleted
- * @return number of deleted records
+ * @param query matching records to this query will be deleted.
+ * @return number of deleted records.
+ * @throws GoraException If any error occurred.
*/
long deleteByQuery(Query<K, T> query) throws GoraException;
@@ -173,6 +185,7 @@ public interface DataStore<K, T extends Persistent> {
* Executes the given query and returns the results.
* @param query the query to execute.
* @return the results as a {@link Result} object.
+ * @throws GoraException If any error occurred.
*/
Result<K, T> execute(Query<K, T> query) throws GoraException;
@@ -187,9 +200,7 @@ public interface DataStore<K, T extends Persistent> {
* which will execute on local data.
* @param query the base query to create the partitions for. If the query
* is null, then the data store returns the partitions for the default query
- * (returning every object)
- *
- * @param query the {@link Query} to partition
+ * (returning every object),the {@link Query} to partition.
* @return a List of PartitionQuery's
* @throws IOException if there is an error generating partitions
*/
@@ -200,6 +211,7 @@ public interface DataStore<K, T extends Persistent> {
* optimize their writing by deferring the actual put / delete operations
* until this moment.
* See also the note on <a href="#visibility">visibility</a>.
+ * @throws GoraException If any error occurred.
*/
void flush() throws GoraException;
diff --git
a/gora-core/src/main/java/org/apache/gora/store/DataStoreFactory.java
b/gora-core/src/main/java/org/apache/gora/store/DataStoreFactory.java
index 1aaefa0..bb94061 100644
--- a/gora-core/src/main/java/org/apache/gora/store/DataStoreFactory.java
+++ b/gora-core/src/main/java/org/apache/gora/store/DataStoreFactory.java
@@ -99,13 +99,16 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class.
* @param keyClass The key class.
* @param persistent The value class.
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
public static <D extends DataStore<K,T>, K, T extends Persistent>
D createDataStore(Class<D> dataStoreClass
@@ -115,14 +118,17 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties.
- *
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class.
* @param keyClass The key class.
* @param persistent The value class.
* @param conf {@link Configuration} to be used be the store.
* @param schemaName A default schemaname that will be put on the properties.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
public static <D extends DataStore<K,T>, K, T extends Persistent>
D createDataStore(Class<D> dataStoreClass , Class<K> keyClass,
@@ -132,7 +138,10 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}.
- *
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class.
* @param keyClass The key class.
* @param persistent The value class.
@@ -140,7 +149,7 @@ public class DataStoreFactory{
* @param properties The properties to be used be the store.
* @param schemaName A default schemaname that will be put on the properties.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
public static <D extends DataStore<K,T>, K, T extends Persistent>
D createDataStore(Class<D> dataStoreClass, Class<K> keyClass
@@ -165,14 +174,17 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses 'null' schema.
- *
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class.
* @param keyClass The key class.
* @param persistent The value class.
* @param conf {@link Configuration} to be used be the store.
* @param properties The properties to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
public static <D extends DataStore<K,T>, K, T extends Persistent>
D createDataStore(Class<D> dataStoreClass
@@ -186,13 +198,16 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class.
* @param keyClass The key class.
* @param persistentClass The value class.
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
public static <D extends DataStore<K,T>, K, T extends Persistent>
D getDataStore( Class<D> dataStoreClass, Class<K> keyClass,
@@ -203,13 +218,15 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
+ *
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class <i>as string</i>.
* @param keyClass The key class.
* @param persistentClass The value class.
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
@SuppressWarnings("unchecked")
public static <K, T extends Persistent> DataStore<K, T> getDataStore(
@@ -228,12 +245,14 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
+ *
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param keyClass The key class <i>as string</i>.
* @param persistentClass The value class <i>as string</i>.
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
@SuppressWarnings({ "unchecked" })
public static <K, T extends Persistent> DataStore<K, T> getDataStore(
@@ -255,14 +274,15 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
- * @param dataStoreClass The datastore implementation class <i>as string</i>.
+ *
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param keyClass The key class <i>as string</i>.
* @param persistentClass The value class <i>as string</i>.
* @param props Gora properties configuration
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
@SuppressWarnings({ "unchecked" })
public static <K, T extends Persistent> DataStore<K, T> getDataStore(
@@ -287,14 +307,16 @@ public class DataStoreFactory{
/**
* Instantiate a new {@link DataStore}. Uses default properties. Uses 'null'
schema.
- *
+ *
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param dataStoreClass The datastore implementation class <i>as string</i>.
* @param keyClass The key class <i>as string</i>.
* @param persistentClass The value class <i>as string</i>.
* @param props Gora properties configuration
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
@SuppressWarnings({ "unchecked" })
public static <K, T extends Persistent> DataStore<K, T> getDataStore(
@@ -323,11 +345,13 @@ public class DataStoreFactory{
* Note:
* consider that default dataStore is always visible
*
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param keyClass The key class.
* @param persistent The value class.
* @param conf {@link Configuration} to be used be the store.
* @return A new store instance.
- * @throws GoraException
+ * @throws GoraException If any error occurred.
*/
@SuppressWarnings("unchecked")
public static <K, T extends Persistent> DataStore<K, T> getDataStore(
@@ -351,6 +375,8 @@ public class DataStoreFactory{
* Note:
* consider that default dataStore is always visible
*
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
* @param keyClass The key class.
* @param persistent The value class.
* @param conf {@link Configuration} To be used be the store.
@@ -513,7 +539,11 @@ public class DataStoreFactory{
}
/**
- * Set a property
+ * Set a property.
+ *
+ * @param properties Properties which hold keys from which we can obtain
values for datastore mappings.
+ * @param baseKey Base key name.
+ * @param value Property value.
*/
private static void setProperty(Properties properties, String baseKey,
String value) {
if(value != null) {
@@ -522,7 +552,12 @@ public class DataStoreFactory{
}
/**
- * Sets a property for the datastore of the given class
+ * Sets a property for the datastore of the given class.
+ *
+ * @param properties Properties which hold keys from which we can obtain
values for datastore mappings.
+ * @param dataStoreClass The datastore implementation class.
+ * @param baseKey Base key name
+ * @param value Property value.
*/
private static<D extends DataStore<K,T>, K, T extends Persistent>
void setProperty(Properties properties, Class<D> dataStoreClass, String
baseKey, String value) {
@@ -530,7 +565,10 @@ public class DataStoreFactory{
}
/**
- * Gets the default schema name of a given store class
+ * Gets the default schema name of a given store class.
+ *
+ * @param properties Properties which hold keys from which we can obtain
values for datastore mappings.
+ * @param store Data store {@link org.apache.gora.store.DataStore} object to
get default schema name.
*/
public static String getDefaultSchemaName(Properties properties,
DataStore<?,?> store) {
return findProperty(properties, store, SCHEMA_NAME, null);
@@ -538,6 +576,9 @@ public class DataStoreFactory{
/**
* Sets the default schema name.
+ *
+ * @param properties Properties which hold keys from which we can obtain
values for datastore mappings.
+ * @param schemaName Schema name.
*/
public static void setDefaultSchemaName(Properties properties, String
schemaName) {
if (schemaName != null) {
@@ -546,7 +587,14 @@ public class DataStoreFactory{
}
/**
- * Sets the default schema name to be used by the datastore of the given
class
+ * Sets the default schema name to be used by the datastore of the given
class.
+ *
+ * @param <D> The class of datastore.
+ * @param <K> The class of keys in the datastore.
+ * @param <T> The class of persistent objects in the datastore.
+ * @param properties Properties which hold keys from which we can obtain
values for datastore mappings.
+ * @param dataStoreClass The datastore implementation class.
+ * @param schemaName Schema name.
*/
public static<D extends DataStore<K,T>, K, T extends Persistent>
void setDefaultSchemaName(Properties properties, Class<D> dataStoreClass,
String schemaName) {
diff --git
a/gora-core/src/main/java/org/apache/gora/store/DataStoreMetadataFactory.java
b/gora-core/src/main/java/org/apache/gora/store/DataStoreMetadataFactory.java
index cb2d981..28277a6 100644
---
a/gora-core/src/main/java/org/apache/gora/store/DataStoreMetadataFactory.java
+++
b/gora-core/src/main/java/org/apache/gora/store/DataStoreMetadataFactory.java
@@ -43,8 +43,10 @@ public class DataStoreMetadataFactory {
/**
* Creates a metadata analyzer given the Hadoop Configuration instance. Uses
the default gora.properties where it takes the
* base name from the default store to infer the metadata analyzer to create.
- * @throws GoraException
- * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class
+ * @param configuration The Configuration.
+ * @return DataStoreMetadataAnalyzer Metadata analyzer, instance of {@link
DataStoreMetadataAnalyzer}.
+ * @throws GoraException If any error occurred.
+ * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class.
*/
public static DataStoreMetadataAnalyzer createAnalyzer(Configuration
configuration) throws GoraException, ClassNotFoundException {
return createAnalyzer(configuration, DataStoreFactory.createProps());
@@ -53,8 +55,11 @@ public class DataStoreMetadataFactory {
/**
* Creates a metadata analyzer given the Hadoop Configuration instance and
the gora properties to use. It uses this properties
* to infer the metadata analyzer to create.
- * @throws GoraException
- * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class
+ * @param configuration The Configuration.
+ * @param properties The gora properties to be used to create metadata
analyzer.
+ * @return DataStoreMetadataAnalyzer Metadata analyzer, instance of {@link
DataStoreMetadataAnalyzer}.
+ * @throws GoraException If any error occurred.
+ * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class.
*/
public static DataStoreMetadataAnalyzer createAnalyzer(Configuration
configuration, Properties properties) throws GoraException,
ClassNotFoundException {
String metadataAnalyzerClassName =
DataStoreFactory.getDefaultDataStore(properties) + "MetadataAnalyzer";
@@ -62,18 +67,25 @@ public class DataStoreMetadataFactory {
}
/**
- * Creates the metadata analyzer with the name given.
- * @throws GoraException
- * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class
+ * Creates the metadata analyzer with the name given.
+ * @param metadataAnalyzerClassName Class name of the
DataStoreMetadataAnalyzer, refer : {@link DataStoreMetadataAnalyzer}.
+ * @param configuration The Hadoop Configuration.
+ * @return DataStoreMetadataAnalyzer Metadata analyzer, instance of {@link
DataStoreMetadataAnalyzer}.
+ * @throws GoraException If any error occurred.
+ * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class.
*/
public static DataStoreMetadataAnalyzer createAnalyzer(String
metadataAnalyzerClassName, Configuration configuration) throws GoraException,
ClassNotFoundException {
return createAnalyzer(metadataAnalyzerClassName, configuration,
DataStoreFactory.createProps()) ;
}
/**
- * Main factory method that creates a Metadata Analyzer given a metadata
analyzer class name, a Hadoop Configuration instance and Gora Properties
- * @throws GoraException
- * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class
+ * Main factory method that creates a Metadata Analyzer given a metadata
analyzer class name, a Hadoop Configuration instance and Gora Properties.
+ * @return DataStoreMetadataAnalyzer Metadata analyzer, instance of {@link
DataStoreMetadataAnalyzer}.
+ * @param metadataAnalyzerClassName Class name of the
DataStoreMetadataAnalyzer, refer : {@link DataStoreMetadataAnalyzer}.
+ * @param configuration The Configuration.
+ * @param properties The gora properties to be used to create metadata
analyzer.
+ * @throws GoraException If any error occurred.
+ * @throws ClassNotFoundException - Exception thrown when does not exists a
suitable metadata analyzer class.
*/
public static DataStoreMetadataAnalyzer createAnalyzer(String
metadataAnalyzerClassName, Configuration configuration, Properties properties)
throws GoraException, ClassNotFoundException {
try {
diff --git a/gora-pig/src/main/java/org/apache/gora/pig/GoraDeleteStorage.java
b/gora-pig/src/main/java/org/apache/gora/pig/GoraDeleteStorage.java
index a9ed33c..3358055 100644
--- a/gora-pig/src/main/java/org/apache/gora/pig/GoraDeleteStorage.java
+++ b/gora-pig/src/main/java/org/apache/gora/pig/GoraDeleteStorage.java
@@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory;
* STORE webpages INTO '.' USING org.apache.gora.pig.GoraDeleteStorage('{
* "persistentClass": "admin.WebPage",
* "goraProperties":
"gora.datastore.default=org.apache.gora.hbase.store.HBaseStore\\ngora.datastore.autocreateschema=true\\ngora.hbasestore.scanner.caching=4",
- * "mapping": "<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>",
+ * "mapping": {@code<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>},
* "configuration": {
* "hbase.zookeeper.quorum": "hdp4,hdp1,hdp3",
* "zookeeper.znode.parent": "/hbase-unsecure"
@@ -92,8 +92,8 @@ public class GoraDeleteStorage extends GoraStorage {
}
/**
- * If delete type = ROWS => deletes all the rows with the given keys
- * If delete type = VALUES => for all fields with a name related to avro
map, deletes the elements
+ * If delete type = ROWS : deletes all the rows with the given keys
+ * If delete type = VALUES : for all fields with a name related to avro map,
deletes the elements
*/
@SuppressWarnings("unchecked")
@Override
diff --git a/gora-pig/src/main/java/org/apache/gora/pig/GoraStorage.java
b/gora-pig/src/main/java/org/apache/gora/pig/GoraStorage.java
index 206773b..4f90161 100644
--- a/gora-pig/src/main/java/org/apache/gora/pig/GoraStorage.java
+++ b/gora-pig/src/main/java/org/apache/gora/pig/GoraStorage.java
@@ -90,7 +90,7 @@ import org.slf4j.LoggerFactory;
* "persistentClass": "admin.WebPage",
* "fields": "baseUrl,status,content",
* "goraProperties":
"gora.datastore.default=org.apache.gora.hbase.store.HBaseStore\\ngora.datastore.autocreateschema=true\\ngora.hbasestore.scanner.caching=4",
- * "mapping": "<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>",
+ * "mapping": "{@code<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>},
* "configuration": {
* "hbase.zookeeper.quorum": "hdp4,hdp1,hdp3",
* "zookeeper.znode.parent": "/hbase-unsecure"
@@ -125,7 +125,7 @@ import org.slf4j.LoggerFactory;
* "persistentClass": "admin.WebPage",
* "fields": "baseUrl,status,content",
* "goraProperties":
"gora.datastore.default=org.apache.gora.hbase.store.HBaseStore\\ngora.datastore.autocreateschema=true\\ngora.hbasestore.scanner.caching=4",
- * "mapping": "<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>",
+ * "mapping": {@code<?xml version=\\"1.0\\"
encoding=\\"UTF-8\\"?>\\n<gora-odm>\\n<table name=\\"webpage\\">\\n<family
name=\\"f\\" maxVersions=\\"1\\"/>\\n</table>\\n<class table=\\"webpage\\"
keyClass=\\"java.lang.String\\" name=\\"admin.WebPage\\">\\n<field
name=\\"baseUrl\\" family=\\"f\\" qualifier=\\"bas\\"/>\\n<field
name=\\"status\\" family=\\"f\\" qualifier=\\"st\\"/>\\n<field
name=\\"content\\" family=\\"f\\"
qualifier=\\"cnt\\"/>\\n</class>\\n</gora-odm>},
* "configuration": {
* "hbase.zookeeper.quorum": "hdp4,hdp1,hdp3",
* "zookeeper.znode.parent": "/hbase-unsecure"
@@ -264,7 +264,7 @@ public class GoraStorage extends LoadFunc implements
StoreFuncInterface, LoadMet
* "goraProperties":
"gora.datastore.default=org.apache.gora.hbase.store.HBaseStore
* gora.datastore.autocreateschema=true
* gora.hbasestore.scanner.caching=1000",
- * "mapping": "<?xml version=\\"1.0\\" encoding="UTF-8\\"?>
+ * "mapping": {@code<?xml version=\\"1.0\\" encoding="UTF-8\\"?>
* <gora-odm>
* <table name=\\"webpage\\">
* <family name=\\"f\\" maxVersions=\\"1\\"/>
@@ -273,7 +273,7 @@ public class GoraStorage extends LoadFunc implements
StoreFuncInterface, LoadMet
* <field name=\\"baseUrl\\" family=\\"f\\"
qualifier=\\"bas\\"/>
* <field name=\\"status\\" family=\\"f\\"
qualifier=\\"st\\"/>
* </class>
- * </gora-odm>",
+ * </gora-odm>},
* "configuration": {
* "hbase.zookeeper.quorum": "hdp4,hdp1,hdp3",
* "zookeeper.znode.parent": "/hbase-unsecure"
@@ -352,9 +352,9 @@ public class GoraStorage extends LoadFunc implements
StoreFuncInterface, LoadMet
/**
* Returns UDFProperties based on <code>udfcSignature</code>,
<code>keyClassName</code> and <code>persistentClassName</code>.
- * @throws IOException - When the conversion bean->json fails
- * @throws JsonMappingException - When the conversion bean->json fails
- * @throws JsonGenerationException - When the conversion bean->json fails
+ * @throws IOException - When the conversion from bean to json fails
+ * @throws JsonMappingException - When the conversion from bean to json fails
+ * @throws JsonGenerationException - When the conversion from bean to json
fails
*/
protected Properties getUDFProperties() throws JsonGenerationException,
JsonMappingException, IOException {
return UDFContext.getUDFContext().getUDFProperties(this.getClass(), new
String[] {this.udfcSignature});
