Merge pull request #268 from eclipse/unify-query

Unified Semistructured API: Harmonizing Document and Column Operations

Author: otaviojava

jnosql-arangodb/pom.xml

@@ -31,10 +31,6 @@
         <arango.driver>7.5.1</arango.driver>
     </properties>
     <dependencies>
-        <dependency>
-            <groupId>org.eclipse.jnosql.communication</groupId>
-            <artifactId>jnosql-communication-document</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.eclipse.jnosql.mapping</groupId>
             <artifactId>jnosql-mapping-document</artifactId>
@@ -43,10 +39,6 @@
             <groupId>org.eclipse.jnosql.mapping</groupId>
             <artifactId>jnosql-mapping-key-value</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.eclipse.jnosql.communication</groupId>
-            <artifactId>jnosql-communication-key-value</artifactId>
-        </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>jnosql-database-commons</artifactId>

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBDocumentConfiguration.java

@@ -17,20 +17,20 @@
 
 import com.arangodb.ArangoDB;
 import org.eclipse.jnosql.communication.Settings;
-import org.eclipse.jnosql.communication.document.DocumentConfiguration;
+import org.eclipse.jnosql.communication.semistructured.DatabaseConfiguration;
 
 import static java.util.Objects.requireNonNull;
 
 /**
- * The implementation of {@link DocumentConfiguration}
+ * The implementation of {@link DatabaseConfiguration}
  * that returns {@link ArangoDBDocumentManagerFactory}.
  *
  * @see ArangoDBConfiguration
  * @see ArangoDBConfigurations
  *
  */
 public final class ArangoDBDocumentConfiguration extends ArangoDBConfiguration
