com.partnersoft.sql

Class GenericSqlDialect

java.lang.Object

com.partnersoft.sql.GenericSqlDialect

All Implemented Interfaces:

Lib, SqlDialect

Direct Known Subclasses:

AccessDialect, DerbyDialect, HsqlDialect, MySqlDialect, ProgressDialect

public class GenericSqlDialect
extends java.lang.Object
implements SqlDialect

Generic SqlDialect. Ignores any operation that is type specific.

Any type specific behavior should be put in a database specific Dialect class, and added to SqlType for the correct type's getDialect().

Copyright 2009 Partner Software, Inc.

Author:

Rich Stepanski

Constructor Summary

Constructors

Constructor and Description
GenericSqlDialect()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addColumn(java.lang.String tableName, CogStructureField newField, CogType newFieldType) Returns complete Sql to add a column.
java.lang.String	alterColumn(java.lang.String tableName, CogStructureField newField, CogType newFieldType) Returns complete Sql to alter a column.
java.lang.String	cogTypeToSqlType(CogType type) Helper for converting from a CogType to a Sql flavor specific data type.
java.lang.String	createTable(CogSchema schema, CogStructureType tableType) Returns complete Sql create table statement.
java.lang.String	createTableFromSelect(CogSchema schema, java.lang.String createTableName, DataRecordQuery query, CogStructureType queryTableType) Returns complete Sql statement for creating a table as a select from another existing table.
java.lang.Object	dbToObject(java.lang.String ogValueType, java.lang.Object dbValue) Converts and returns the passed Object, as stored in database.
java.lang.String	describeTable(java.lang.String tableName, java.lang.String databaseName) Returns sql for describing a table.
java.lang.String	describleTableColumnKey() Returns key name for column name found in describe table ResultSet
java.lang.String	describleTableTypeKey() Returns key name for column type found in describe table ResultSet
java.lang.String	dropColumn(java.lang.String tableName, java.lang.String fieldName) Returns complete Sql to drop a column.
protected java.lang.String	handleSorts(java.util.List<DataFilterSort> sorts) Helper method.
boolean	isAlterColumnSupported() Returns true if columns can be altered.
boolean	isDescribeTableSupported() Returns true if this flavor of sql supports describe table via sql statments.
boolean	isListDatabasesSupported() Returns true if this flavor of sql supports list databases via sql statements.
boolean	isListTablesSupported() Returns true if this flavor of sql supports list tables via sql statements.
java.lang.String	listDatabases() Returns sql for listing databases If isDescribeTableSupported() returns false, should throw an UnsupportedOperationException
protected java.lang.String	listFields(java.util.List<java.lang.String> fields) Helper method.
java.lang.String	listTables(java.lang.String tableName) Returns sql for listing table names in database.
java.lang.Object	objectToDb(java.lang.String fieldValueType, java.lang.Object value) Converts the passed Object of passed value type into database specific equivalent.
java.lang.String	objectToDbSql(java.lang.String fieldValueType, java.lang.Object value) Converts passed Object of passed value type into database equivalent sql and returns.
protected java.lang.String	parseFilter(DataFilterExpression filter, CogStructureType type) Recursive helper for parsing DataFilterExpressions into sql.
java.lang.String	renameTable(java.lang.String originalName, java.lang.String renamedName) Returns Sql for renaming a given table to another.
java.lang.String	selectSql(DataRecordQuery query, CogStructureType tableType) Returns complete Sql select statement.
java.lang.String	sqlTypeToCogType(java.lang.String sqlType) Helper for converting from a Sql data type to a Cog value type.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSqlDialect

public GenericSqlDialect()

Method Detail

parseFilter

protected java.lang.String parseFilter(DataFilterExpression filter,
                           CogStructureType type)

Recursive helper for parsing DataFilterExpressions into sql. This is protected so specific sql types can handle parsing in their own way.

Parameters:

filter - - DataFilterExpression to parse for Sql.

type - - CogStructureType defining the fields in filter.

Returns:

