com.xdev.jadoth.sqlengine

Class SQL

java.lang.Object

com.xdev.jadoth.sqlengine.util.SqlEngineLabels

com.xdev.jadoth.sqlengine.SQL

public class SQL
extends SqlEngineLabels

The Class SQL.

Author:

Thomas Muenz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQL.config The Class config.
static class	SQL.DATATYPE The Enum DATATYPE.
static class	SQL.FORMAT The Class FORMAT.
static class	SQL.INDEXTYPE The Enum INDEXTYPE.
static class	SQL.LANG The Class LANG.
static class	SQL.Punctuation The Class Punctuation.
static class	SQL.util The Class util.

Field Summary

Fields

Modifier and Type	Field and Description
static SqlExpression	CURRENT_CATALOG The Constant CURRENT_CATALOG.
static SqlExpression	CURRENT_SCHEMA The Constant CURRENT_SCHEMA.
static SqlExpression	CURRENT_TIME The Constant CURRENT_TIME.
static SqlExpression	CURRENT_TIMESTAMP The Constant CURRENT_TIMESTAMP.
static SqlExpression	CURRENT_USER The Constant CURRENT_USER.
static SqlExpression	FALSE The Constant FALSE.
static SqlExpression	NULL The Constant NULL.
static SqlExpression	STAR The Constant STAR.
static SqlExpression	TRUE The Constant TRUE.

Fields inherited from class com.xdev.jadoth.sqlengine.util.SqlEngineLabels

LABEL_1Param, LABEL_2Param, LABEL_3Param, LABEL_NOTNULL, LABEL_SQL_util_guessAlias, LABEL_UNIQUE

Constructor Summary

Constructors

Constructor and Description
SQL()

Method Summary

Modifier and Type	Method and Description
static SqlFunctionABS	ABS(Object value) ABS.
static ColumnValueAssignment	assign(SqlColumn column, Object value)
static SqlAggregateAVG	AVG(Object value) AVG.
static <R> CALL<R>	CALL(Class<R> returnType, PROCEDURE<R> storedProcedure, Object... paramters)
static <R> CALL<R>	CALL(PROCEDURE<R> storedProcedure, Object... paramters)
static SqlFunctionCASE	CASE_WHEN(Object whenExpression, Object thenExpression, Object elseExpression) Resembles an "if"/then/else in SQL.
static SqlFunctionCASE	CASE(Object expression) Resembles a "switch" in SQL.
static SqlColumn	col(String s) Col.
static SqlAggregateCOLLECT	COLLECT(Object expression) COLLECT.
static SqlConcatenation	concatenate(Object... characterValueExpressions) Concatenate.
static SqlCondition	condition(Object expression) Wraps the given expression object as an SqlCondition instance. If the object itself is already a SqlCondition, it is returned right away.
static boolean	connect(ConnectionProvider<?> connectionProvider) Connect.
static SqlAggregateCOUNT	COUNT() COUNT.
static SqlAggregateCOUNT	COUNT(Object value) COUNT.
static <T extends SqlTable> T	create(Class<T> tableClass, String alias) Creates the.
static ColumnValueTuple	cv(SqlColumn column, Object value)
static DISTINCT	DISTINCT(Object expression)
static DoubleQuotedExpression	doubleQuote(Object characterValueExpression) Double quote.
static ResultSet	executeQuery(String query) Execute query.
static Object	executeQuerySingle(String query) Execute query single.
static int	executeUpdate(String query) Execute update.
static SqlConditionEXISTS	EXISTS(SELECT subSelect) EXISTS.
static SqlExpression	exp(Object o) Exp.
static SqlAggregateFUSION	FUSION(Object expression) FUSION.
static DatabaseGateway<?>	getDefaultDatabaseGateway() Gets the default database gateway.
static DbmsAdaptor<?>	getDefaultDBMS() Gets the default dbms.
static DbmsDMLAssembler<?>	getDefaultDMLAssembler()
static QueryListeners	getGlobalQueryListeners()
static QueryListeners	globalQueryListeners()
static <T extends SqlDdlTable> T	initializeFor(DatabaseGateway<?> dbc, Class<T> tableClass, String alias) Initialize for.
static <T extends SqlDdlTable> T	initializeInDb(Class<T> tableClass, String alias) Initialize in db.
static SqlAggregateINTERSECTION	INTERSECTION(Object expression) INTERSECTION.
static SqlAggregateMAX	MAX(Object value) MAX.
static SqlAggregateMin	MIN(Object value) MIN.
static SqlConditionNOT	NOT(SqlCondition condition) NOT.
static SqlBooleanTerm	par(Object expression) Wraps the given expression object as an SqlBooleanTerm instance that encloses it in parenthesis (round brackets). Note that in contradiction to condition(Object), a new wrapper instance is always created to ensure that each call actually adds a pair of parenthesis (for whatever reason that might be needed).
static QuotedExpression	quote(Object characterValueExpression) Quote.
static SqlxFunctionROUND	ROUND(Object value, int decimals) ROUND.
static int	save(UPDATE update, Object... parameters) Executes update with parameters.
static SELECT	SELECT(Object... items) SELECT.
static void	setDefaultDatabaseGateway(DatabaseGateway<?> defaultDatabaseGateway) Sets the default database gateway.
static void	setDefaultDBMS(DbmsAdaptor<?> defaultDBMS) Sets the default dbms.
static void	setGlobalQueryListeners(QueryListeners queryListeners)
static SqlFunctionSUBSTRING	SUBSTRING(Object characterValueExpression, Integer startPosition) SUBSTRING.
static SqlFunctionSUBSTRING	SUBSTRING(Object characterValueExpression, Integer startPosition, Integer stringLength) SUBSTRING.
static SqlFunctionSUBSTRING	SUBSTRING(Object characterValueExpression, Integer startPosition, Integer stringLength, Integer charLengthUnits) SUBSTRING.
static SqlAggregateSUM	SUM(Object value) SUM.
static SqlTableIdentity	TABLE(String tablename) TABLE.
static SqlTableIdentity	TABLE(String tablename, String alias) TABLE.
static SqlTableIdentity	TABLE(String schema, String tablename, String alias) TABLE.
static SqlTimestamp	timestamp(int... parts) Timestamp.
static SqlxFunctionTO_CHAR	TO_CHAR(Object value, Object format) T o_ char.
static SqlxFunctionTO_NUMBER	TO_NUMBER(Object value) T o_ number.
static SqlxAggregateCOLLECT_asString	xCOLLECT_asString(Object expression) xCollect_asString.
static SqlxAggregateCOLLECT_asString	xCOLLECT_asString(Object expression, String seperator) xCollect_asString.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL

