Merge pull request #11 from ZorTik/development

Development

Author: ZorTik

api/src/main/java/me/zort/sqllib/api/StatementFactory.java

@@ -4,8 +4,22 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 
+/**
+ * The StatementFactory is responsible for creating new Statements for
+ * the given connection.
+ *
+ * @param <T> The Statement type.
+ * @author ZorTik
+ */
 public interface StatementFactory<T extends Statement> {
 
+    /**
+     * Prepares the statement for executing in {@link SQLConnection}.
+     *
+     * @param connection The connection to use.
+     * @return The prepared statement.
+     * @throws SQLException If an error occurs while preparing.
+     */
     T prepare(Connection connection) throws SQLException;
 
 }

api/src/main/java/me/zort/sqllib/api/data/QueryResult.java

@@ -2,6 +2,11 @@
 
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * Represents a query result.
+ *
+ * @author ZorTik
+ */
 public interface QueryResult {
 
     boolean isSuccessful();

api/src/main/java/me/zort/sqllib/api/data/Row.java

@@ -4,6 +4,36 @@
 
 public class Row extends HashMap<String, Object> {
 
-    // TODO
+    public String getString(String key) {
+        return (String) get(key);
+    }
+
+    public int getInt(String key) {
+        return (int) get(key);
+    }
+
+    public long getLong(String key) {
+        return (long) get(key);
+    }
+
+    public double getDouble(String key) {
+        return (double) get(key);
+    }
+
+    public float getFloat(String key) {
+        return (float) get(key);
+    }
+
+    public boolean getBoolean(String key) {
+        return (boolean) get(key);
+    }
+
+    public byte getByte(String key) {
+        return (byte) get(key);
+    }
+
+    public short getShort(String key) {
+        return (short) get(key);
+    }
 
 }

api/src/main/java/me/zort/sqllib/api/mapping/StatementMappingFactory.java

@@ -0,0 +1,24 @@
+package me.zort.sqllib.api.mapping;
+
+import me.zort.sqllib.api.SQLConnection;
+
+/**
+ * The StatementMappingFactory is responsible for creating new {@link StatementMappingStrategy}
+ * for defined interfaces.
+ *
+ * @author ZorTik
+ */
+public interface StatementMappingFactory {
+
+    /**
+     * Creates a new StatementMapping for the given interface class that
+     * is responsible for handling that specific interface.
+     *
+     * @param interfaceClass The interface class
+     * @param connection The connection to use.
+     * @return The StatementMapping.
+     * @param <T> The interface class type.
+     */
+    <T> StatementMappingStrategy<T> create(Class<T> interfaceClass, SQLConnection connection);
+
+}

api/src/main/java/me/zort/sqllib/api/mapping/StatementMappingResultAdapter.java

@@ -0,0 +1,35 @@
+package me.zort.sqllib.api.mapping;
+
+import me.zort.sqllib.api.SQLConnection;
+import me.zort.sqllib.api.data.QueryResult;
+
+import java.lang.reflect.Method;
+
+/**
+ * Result adapter used for handling operations between {@link SQLConnection}
+ * and {@link StatementMappingStrategy}.
+ *
+ * @author ZorTik
+ */
+public interface StatementMappingResultAdapter {
+
+    /**
+     * Adapts invoked {@link StatementMappingStrategy} method QueryResult to
+     * the final result that can be passed to proxy instance.
+     *
+     * @param method The invoked proxy method.
+     * @param result The QueryResult of the invoked method.
+     * @return The adapted result.
+     */
+    Object adaptResult(Method method, QueryResult result);
+
+    /**
+     * Retrieves type of entity that needs to be mapped in the request
+     * to be passed in adaptResult as type in QueryResult.
+     *
+     * @param method The invoked proxy method.
+     * @return The type of entity that needs to be mapped.
+     */
+    Class<?> retrieveResultType(Method method);
+
+}

api/src/main/java/me/zort/sqllib/api/mapping/StatementMappingStrategy.java

@@ -0,0 +1,39 @@
+package me.zort.sqllib.api.mapping;
+
+import me.zort.sqllib.api.data.QueryResult;
+import org.jetbrains.annotations.Nullable;
+
+import java.lang.reflect.Method;
+
+/**
+ * Represents an abstract proxy mapping that is used for execution of
+ * queries using mapped methods in a proxy instance.
+ *
+ * @param <T> The type of the proxy instance.
+ * @author ZorTik
+ */
+public interface StatementMappingStrategy<T> {
+
+    /**
+     * Executes query based on invoked method with invoked args from
+     * proxy instance. MapTo is used as type of entity to be mapped in the
+     * request. If there is no mapping required, MapTo can be null.
+     *
+     * @param method The method that was executed in the proxy.
+     * @param args The arguments passed.
+     * @param mapTo The type of entity that needs to be mapped.
+     * @return The QueryResult of the executed query.
+     */
+    QueryResult executeQuery(Method method, Object[] args, @Nullable Class<?> mapTo);
+
+    /**
+     * Checks if the method is eligible for mapping. If this returns false,
+     * the method is executed in proxy mapping as normal method, eg. does not
+     * return any mapping results.
+     *
+     * @param method The method that was executed in the proxy.
+     * @return True if the method is eligible for mapping, or false.
+     */
+    boolean isMappingMethod(Method method);
+
+}

core/src/main/java/me/zort/sqllib/SQLConnectionBuilder.java

@@ -18,11 +18,7 @@
 
 public class SQLConnectionBuilder {
 
-    public static SQLConnectionBuilder of(String address,
-                                          int port,
-                                          String database,
-                                          String username,
-                                          String password) {
+    public static SQLConnectionBuilder of(String address, int port, String database, String username, String password) {
         return of(new DefaultSQLEndpoint(address + ":" + port, database, username, password));
     }
 
@@ -47,6 +43,10 @@ public static SQLConnectionBuilder of(SQLEndpoint endpoint) {
     private String jdbc;
     private String driver = null;
 
+    public SQLConnectionBuilder(String address, int port, String database, String username, String password) {
+        this(new DefaultSQLEndpoint(address + ":" + port, database, username, password));
+    }
+
     public SQLConnectionBuilder() {
         this(null);
     }

core/src/main/java/me/zort/sqllib/SQLDatabaseConnection.java

@@ -8,6 +8,7 @@
 import me.zort.sqllib.api.data.Row;
 import me.zort.sqllib.internal.factory.SQLConnectionFactory;
 import me.zort.sqllib.internal.query.*;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
 import java.sql.Connection;
@@ -32,6 +33,9 @@ public SQLDatabaseConnection(SQLConnectionFactory connectionFactory) {
         SQLConnectionPool.register(this);
     }
 
+    @ApiStatus.Experimental
+    public abstract <T> T createGate(Class<T> mappingInterface);
+
     /**
      * Saves this mapping object into database using upsert query.
      * <p>