-        implements DocumentConfiguration {
+        implements DatabaseConfiguration {
 
     @Override
     public ArangoDBDocumentManagerFactory apply(Settings settings) throws NullPointerException {

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBDocumentManager.java

@@ -14,30 +14,30 @@
  */
 package org.eclipse.jnosql.databases.arangodb.communication;
 
-import org.eclipse.jnosql.communication.document.DocumentEntity;
-import org.eclipse.jnosql.communication.document.DocumentManager;
+import org.eclipse.jnosql.communication.semistructured.CommunicationEntity;
+import org.eclipse.jnosql.communication.semistructured.DatabaseManager;
 
 import java.util.Map;
 import java.util.stream.Stream;
 /**
- * The ArangoDB implementation of {@link DocumentManager}. This implementation does not support TTL methods in the context of
- * {@link DocumentManager#insert(DocumentEntity)}.
+ * The ArangoDB implementation of {@link DatabaseManager}. This implementation does not support TTL methods in the context of
+ * {@link DatabaseManager#insert(org.eclipse.jnosql.communication.semistructured.CommunicationEntity)}.
  */
-public interface ArangoDBDocumentManager extends DocumentManager {
+public interface ArangoDBDocumentManager extends DatabaseManager {
 
     /**
      * Executes an ArangoDB query using the ArangoDB Query Language (AQL).
      *
      * <p>Example query: {@code FOR u IN users FILTER u.status == @status RETURN u}</p>
      *
-     * <p>The conversion from the query result to {@link DocumentEntity} will happen at the Eclipse JNoSQL side.</p>
+     * <p>The conversion from the query result to {@link CommunicationEntity} will happen at the Eclipse JNoSQL side.</p>
      *
      * @param query  the AQL query
      * @param params the named parameters for the query
-     * @return a {@link Stream} of {@link DocumentEntity} representing the query result
+     * @return a {@link Stream} of {@link CommunicationEntity} representing the query result
      * @throws NullPointerException when either the query or params are null
      */
-    Stream<DocumentEntity> aql(String query, Map<String, Object> params);
+    Stream<CommunicationEntity> aql(String query, Map<String, Object> params);
 
     /**
      * Executes an ArangoDB query using the ArangoDB Query Language (AQL).

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBDocumentManagerFactory.java

@@ -16,10 +16,10 @@
 
 
 import com.arangodb.ArangoDB;
-import org.eclipse.jnosql.communication.document.DocumentManagerFactory;
+import org.eclipse.jnosql.communication.semistructured.DatabaseManagerFactory;
 
 
-public final class ArangoDBDocumentManagerFactory implements DocumentManagerFactory {
+public final class ArangoDBDocumentManagerFactory implements DatabaseManagerFactory {
 
 
     private final ArangoDB arangoDB;

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBException.java

@@ -15,10 +15,12 @@
 package org.eclipse.jnosql.databases.arangodb.communication;
 
 
+import org.eclipse.jnosql.communication.CommunicationException;
+
 /**
  * The exception to ArangoDB
  */
-public class ArangoDBException extends RuntimeException {
+public class ArangoDBException extends CommunicationException {
     public ArangoDBException(String message) {
         super(message);
     }

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBUtil.java

@@ -19,9 +19,9 @@
 import com.arangodb.entity.BaseDocument;
 import com.arangodb.entity.CollectionEntity;
 import org.eclipse.jnosql.communication.Value;
-import org.eclipse.jnosql.communication.document.Document;
-import org.eclipse.jnosql.communication.document.DocumentEntity;
 import org.eclipse.jnosql.communication.driver.ValueUtil;
+import org.eclipse.jnosql.communication.semistructured.CommunicationEntity;
+import org.eclipse.jnosql.communication.semistructured.Element;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -49,8 +49,8 @@ public final class ArangoDBUtil {
     public static final String REV = "_rev";
     private static final Logger LOGGER = Logger.getLogger(ArangoDBUtil.class.getName());
 
-    private static final Function<Map.Entry<?, ?>, Document> ENTRY_DOCUMENT = entry ->
-            Document.of(entry.getKey().toString(), entry.getValue());
+    private static final Function<Map.Entry<?, ?>, Element> ENTRY_DOCUMENT = entry ->
+            Element.of(entry.getKey().toString(), entry.getValue());
 
     private ArangoDBUtil() {
     }
@@ -80,22 +80,22 @@ public static void checkCollection(String bucketName, ArangoDB arangoDB, String
     }
 
 
-    static DocumentEntity toEntity(BaseDocument document) {
+    static CommunicationEntity toEntity(BaseDocument document) {
         Map<String, Object> properties = document.getProperties();
-        List<Document> documents = properties.keySet().stream()
+        List<Element> documents = properties.keySet().stream()
                 .map(k -> toDocument(k, properties))
                 .collect(Collectors.toList());
 
-        documents.add(Document.of(KEY, document.getKey()));
-        documents.add(Document.of(ID, document.getId()));
-        documents.add(Document.of(REV, document.getRevision()));
+        documents.add(Element.of(KEY, document.getKey()));
+        documents.add(Element.of(ID, document.getId()));
+        documents.add(Element.of(REV, document.getRevision()));
         String collection = document.getId().split("/")[0];
-        return DocumentEntity.of(collection, documents);
+        return CommunicationEntity.of(collection, documents);
     }
 
-    static BaseDocument getBaseDocument(DocumentEntity entity) {
+    static BaseDocument getBaseDocument(CommunicationEntity entity) {
         Map<String, Object> map = new HashMap<>();
-        for (Document document : entity.documents()) {
+        for (Element document : entity.elements()) {
             if(KEY.equals(document.name()) && Objects.isNull(document.get())) {
                 continue;
             }
@@ -104,23 +104,23 @@ static BaseDocument getBaseDocument(DocumentEntity entity) {
         return new BaseDocument(map);
     }
 
-    private static Document toDocument(String key, Map<String, Object> properties) {
+    private static Element toDocument(String key, Map<String, Object> properties) {
         Object value = properties.get(key);
         if (value instanceof Map map) {
-            return Document.of(key, map.keySet()
+            return Element.of(key, map.keySet()
                     .stream().map(k -> toDocument(k.toString(), map))
                     .collect(Collectors.toList()));
         }
         if (isADocumentIterable(value)) {
-            List<List<Document>> documents = new ArrayList<>();
+            List<List<Element>> documents = new ArrayList<>();
             for (Object object : Iterable.class.cast(value)) {
                 Map<?, ?> map = Map.class.cast(object);
                 documents.add(map.entrySet().stream().map(ENTRY_DOCUMENT).collect(toList()));
             }
-            return Document.of(key, documents);
+            return Element.of(key, documents);
 
         }
-        return Document.of(key, value);
+        return Element.of(key, value);
     }
 
     private static boolean isADocumentIterable(Object value) {
@@ -132,8 +132,8 @@ private static boolean isADocumentIterable(Object value) {
     private static Object convert(Value value) {
         Object val = ValueUtil.convert(value);
 
-        if (Document.class.isInstance(val)) {
-            Document document = Document.class.cast(val);
+        if (Element.class.isInstance(val)) {
+            Element document = Element.class.cast(val);
             return singletonMap(document.name(), convert(document.value()));
         }
         if (isSudDocument(val)) {
@@ -163,11 +163,11 @@ private static boolean isSudDocumentList(Object value) {
 
     private static boolean isSudDocument(Object value) {
         return value instanceof Iterable && StreamSupport.stream(Iterable.class.cast(value).spliterator(), false).
-                allMatch(org.eclipse.jnosql.communication.document.Document.class::isInstance);
+                allMatch(Element.class::isInstance);
     }
 
-    private static org.eclipse.jnosql.communication.document.Document cast(Object document) {
-        return org.eclipse.jnosql.communication.document.Document.class.cast(document);
+    private static Element cast(Object document) {
+        return Element.class.cast(document);
     }
 
 }

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/DefaultArangoDBDocumentManager.java

@@ -19,10 +19,10 @@
 import com.arangodb.entity.BaseDocument;
 import com.arangodb.entity.DocumentCreateEntity;
 import com.arangodb.entity.DocumentUpdateEntity;
-import org.eclipse.jnosql.communication.document.Document;
-import org.eclipse.jnosql.communication.document.DocumentDeleteQuery;
-import org.eclipse.jnosql.communication.document.DocumentEntity;
-import org.eclipse.jnosql.communication.document.DocumentQuery;
+import org.eclipse.jnosql.communication.semistructured.CommunicationEntity;
+import org.eclipse.jnosql.communication.semistructured.DeleteQuery;
+import org.eclipse.jnosql.communication.semistructured.Element;
+import org.eclipse.jnosql.communication.semistructured.SelectQuery;
 
 import java.time.Duration;
 import java.util.Map;
@@ -60,7 +60,8 @@ public String name() {
     }
 
     @Override
-    public DocumentEntity insert(DocumentEntity entity) throws NullPointerException {
+    public CommunicationEntity insert(CommunicationEntity entity)  {
+        Objects.requireNonNull(entity, "entity is required");
         String collectionName = entity.name();
         checkCollection(collectionName);
         BaseDocument baseDocument = ArangoDBUtil.getBaseDocument(entity);
@@ -71,7 +72,8 @@ public DocumentEntity insert(DocumentEntity entity) throws NullPointerException
     }
 
     @Override
-    public DocumentEntity update(DocumentEntity entity) {
+    public CommunicationEntity update(CommunicationEntity entity) {
+        Objects.requireNonNull(entity, "entity is required");
         String collectionName = entity.name();
         checkCollection(collectionName);
         String id = entity.find(ID, String.class)
@@ -87,15 +89,15 @@ public DocumentEntity update(DocumentEntity entity) {
 
 
     @Override
-    public Iterable<DocumentEntity> update(Iterable<DocumentEntity> entities) {
+    public Iterable<CommunicationEntity> update(Iterable<CommunicationEntity> entities) {
         Objects.requireNonNull(entities, "entities is required");
         return StreamSupport.stream(entities.spliterator(), false)
                 .map(this::update)
                 .collect(Collectors.toList());
     }
 
     @Override
-    public void delete(DocumentDeleteQuery query) {
+    public void delete(DeleteQuery query) {
         requireNonNull(query, "query is required");
         try {
 
@@ -119,7 +121,7 @@ public void delete(DocumentDeleteQuery query) {
     }
 
     @Override
-    public Stream<DocumentEntity> select(DocumentQuery query) throws NullPointerException {
+    public Stream<CommunicationEntity> select(SelectQuery query) throws NullPointerException {
         requireNonNull(query, "query is required");
 
         AQLQueryResult result = QueryAQLConverter.select(query);
@@ -142,7 +144,7 @@ public long count(String documentCollection) {
 
 
     @Override
-    public Stream<DocumentEntity> aql(String query, Map<String, Object> params) throws NullPointerException {
+    public Stream<CommunicationEntity> aql(String query, Map<String, Object> params) throws NullPointerException {
         requireNonNull(query, "query is required");
         requireNonNull(params, "values is required");
         ArangoCursor<BaseDocument> result = arangoDB.db(database).query(query,BaseDocument.class, params, null);
@@ -180,34 +182,34 @@ private void checkCollection(String collectionName) {
     }
 
     @Override
-    public DocumentEntity insert(DocumentEntity entity, Duration ttl) {
+    public CommunicationEntity insert(CommunicationEntity entity, Duration ttl) {
         throw new UnsupportedOperationException("TTL is not supported on ArangoDB implementation");
     }
 
     @Override
-    public Iterable<DocumentEntity> insert(Iterable<DocumentEntity> entities) {
+    public Iterable<CommunicationEntity> insert(Iterable<CommunicationEntity> entities) {
         Objects.requireNonNull(entities, "entities is required");
         return StreamSupport.stream(entities.spliterator(), false)
                 .map(this::insert)
                 .collect(Collectors.toList());
     }
 
     @Override
-    public Iterable<DocumentEntity> insert(Iterable<DocumentEntity> entities, Duration ttl) {
+    public Iterable<CommunicationEntity> insert(Iterable<CommunicationEntity> entities, Duration ttl) {
         Objects.requireNonNull(entities, "entities is required");
         Objects.requireNonNull(ttl, "ttl is required");
         return StreamSupport.stream(entities.spliterator(), false)
                 .map(e -> this.insert(e, ttl))
                 .collect(Collectors.toList());
     }
 
-    private void updateEntity(DocumentEntity entity, String key, String id, String rev) {
-        entity.add(Document.of(KEY, key));
-        entity.add(Document.of(ID, id));
-        entity.add(Document.of(REV, rev));
+    private void updateEntity(CommunicationEntity entity, String key, String id, String rev) {
+        entity.add(Element.of(KEY, key));
+        entity.add(Element.of(ID, id));
+        entity.add(Element.of(REV, rev));
     }
 
-    private static void feedKey(DocumentEntity entity, String id) {
+    private static void feedKey(CommunicationEntity entity, String id) {
         if (entity.find(KEY).isEmpty()) {
             String[] values = id.split("/");
             if (values.length == 2) {