public static final SqlExpression NULL

The Constant NULL.

STAR

public static final SqlExpression STAR

The Constant STAR.

TRUE

public static final SqlExpression TRUE

The Constant TRUE.

FALSE

public static final SqlExpression FALSE

The Constant FALSE.

CURRENT_CATALOG

public static final SqlExpression CURRENT_CATALOG

The Constant CURRENT_CATALOG.

CURRENT_SCHEMA

public static final SqlExpression CURRENT_SCHEMA

The Constant CURRENT_SCHEMA.

CURRENT_TIME

public static final SqlExpression CURRENT_TIME

The Constant CURRENT_TIME.

CURRENT_TIMESTAMP

public static final SqlExpression CURRENT_TIMESTAMP

The Constant CURRENT_TIMESTAMP.

CURRENT_USER

public static final SqlExpression CURRENT_USER

The Constant CURRENT_USER.

Constructor Detail

SQL

public SQL()

Method Detail

getGlobalQueryListeners

public static QueryListeners getGlobalQueryListeners()

Returns:

globalQueryListeners

public static QueryListeners globalQueryListeners()

setGlobalQueryListeners

public static void setGlobalQueryListeners(QueryListeners queryListeners)
                                    throws NullPointerException

Parameters:

queryListeners -

Throws:

NullPointerException

getDefaultDBMS

public static DbmsAdaptor<?> getDefaultDBMS()

Gets the default dbms.

Returns:

the defaultDBMS

getDefaultDMLAssembler

public static DbmsDMLAssembler<?> getDefaultDMLAssembler()

getDefaultDatabaseGateway

public static DatabaseGateway<?> getDefaultDatabaseGateway()

Gets the default database gateway.

Returns:

the defaultDatabaseGateway

setDefaultDBMS

public static void setDefaultDBMS(DbmsAdaptor<?> defaultDBMS)

Sets the default dbms.

Parameters:

defaultDBMS - the defaultDBMS to set

setDefaultDatabaseGateway

public static void setDefaultDatabaseGateway(DatabaseGateway<?> defaultDatabaseGateway)

Sets the default database gateway.

Parameters:

defaultDatabaseGateway - the defaultDatabaseGateway to set

executeQuery

public static ResultSet executeQuery(String query)
                              throws SQLEngineException

Execute query.

Parameters:

query - the query

Returns:

the result set

Throws:

SQLEngineException - the sQL engine exception

executeQuerySingle

public static Object executeQuerySingle(String query)
                                 throws SQLEngineException

Execute query single.

Parameters:

query - the query

Returns:

the object

Throws:

SQLEngineException - the sQL engine exception

executeUpdate

public static int executeUpdate(String query)
                         throws SQLEngineException

Execute update.

Parameters:

query - the query

Returns:

the int

Throws:

SQLEngineException - the sQL engine exception

TABLE

