aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/com/iciql/SQLDialect.java
diff options
context:
space:
mode:
authorJames Moger <james.moger@gitblit.com>2016-04-05 12:27:55 -0400
committerJames Moger <james.moger@gitblit.com>2016-04-05 12:27:55 -0400
commitbb87e621eefd97872aa1a619d38c166b2f07db84 (patch)
treed7199be13f0015e218ae2ded4ebd8af11b955845 /src/main/java/com/iciql/SQLDialect.java
parent98bb5dc01796728de5b18f84e19766276d12d1db (diff)
downloadiciql-bb87e621eefd97872aa1a619d38c166b2f07db84.tar.gz
iciql-bb87e621eefd97872aa1a619d38c166b2f07db84.zip
Reformat project with default IntelliJ settings
Diffstat (limited to 'src/main/java/com/iciql/SQLDialect.java')
-rw-r--r--src/main/java/com/iciql/SQLDialect.java370
1 files changed, 174 insertions, 196 deletions
diff --git a/src/main/java/com/iciql/SQLDialect.java b/src/main/java/com/iciql/SQLDialect.java
index 8e6361a..1cb4931 100644
--- a/src/main/java/com/iciql/SQLDialect.java
+++ b/src/main/java/com/iciql/SQLDialect.java
@@ -18,210 +18,188 @@
package com.iciql;
-import java.sql.ResultSet;
-
import com.iciql.Iciql.DataTypeAdapter;
import com.iciql.TableDefinition.IndexDefinition;
+import java.sql.ResultSet;
+
/**
* This interface defines points where iciql can build different statements
* depending on the database used.
*/
public interface SQLDialect {
- /**
- * Registers the type adapter instance.
- *
- * @param typeAdapter
- */
- void registerAdapter(DataTypeAdapter<?> typeAdapter);
-
- /**
- * Returns the registered instance of the type adapter.
- *
- * @param typeAdapter
- * @return the type adapter instance
- */
- DataTypeAdapter<?> getAdapter(Class<? extends DataTypeAdapter<?>> typeAdapter);
-
- /**
- * Serialize the Java object into a type or format that the database will accept.
- *
- * @param value
- * @param typeAdapter
- * @return the serialized object
- */
- <T> Object serialize(T value, Class<? extends DataTypeAdapter<?>> typeAdapter);
-
- /**
- * Deserialize the object received from the database into a Java type.
- *
- * @param rs
- * @param columnIndex
- * @param targetType
- * @param typeAdapter
- * @return the deserialized object
- */
- Object deserialize(ResultSet rs, int columnIndex, Class<?> targetType, Class<? extends DataTypeAdapter<?>> typeAdapter);
-
- /**
- * Configure the dialect.
- *
- * @param db
- */
- void configureDialect(Db db);
-
- /**
- * Returns true if savepoints are supported.
- *
- * @return true if savepoints may be used.
- */
- boolean supportsSavePoints();
-
- /**
- * Allows a dialect to substitute an SQL type.
- *
- * @param sqlType
- * @return the dialect-safe type
- */
- String convertSqlType(String sqlType);
-
- /**
- * Returns a properly formatted table name for the dialect.
- *
- * @param schemaName
- * the schema name, or null for no schema
- * @param tableName
- * the properly formatted table name
- * @return the SQL snippet
- */
- String prepareTableName(String schemaName, String tableName);
-
- /**
- * Returns a properly formatted column name for the dialect.
- *
- * @param name
- * the column name
- * @return the properly formatted column name
- */
- String prepareColumnName(String name);
-
- /**
- * Get the CREATE TABLE statement.
- *
- * @param stat
- * @param def
- */
- <T> void prepareCreateTable(SQLStatement stat, TableDefinition<T> def);
-
- /**
- * Get the DROP TABLE statement.
- *
- * @param stat
- * @param def
- */
- <T> void prepareDropTable(SQLStatement stat, TableDefinition<T> def);
-
-
- /**
- * Get the CREATE VIEW statement.
- *
- * @param stat
- * return the SQL statement
- * @param def
- * table definition
- */
- <T> void prepareCreateView(SQLStatement stat, TableDefinition<T> def);
-
- /**
- * Get the CREATE VIEW statement.
- *
- * @param stat
- * return the SQL statement
- * @param def
- * table definition
- * @param fromWhere
- */
- <T> void prepareCreateView(SQLStatement stat, TableDefinition<T> def, String fromWhere);
-
- /**
- * Get the DROP VIEW statement.
- *
- * @param stat
- * return the SQL statement
- * @param def
- * table definition
- */
- <T> void prepareDropView(SQLStatement stat, TableDefinition<T> def);
-
- /**
- * Get the CREATE INDEX statement.
- *
- * @param stat
- * return the SQL statement
- * @param schemaName
- * the schema name
- * @param tableName
- * the table name
- * @param index
- * the index definition
- */
- void prepareCreateIndex(SQLStatement stat, String schemaName, String tableName, IndexDefinition index);
-
- /**
- * Get a MERGE or REPLACE INTO statement.
- *
- * @param stat
- * return the SQL statement
- * @param schemaName
- * the schema name
- * @param tableName
- * the table name
- * @param def
- * the table definition
- * @param obj
- * values
- */
- <T> void prepareMerge(SQLStatement stat, String schemaName, String tableName, TableDefinition<T> def,
- Object obj);
-
- /**
- * Append "LIMIT limit OFFSET offset" to the SQL statement.
- *
- * @param stat
- * the statement
- * @param limit
- * the limit
- * @param offset
- * the offset
- */
- void appendLimitOffset(SQLStatement stat, long limit, long offset);
-
- /**
- * Returns the preferred DATETIME class for the database.
- * <p>
- * Either java.util.Date or java.sql.Timestamp
- *
- * @return preferred DATETIME class
- */
- Class<? extends java.util.Date> getDateTimeClass();
-
- /**
- * When building static string statements this method flattens an object to
- * a string representation suitable for a static string statement.
- *
- * @param o
- * @return the string equivalent of this object
- */
- String prepareStringParameter(Object o);
-
- /**
- * Returns the name of a formatted column identifier for the dialect.
- *
- * @param name
- * the column name
- * @return the column name without formatting syntax
- */
- String extractColumnName(String name);
+ /**
+ * Registers the type adapter instance.
+ *
+ * @param typeAdapter
+ */
+ void registerAdapter(DataTypeAdapter<?> typeAdapter);
+
+ /**
+ * Returns the registered instance of the type adapter.
+ *
+ * @param typeAdapter
+ * @return the type adapter instance
+ */
+ DataTypeAdapter<?> getAdapter(Class<? extends DataTypeAdapter<?>> typeAdapter);
+
+ /**
+ * Serialize the Java object into a type or format that the database will accept.
+ *
+ * @param value
+ * @param typeAdapter
+ * @return the serialized object
+ */
+ <T> Object serialize(T value, Class<? extends DataTypeAdapter<?>> typeAdapter);
+
+ /**
+ * Deserialize the object received from the database into a Java type.
+ *
+ * @param rs
+ * @param columnIndex
+ * @param targetType
+ * @param typeAdapter
+ * @return the deserialized object
+ */
+ Object deserialize(ResultSet rs, int columnIndex, Class<?> targetType, Class<? extends DataTypeAdapter<?>> typeAdapter);
+
+ /**
+ * Configure the dialect.
+ *
+ * @param db
+ */
+ void configureDialect(Db db);
+
+ /**
+ * Returns true if savepoints are supported.
+ *
+ * @return true if savepoints may be used.
+ */
+ boolean supportsSavePoints();
+
+ /**
+ * Allows a dialect to substitute an SQL type.
+ *
+ * @param sqlType
+ * @return the dialect-safe type
+ */
+ String convertSqlType(String sqlType);
+
+ /**
+ * Returns a properly formatted table name for the dialect.
+ *
+ * @param schemaName the schema name, or null for no schema
+ * @param tableName the properly formatted table name
+ * @return the SQL snippet
+ */
+ String prepareTableName(String schemaName, String tableName);
+
+ /**
+ * Returns a properly formatted column name for the dialect.
+ *
+ * @param name the column name
+ * @return the properly formatted column name
+ */
+ String prepareColumnName(String name);
+
+ /**
+ * Get the CREATE TABLE statement.
+ *
+ * @param stat
+ * @param def
+ */
+ <T> void prepareCreateTable(SQLStatement stat, TableDefinition<T> def);
+
+ /**
+ * Get the DROP TABLE statement.
+ *
+ * @param stat
+ * @param def
+ */
+ <T> void prepareDropTable(SQLStatement stat, TableDefinition<T> def);
+
+
+ /**
+ * Get the CREATE VIEW statement.
+ *
+ * @param stat return the SQL statement
+ * @param def table definition
+ */
+ <T> void prepareCreateView(SQLStatement stat, TableDefinition<T> def);
+
+ /**
+ * Get the CREATE VIEW statement.
+ *
+ * @param stat return the SQL statement
+ * @param def table definition
+ * @param fromWhere
+ */
+ <T> void prepareCreateView(SQLStatement stat, TableDefinition<T> def, String fromWhere);
+
+ /**
+ * Get the DROP VIEW statement.
+ *
+ * @param stat return the SQL statement
+ * @param def table definition
+ */
+ <T> void prepareDropView(SQLStatement stat, TableDefinition<T> def);
+
+ /**
+ * Get the CREATE INDEX statement.
+ *
+ * @param stat return the SQL statement
+ * @param schemaName the schema name
+ * @param tableName the table name
+ * @param index the index definition
+ */
+ void prepareCreateIndex(SQLStatement stat, String schemaName, String tableName, IndexDefinition index);
+
+ /**
+ * Get a MERGE or REPLACE INTO statement.
+ *
+ * @param stat return the SQL statement
+ * @param schemaName the schema name
+ * @param tableName the table name
+ * @param def the table definition
+ * @param obj values
+ */
+ <T> void prepareMerge(SQLStatement stat, String schemaName, String tableName, TableDefinition<T> def,
+ Object obj);
+
+ /**
+ * Append "LIMIT limit OFFSET offset" to the SQL statement.
+ *
+ * @param stat the statement
+ * @param limit the limit
+ * @param offset the offset
+ */
+ void appendLimitOffset(SQLStatement stat, long limit, long offset);
+
+ /**
+ * Returns the preferred DATETIME class for the database.
+ * <p>
+ * Either java.util.Date or java.sql.Timestamp
+ *
+ * @return preferred DATETIME class
+ */
+ Class<? extends java.util.Date> getDateTimeClass();
+
+ /**
+ * When building static string statements this method flattens an object to
+ * a string representation suitable for a static string statement.
+ *
+ * @param o
+ * @return the string equivalent of this object
+ */
+ String prepareStringParameter(Object o);
+
+ /**
+ * Returns the name of a formatted column identifier for the dialect.
+ *
+ * @param name the column name
+ * @return the column name without formatting syntax
+ */
+ String extractColumnName(String name);
}