Sql equivalent of passed filter. (ie, all text after a 'where' in a Sql Where clause.

objectToDb

public java.lang.Object objectToDb(java.lang.String fieldValueType,
                          java.lang.Object value)

Description copied from interface: SqlDialect

Converts the passed Object of passed value type into database specific equivalent.

Ex. Dates may be stored as Numbers or Strings.

Specified by:

objectToDb in interface SqlDialect

Parameters:

fieldValueType - - CogStructureField value type for this field.

value - - Value to covert database Object

Returns:

database storage type equivalent

objectToDbSql

public java.lang.String objectToDbSql(java.lang.String fieldValueType,
                             java.lang.Object value)

Description copied from interface: SqlDialect

Converts passed Object of passed value type into database equivalent sql and returns. Includes quotes if applicable.

By default, should return SqlLib.convertToStringAndQuote(Object)

Specified by:

objectToDbSql in interface SqlDialect

Parameters:

fieldValueType - - CogStructureField value type of value.

value - - value to convert to sql

Returns:

full sql for passed value, including quotes if applicable.

cogTypeToSqlType

public java.lang.String cogTypeToSqlType(CogType type)

Description copied from interface: SqlDialect

Helper for converting from a CogType to a Sql flavor specific data type. Default returns the CogPrimitiveType's sqlType, or VARCHAR(255)

Specified by:

cogTypeToSqlType in interface SqlDialect

Parameters:

type - - CogType to convert to Sql type.

Returns:

Sql flavor specific data type for the passed cog type.

sqlTypeToCogType

public java.lang.String sqlTypeToCogType(java.lang.String sqlType)

Description copied from interface: SqlDialect

Helper for converting from a Sql data type to a Cog value type.

Specified by:

sqlTypeToCogType in interface SqlDialect

Parameters:

sqlType - - String representing sql type (ie, varchar(255))

Returns:

Cog value type that matches sql type

isAlterColumnSupported

public boolean isAlterColumnSupported()

Description copied from interface: SqlDialect

Returns true if columns can be altered.

Specified by:

isAlterColumnSupported in interface SqlDialect

Returns:

true if columns can be altered.

renameTable

public java.lang.String renameTable(java.lang.String originalName,
                           java.lang.String renamedName)

Description copied from interface: SqlDialect

Returns Sql for renaming a given table to another.

Specified by:

renameTable in interface SqlDialect

Parameters:

originalName - - Original table name to rename

renamedName - - Name to rename to.

Returns:

Sql for renaming tables.

listFields

protected java.lang.String listFields(java.util.List<java.lang.String> fields)

Helper method. Returns comma separated String containing passed list. ex. "fields[0],fields[1],...,fields[n]"

Parameters:

fields -

Returns:

Comma separated list of passed fields.

dbToObject

public java.lang.Object dbToObject(java.lang.String ogValueType,
                          java.lang.Object dbValue)

Description copied from interface: SqlDialect

Converts and returns the passed Object, as stored in database. to the original value type.

This should reverse any flavor specific conversion done in SqlDialect.objectToDb(String, Object)

Specified by:

dbToObject in interface SqlDialect

Parameters:

ogValueType - - Original Cog value type name.

dbValue - - Value from database

Returns:

converted database object

handleSorts

protected java.lang.String handleSorts(java.util.List<DataFilterSort> sorts)

Helper method. Returns complete ORDER BY clause. ex. " ORDER BY sorts[0].fieldName ASC, sorts[1].fieldName DESC"

Parameters:

sorts -

Returns:

selectSql

public java.lang.String selectSql(DataRecordQuery query,
                         CogStructureType tableType)

Description copied from interface: SqlDialect

Returns complete Sql select statement.

Specified by:

selectSql in interface SqlDialect

Parameters:

query - - Query describing select statement.

tableType - - CogStructureType defining table. Type name is assumed to be table name.

Returns:

Sql select statement for passed query.

createTableFromSelect

public java.lang.String createTableFromSelect(CogSchema schema,
                                     java.lang.String createTableName,
                                     DataRecordQuery query,
                                     CogStructureType queryTableType)

Description copied from interface: SqlDialect

Returns complete Sql statement for creating a table as a select from another existing table.

Specified by:

createTableFromSelect in interface SqlDialect

Parameters:

schema - - Schema defining column types.

createTableName - - Name of table to create

query - - DataRecordQuery to create from

queryTableType - - CogStructureType defining table to be queried.

Returns:

Sql create table from select statement for passed schema and cog type.

createTable

public java.lang.String createTable(CogSchema schema,
                           CogStructureType tableType)

Description copied from interface: SqlDialect

Returns complete Sql create table statement.

Specified by:

createTable in interface SqlDialect

Parameters:

schema - - Schema defining column types.

tableType - - CogStructureType defining table. Type name is assumed to be table name.

Returns:

Sql create table statement for passed schema and cog type.

addColumn

public java.lang.String addColumn(java.lang.String tableName,
                         CogStructureField newField,
                         CogType newFieldType)

Description copied from interface: SqlDialect

Returns complete Sql to add a column.

Specified by:

addColumn in interface SqlDialect

Parameters:

tableName - - Name of table to add a column to.

newField - - Field to add.

newFieldType - - CogType of field to add.

Returns:

Sql to add a column.

alterColumn

public java.lang.String alterColumn(java.lang.String tableName,
                           CogStructureField newField,
                           CogType newFieldType)

Description copied from interface: SqlDialect

Returns complete Sql to alter a column.

Specified by:

alterColumn in interface SqlDialect

Parameters:

tableName - - Name of table to alter column in.

newField - - Field to change.

newFieldType - - CogType for the passed field.

Returns:

Sql to alter a column.

dropColumn

public java.lang.String dropColumn(java.lang.String tableName,
                          java.lang.String fieldName)

Description copied from interface: SqlDialect

Returns complete Sql to drop a column.

Specified by:

dropColumn in interface SqlDialect

Parameters:

tableName - - Name of table to drop column from.

fieldName - - Name of field to drop.

Returns:

complete Sql to drop a column.

isListTablesSupported

public boolean isListTablesSupported()

Description copied from interface: SqlDialect

Returns true if this flavor of sql supports list tables via sql statements. False if it does not.

Specified by:

isListTablesSupported in interface SqlDialect

Returns:

True if list tables is supported via sql statements, false otherwise

isDescribeTableSupported

public boolean isDescribeTableSupported()

Description copied from interface: SqlDialect

Returns true if this flavor of sql supports describe table via sql statments. False if it does not.

Specified by:

isDescribeTableSupported in interface SqlDialect

Returns:

True if describe tables is supported via sql statements, false otherwise.

isListDatabasesSupported

public boolean isListDatabasesSupported()

Description copied from interface: SqlDialect

Returns true if this flavor of sql supports list databases via sql statements. False if it does not.

Specified by:

isListDatabasesSupported in interface SqlDialect

Returns:

True if list databases is supported via sql statements, false otherwise

listDatabases

public java.lang.String listDatabases()

Description copied from interface: SqlDialect

Returns sql for listing databases If isDescribeTableSupported() returns false, should throw an UnsupportedOperationException

Specified by:

listDatabases in interface SqlDialect

Returns:

Sql for listing databases

listTables

public java.lang.String listTables(java.lang.String tableName)

Description copied from interface: SqlDialect

Returns sql for listing table names in database. If isListTablesSupported() returns false, throws an UnsupportedOperationException

Specified by:

listTables in interface SqlDialect

Parameters:

tableName - - Name of database to list tables from

Returns:

Sql for listing table names

describeTable

public java.lang.String describeTable(java.lang.String tableName,
                             java.lang.String databaseName)

Description copied from interface: SqlDialect

Returns sql for describing a table. if isDescribeTableSupported() returns false, throws an UnsupportedOperationException

Specified by:

describeTable in interface SqlDialect

Parameters:

tableName - - Name of table to describe

databaseName - - Name of database containing table

Returns:

Sql for describing a table

describleTableColumnKey

public java.lang.String describleTableColumnKey()

Description copied from interface: SqlDialect

Returns key name for column name found in describe table ResultSet

Specified by:

describleTableColumnKey in interface SqlDialect

Returns:

key name for column name

describleTableTypeKey

public java.lang.String describleTableTypeKey()

Description copied from interface: SqlDialect

Returns key name for column type found in describe table ResultSet

Specified by:

describleTableTypeKey in interface SqlDialect

Returns:

key name for column type