public static final SqlTableIdentity TABLE(String tablename)

TABLE.

Parameters:

tablename - the tablename

Returns:

the sql table identity

TABLE

public static final SqlTableIdentity TABLE(String tablename,
                                           String alias)

TABLE.

Parameters:

tablename - the tablename

alias - the alias

Returns:

the sql table identity

TABLE

public static final SqlTableIdentity TABLE(String schema,
                                           String tablename,
                                           String alias)

TABLE.

Parameters:

schema - the schema

tablename - the tablename

alias - the alias

Returns:

the sql table identity

SELECT

public static final SELECT SELECT(Object... items)

SELECT.

Parameters:

items - the items

Returns:

the sELECT

CALL

public static final <R> CALL<R> CALL(Class<R> returnType,
                                     PROCEDURE<R> storedProcedure,
                                     Object... paramters)

CALL

public static final <R> CALL<R> CALL(PROCEDURE<R> storedProcedure,
                                     Object... paramters)

cv

public static ColumnValueTuple cv(SqlColumn column,
                                  Object value)

assign

public static ColumnValueAssignment assign(SqlColumn column,
                                           Object value)

ABS

public static final SqlFunctionABS ABS(Object value)

ABS.

Parameters:

value - the value

Returns:

the sql function abs

SUM

public static final SqlAggregateSUM SUM(Object value)

SUM.

Parameters:

value - the value

Returns:

the sql aggregate sum

MAX

public static final SqlAggregateMAX MAX(Object value)

MAX.

Parameters:

value - the value

Returns:

the sql aggregate max

MIN

public static final SqlAggregateMin MIN(Object value)

MIN.

Parameters:

value - the value

Returns:

the sql aggregate min

AVG

public static final SqlAggregateAVG AVG(Object value)

AVG.

Parameters:

value - the value

Returns:

the sql aggregate avg

COUNT

public static final SqlAggregateCOUNT COUNT()

COUNT.

Returns:

the sql aggregate count

COUNT

public static final SqlAggregateCOUNT COUNT(Object value)

COUNT.

Parameters:

value - the value

Returns:

the sql aggregate count

COLLECT

public static final SqlAggregateCOLLECT COLLECT(Object expression)

COLLECT.

Parameters:

expression - the expression

Returns:

the sql aggregate collect

xCOLLECT_asString

public static final SqlxAggregateCOLLECT_asString xCOLLECT_asString(Object expression)

xCollect_asString.

Parameters:

expression - the expression

Returns:

the sqlx aggregate collect as string

xCOLLECT_asString

public static final SqlxAggregateCOLLECT_asString xCOLLECT_asString(Object expression,
                                                                    String seperator)

xCollect_asString.

Parameters:

expression - the expression

seperator - the seperator

Returns:

the sqlx aggregate collect as string

FUSION

public static final SqlAggregateFUSION FUSION(Object expression)

FUSION.

Parameters:

expression - the expression

Returns:

the sql aggregate fusion

INTERSECTION

public static final SqlAggregateINTERSECTION INTERSECTION(Object expression)

INTERSECTION.

Parameters:

expression - the expression

Returns:

the sql aggregate intersection

DISTINCT

public static final DISTINCT DISTINCT(Object expression)

concatenate

public static final SqlConcatenation concatenate(Object... characterValueExpressions)

Concatenate.

Parameters:

characterValueExpressions - the character value expressions

Returns:

the sql concatenation

CASE_WHEN

public static final SqlFunctionCASE CASE_WHEN(Object whenExpression,
                                              Object thenExpression,
                                              Object elseExpression)

Resembles an "if"/then/else in SQL.

Parameters:

whenExpression - the when expression

thenExpression - the then expression

elseExpression - the else expression

Returns:

the sql function case

See Also:

SQL.CASE} for the "switch" equivalent

CASE

public static final SqlFunctionCASE CASE(Object expression)

Resembles a "switch" in SQL.

Parameters:

expression - the expression

Returns:

the sql function case

See Also:

SQL.CASE_WHEN} for the "if"/then/else equivalent

SUBSTRING

public static final SqlFunctionSUBSTRING SUBSTRING(Object characterValueExpression,
                                                   Integer startPosition,
                                                   Integer stringLength,
                                                   Integer charLengthUnits)

SUBSTRING.

Parameters:

characterValueExpression - the character value expression

startPosition - the start position

stringLength - the string length

charLengthUnits - the char length units

Returns:

the sql function substring

SUBSTRING

public static final SqlFunctionSUBSTRING SUBSTRING(Object characterValueExpression,
                                                   Integer startPosition,
                                                   Integer stringLength)

SUBSTRING.

Parameters:

characterValueExpression - the character value expression

startPosition - the start position

stringLength - the string length

Returns:

the sql function substring

SUBSTRING

