You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by dj...@apache.org on 2017/09/10 20:38:52 UTC
[5/5] gora git commit: Fix java doc issues
Fix java doc issues
Project: http://git-wip-us.apache.org/repos/asf/gora/repo
Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/96b9e96d
Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/96b9e96d
Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/96b9e96d
Branch: refs/heads/master
Commit: 96b9e96df165757f766e414633ae7ad05dd9d05e
Parents: f6317e4
Author: Kevin Ratnasekera <dj...@yahoo.com>
Authored: Mon Sep 11 01:40:01 2017 +0530
Committer: Kevin Ratnasekera <dj...@yahoo.com>
Committed: Mon Sep 11 01:40:01 2017 +0530
----------------------------------------------------------------------
.../gora/orientdb/query/OrientDBQuery.java | 3 ++
.../gora/orientdb/store/OrientDBMapping.java | 2 +-
.../orientdb/store/OrientDBMappingBuilder.java | 2 +
.../gora/orientdb/store/OrientDBStore.java | 43 +++++++++++++++++---
.../orientdb/store/OrientDBStoreParameters.java | 1 +
5 files changed, 44 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/gora/blob/96b9e96d/gora-orientdb/src/main/java/org/apache/gora/orientdb/query/OrientDBQuery.java
----------------------------------------------------------------------
diff --git a/gora-orientdb/src/main/java/org/apache/gora/orientdb/query/OrientDBQuery.java b/gora-orientdb/src/main/java/org/apache/gora/orientdb/query/OrientDBQuery.java
index 209549a..596390b 100644
--- a/gora-orientdb/src/main/java/org/apache/gora/orientdb/query/OrientDBQuery.java
+++ b/gora-orientdb/src/main/java/org/apache/gora/orientdb/query/OrientDBQuery.java
@@ -72,6 +72,9 @@ public class OrientDBQuery<K, T extends PersistentBase> extends QueryBase<K, T>
* Convert Gora query to Orient DB specific query which underline API understands.
* And maintain it s state encapsulated to Gora implementation of the {@link org.apache.gora.query.Query}.
*
+ * @param orientDBMapping OrientDB mapping file.
+ * @param fields OrientDB query fields.
+ * @param schemaFields AVRO schema fields for persistent bean.
* @return a {@link OSQLSynchQuery} query executable over Orient DB.
*/
public OSQLSynchQuery<ODocument> populateOrientDBQuery(final OrientDBMapping orientDBMapping,
http://git-wip-us.apache.org/repos/asf/gora/blob/96b9e96d/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMapping.java
----------------------------------------------------------------------
diff --git a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMapping.java b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMapping.java
index a37c3d8..ac06f08 100644
--- a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMapping.java
+++ b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMapping.java
@@ -112,7 +112,7 @@ public class OrientDBMapping {
}
/**
- * Returns all fields in AVRO {@link org.apache.hadoop.io.serializer.avro.Record} record.
+ * Returns all fields in AVRO {@link SpecificRecord} record.
*
* @return array of fields in string.
*/
http://git-wip-us.apache.org/repos/asf/gora/blob/96b9e96d/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMappingBuilder.java
----------------------------------------------------------------------
diff --git a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMappingBuilder.java b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMappingBuilder.java
index 4c2d68c..18965f9 100644
--- a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMappingBuilder.java
+++ b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBMappingBuilder.java
@@ -57,6 +57,8 @@ public class OrientDBMappingBuilder<K, T extends PersistentBase> {
/**
* Build OrientDB dataStore mapping from gora-orientdb-mapping.xml given from class path
* or file system location.
+ *
+ * @return mapping file {@link OrientDBMapping}
*/
public OrientDBMapping build() {
if (mapping.getDocumentClass() == null)
http://git-wip-us.apache.org/repos/asf/gora/blob/96b9e96d/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStore.java
----------------------------------------------------------------------
diff --git a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStore.java b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStore.java
index 9561701..000f1fa 100644
--- a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStore.java
+++ b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStore.java
@@ -70,6 +70,7 @@ import javax.xml.bind.DatatypeConverter;
import static com.github.raymanrt.orientqb.query.Projection.projection;
/**
+ * {@inheritDoc}
* {@link org.apache.gora.orientdb.store.OrientDBStore} is the primary class
* responsible for facilitating GORA CRUD operations on OrientDB documents.
*/
@@ -86,6 +87,7 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
private ReentrantLock flushLock = new ReentrantLock();
/**
+ * {@inheritDoc}
* Initialize the OrientDB dataStore by {@link Properties} parameters.
*
* @param keyClass key class type for dataStore.
@@ -129,20 +131,26 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getSchemaName(final String mappingSchemaName,
final Class<?> persistentClass) {
return super.getSchemaName(mappingSchemaName, persistentClass);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getSchemaName() {
return orientDBMapping.getDocumentClass();
}
/**
- * Create a new class of OrientDB documents if necessary. Enforce specified schema over the document class.
- *
+ * {@inheritDoc}
+ * Create a new class of OrientDB documents if necessary. Enforce specified schema over the document class. *
*/
@Override
public void createSchema() {
@@ -168,8 +176,8 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
/**
+ * {@inheritDoc}
* Deletes enforced schema over OrientDB Document class.
- *
*/
@Override
public void deleteSchema() {
@@ -183,8 +191,8 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
/**
+ * {@inheritDoc}
* Check whether there exist a schema enforced over OrientDB document class.
- *
*/
@Override
public boolean schemaExists() {
@@ -198,6 +206,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public T get(K key, String[] fields) {
String[] dbFields = getFieldsToQuery(fields);
@@ -227,6 +238,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void put(K key, T val) {
if (val.isDirty()) {
@@ -238,6 +252,8 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
ODatabaseDocumentTx selectTx = connectionPool.acquire();
selectTx.activateOnCurrentThread();
try {
+ // TODO : further optimize for queries to separate cases update / insert == get rid of select all query
+ // TODO : for update
List<ODocument> result = selectTx.command(dataStoreQuery.getOrientDBQuery())
.execute(dataStoreQuery.getParams());
if (result.size() == 1) {
@@ -258,6 +274,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean delete(K key) {
Delete delete = new Delete();
@@ -280,6 +299,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public long deleteByQuery(Query<K, T> query) {
Delete delete = new Delete();
@@ -344,6 +366,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public Result<K, T> execute(Query<K, T> query) {
String[] fields = getFieldsToQuery(query.getFields());
@@ -366,6 +391,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public Query<K, T> newQuery() {
OrientDBQuery<K, T> query = new OrientDBQuery<K, T>(this);
@@ -373,6 +401,9 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
return new OrientDBQuery<K, T>(this);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public List<PartitionQuery<K, T>> getPartitions(Query<K, T> query) throws IOException {
// TODO : Improve code on OrientDB clusters
@@ -385,8 +416,8 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
/**
+ * {@inheritDoc}
* Flushes locally cached to content in memory to remote OrientDB server.
- *
*/
@Override
public void flush() {
@@ -405,8 +436,8 @@ public class OrientDBStore<K, T extends PersistentBase> extends DataStoreBase<K,
}
/**
+ * {@inheritDoc}
* Releases resources which have been used dataStore. Eg:- OrientDB Client connection pool.
- *
*/
@Override
public void close() {
http://git-wip-us.apache.org/repos/asf/gora/blob/96b9e96d/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStoreParameters.java
----------------------------------------------------------------------
diff --git a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStoreParameters.java b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStoreParameters.java
index f6e18bc..8eebcc5 100644
--- a/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStoreParameters.java
+++ b/gora-orientdb/src/main/java/org/apache/gora/orientdb/store/OrientDBStoreParameters.java
@@ -138,6 +138,7 @@ public class OrientDBStoreParameters {
/**
* Extraction OrientDB dataStore properties from {@link Properties} gora.properties file.
*
+ * @param properties gora.properties properties related to datastore client.
* @return OrientDB client properties encapsulated inside instance of {@link OrientDBStoreParameters}
*/
public static OrientDBStoreParameters load(Properties properties) {