public static final SqlFunctionSUBSTRING SUBSTRING(Object characterValueExpression,
                                                   Integer startPosition)

SUBSTRING.

Parameters:

characterValueExpression - the character value expression

startPosition - the start position

Returns:

the sql function substring

NOT

public static final SqlConditionNOT NOT(SqlCondition condition)

NOT.

Parameters:

condition - the condition

Returns:

the sql condition not

EXISTS

public static final SqlConditionEXISTS EXISTS(SELECT subSelect)

EXISTS.

Parameters:

subSelect - the sub select

Returns:

the sql condition exists

TO_NUMBER

public static final SqlxFunctionTO_NUMBER TO_NUMBER(Object value)

T o_ number.

Parameters:

value - the value

Returns:

the sqlx function t o_ number

TO_CHAR

public static final SqlxFunctionTO_CHAR TO_CHAR(Object value,
                                                Object format)

T o_ char.

Parameters:

value - the value

format - the format

Returns:

the sqlx function t o_ char

ROUND

public static final SqlxFunctionROUND ROUND(Object value,
                                            int decimals)

ROUND.

Parameters:

value - the value

decimals - the decimals

Returns:

the sqlx function round

quote

public static QuotedExpression quote(Object characterValueExpression)

Quote.

Parameters:

characterValueExpression - the character value expression

Returns:

the quoted expression

doubleQuote

public static DoubleQuotedExpression doubleQuote(Object characterValueExpression)

Double quote.

Parameters:

characterValueExpression - the character value expression

Returns:

the double quoted expression

par

public static final SqlBooleanTerm par(Object expression)

Wraps the given expression object as an SqlBooleanTerm instance that encloses it in parenthesis (round brackets).
Note that in contradiction to condition(Object), a new wrapper instance is always created to ensure that each call actually adds a pair of parenthesis (for whatever reason that might be needed).

Parameters:

expression - the expression to be wrapped as SqlBooleanTerm

Returns:

a SqlBooleanTerm instance wrapping the passed expression object.

condition

public static final SqlCondition condition(Object expression)

Wraps the given expression object as an SqlCondition instance.
If the object itself is already a SqlCondition, it is returned right away.

Parameters:

expression - the expression to be wrapped as SqlCondition

Returns:

a SqlCondition instance representing the passed expression object's content as a condition.

exp

public static final SqlExpression exp(Object o)

Exp.

Parameters:

o - the o

Returns:

the sql expression

col

public static final SqlColumn col(String s)

Col.

Parameters:

s - the s

Returns:

the sql column

timestamp

public static final SqlTimestamp timestamp(int... parts)

Timestamp.

Parameters:

parts - the parts

Returns:

the sql timestamp

connect

public static boolean connect(ConnectionProvider<?> connectionProvider)
                       throws SQLEngineCouldNotConnectToDBException

Connect.

Parameters:

connectionProvider - the connection provider

Returns:

true, if successful

Throws:

SQLEngineCouldNotConnectToDBException - the sQL engine could not connect to db exception

create

public static <T extends SqlTable> T create(Class<T> tableClass,
                                            String alias)
                                     throws SQLEngineRuntimeException

Creates the.

Type Parameters:

T - the generic type

Parameters:

tableClass - the table class

alias - the alias

Returns:

the t

Throws:

SQLEngineRuntimeException - the sQL engine runtime exception

initializeInDb

public static <T extends SqlDdlTable> T initializeInDb(Class<T> tableClass,
                                                       String alias)
                                                throws SQLEngineRuntimeException

Initialize in db.

Type Parameters:

T - the generic type

Parameters:

tableClass - the table class

alias - the alias

Returns:

the t

Throws:

SQLEngineRuntimeException - the sQL engine runtime exception

initializeFor

public static <T extends SqlDdlTable> T initializeFor(DatabaseGateway<?> dbc,
                                                      Class<T> tableClass,
                                                      String alias)
                                               throws SQLEngineRuntimeException

Initialize for.

Type Parameters:

T - the generic type

Parameters:

dbc - the dbc

tableClass - the table class

alias - the alias

Returns:

the t

Throws:

SQLEngineRuntimeException - the sQL engine runtime exception

save

public static int save(UPDATE update,
                       Object... parameters)

Executes update with parameters. If 0 rows have been affected by the UPDATE, then an INSERT with the same column-value assignment and target table is derived from the UPDATE and executed.

A save is meant to update or insert values for a single row of data automatically as needed. Still it is possible, to update multiple rows via call of this method, if the conditions in update are set in the right way (or "wrong" way, if you intended to only update one row.)

If the UPDATE already affects rows, the performance of this method is the same as calling UPDATE.execute() directly. Only if an INSERT is really needed additional work is done.

Parameters:

update -

parameters -

Returns:

the number of affected rows