com.xdev.jadoth.sqlengine.dbms

Interface DbmsRetrospectionAccessor<A extends DbmsAdaptor<A>>

Type Parameters:

A - the generic type

All Superinterfaces:

DbmsAdaptor.Member<A>

All Known Implementing Classes:

DbmsRetrospectionAccessor.Implementation, StandardRetrospectionAccessor

public interface DbmsRetrospectionAccessor<A extends DbmsAdaptor<A>>
extends DbmsAdaptor.Member<A>

The Interface DbmsRetrospectionAccessor.

Author:

Thomas Muenz

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DbmsRetrospectionAccessor.Implementation<A extends DbmsAdaptor<A>> Body implementation of DbmsRetrospection.

Field Summary

Fields

Modifier and Type	Field and Description
static String	Column_CHARACTER_MAXIMUM_LENGTH The Constant Column_CHARACTER_MAXIMUM_LENGTH.
static String	Column_COLUMN_DEFAULT The Constant Column_COLUMN_DEFAULT.
static String	Column_COLUMN_NAME The Constant Column_COLUMN_NAME.
static String	Column_DATA_TYPE The Constant Column_DATA_TYPE.
static String	Column_IS_NULLABLE The Constant Column_IS_NULLABLE.
static String	Column_TABLE_NAME The Constant Column_TABLE_NAME.
static String	Column_TABLE_SCHEMA The Constant Column_TABLE_SCHEMA.
static String	Column_TABLE_TYPE The Constant Column_TABLE_TYPE.

Method Summary

Modifier and Type	Method and Description
String	createSelect_INFORMATION_SCHEMA_COLUMNS(SqlTableIdentity table) Creates the select_ informatio n_ schem a_ columns.
String	createSelect_INFORMATION_SCHEMA_INDICES(SqlTableIdentity table) Creates the select_ informatio n_ schem a_ indices.
String	createSelect_INFORMATION_SCHEMA_TABLES(String[] schemaInclusionPatterns, String[] schemaExclusionPatterns, String[] tableInclusionPatterns, String[] tableExclusionPatterns, String additionalWHERECondition) Creates the select_ informatio n_ schem a_ tables.
List<RetrospectionIdentifierMapper>	getColumnIdentifierMappers() Gets the column identifier mappers.
A	getDbmsAdaptor() Gets the dbms adaptor.
List<RetrospectionIdentifierMapper>	getGeneralIdentifierMappers() Gets the general identifier mappers.
List<RetrospectionIdentifierMapper>	getIndexIdentifierMappers() Gets the index identifier mappers.
String	getRetrospectionCodeGenerationNote() Gets the retrospection code generation note.
List<RetrospectionIdentifierMapper>	getSchemaIdentifierMappers() Gets the schema identifier mappers.
SqlTableIdentity	getSystemTable_COLUMNS() Gets the system table_ columns.
SqlTableIdentity	getSystemTable_TABLES() Gets the system table_ tables.
List<RetrospectionIdentifierMapper>	getTableIdentifierMappers() Gets the table identifier mappers.
SqlField[]	loadColumns(SqlTableIdentity table) Load columns.
SqlIndex[]	loadIndices(SqlTableIdentity table) Load indices.
SqlTableIdentity[]	loadTables(String[] schemaInclusionPatterns, String[] schemaExclusionPatterns, String[] tableInclusionPatterns, String[] tableExclusionPatterns, String additionalWHERECondition) Load tables.
List<String>	loadTablesAsStrings(String[] schemaInclusionPatterns, String[] schemaExclusionPatterns, String[] tableInclusionPatterns, String[] tableExclusionPatterns, String additionalWHERECondition) Load tables as strings.
Object	parseColumnDefaultValue(Object rawDefaultValue) Parses the column default value.
void	setColumnIdentifierMappers(List<RetrospectionIdentifierMapper> columnIdentifierMappers) Sets the column identifier mappers.
void	setGeneralIdentifierMappers(List<RetrospectionIdentifierMapper> schemaIdentifierMappers) Sets the general identifier mappers.
void	setIndexIdentifierMappers(List<RetrospectionIdentifierMapper> indexIdentifierMappers) Sets the index identifier mappers.
void	setSchemaIdentifierMappers(List<RetrospectionIdentifierMapper> schemaIdentifierMappers) Sets the schema identifier mappers.
void	setTableIdentifierMappers(List<RetrospectionIdentifierMapper> tableIdentifierMappers) Sets the table identifier mappers.

Field Detail

Column_TABLE_SCHEMA

static final String Column_TABLE_SCHEMA

The Constant Column_TABLE_SCHEMA.

See Also:

Constant Field Values

Column_TABLE_NAME

static final String Column_TABLE_NAME

The Constant Column_TABLE_NAME.

See Also:

Constant Field Values

Column_TABLE_TYPE

static final String Column_TABLE_TYPE

The Constant Column_TABLE_TYPE.

See Also:

Constant Field Values

Column_COLUMN_NAME

static final String Column_COLUMN_NAME

The Constant Column_COLUMN_NAME.

See Also:

Constant Field Values

Column_COLUMN_DEFAULT

static final String Column_COLUMN_DEFAULT

The Constant Column_COLUMN_DEFAULT.

See Also:

Constant Field Values

Column_IS_NULLABLE

static final String Column_IS_NULLABLE

The Constant Column_IS_NULLABLE.

See Also:

Constant Field Values

Column_DATA_TYPE

static final String Column_DATA_TYPE

The Constant Column_DATA_TYPE.

See Also:

Constant Field Values

Column_CHARACTER_MAXIMUM_LENGTH

static final String Column_CHARACTER_MAXIMUM_LENGTH

The Constant Column_CHARACTER_MAXIMUM_LENGTH.

See Also:

Constant Field Values

Method Detail

getGeneralIdentifierMappers

List<RetrospectionIdentifierMapper> getGeneralIdentifierMappers()

Gets the general identifier mappers.

Returns:

the general identifier mappers

getSchemaIdentifierMappers

List<RetrospectionIdentifierMapper> getSchemaIdentifierMappers()

Gets the schema identifier mappers.

Returns:

the schema identifier mappers

getTableIdentifierMappers

List<RetrospectionIdentifierMapper> getTableIdentifierMappers()

Gets the table identifier mappers.

Returns:

the table identifier mappers

getColumnIdentifierMappers

List<RetrospectionIdentifierMapper> getColumnIdentifierMappers()

Gets the column identifier mappers.

Returns:

the column identifier mappers

getIndexIdentifierMappers

List<RetrospectionIdentifierMapper> getIndexIdentifierMappers()

Gets the index identifier mappers.

Returns:

the index identifier mappers

setGeneralIdentifierMappers

void setGeneralIdentifierMappers(List<RetrospectionIdentifierMapper> schemaIdentifierMappers)

Sets the general identifier mappers.

Parameters:

schemaIdentifierMappers - the new general identifier mappers

setSchemaIdentifierMappers

void setSchemaIdentifierMappers(List<RetrospectionIdentifierMapper> schemaIdentifierMappers)

Sets the schema identifier mappers.

Parameters:

schemaIdentifierMappers - the new schema identifier mappers

setTableIdentifierMappers

void setTableIdentifierMappers(List<RetrospectionIdentifierMapper> tableIdentifierMappers)

Sets the table identifier mappers.

Parameters:

tableIdentifierMappers - the new table identifier mappers

setColumnIdentifierMappers

void setColumnIdentifierMappers(List<RetrospectionIdentifierMapper> columnIdentifierMappers)

Sets the column identifier mappers.

Parameters:

columnIdentifierMappers - the new column identifier mappers

setIndexIdentifierMappers

void setIndexIdentifierMappers(List<RetrospectionIdentifierMapper> indexIdentifierMappers)

Sets the index identifier mappers.

Parameters:

indexIdentifierMappers - the new index identifier mappers

getSystemTable_TABLES

SqlTableIdentity getSystemTable_TABLES()

Gets the system table_ tables.

Returns:

the system table_ tables

getSystemTable_COLUMNS

SqlTableIdentity getSystemTable_COLUMNS()

Gets the system table_ columns.

Returns:

the system table_ columns

getDbmsAdaptor

A getDbmsAdaptor()

Description copied from interface: DbmsAdaptor.Member

Gets the dbms adaptor.

Specified by:

getDbmsAdaptor in interface DbmsAdaptor.Member<A extends DbmsAdaptor<A>>

Returns:

See Also:

DbmsAdaptor.Member.getDbmsAdaptor()

createSelect_INFORMATION_SCHEMA_TABLES

String createSelect_INFORMATION_SCHEMA_TABLES(String[] schemaInclusionPatterns,
                                              String[] schemaExclusionPatterns,
                                              String[] tableInclusionPatterns,
                                              String[] tableExclusionPatterns,
                                              String additionalWHERECondition)

Creates the select_ informatio n_ schem a_ tables.

Parameters:

schemaInclusionPatterns - the schema inclusion patterns

schemaExclusionPatterns - the schema exclusion patterns

tableInclusionPatterns - the table inclusion patterns

tableExclusionPatterns - the table exclusion patterns

additionalWHERECondition - the additional where condition

Returns:

the string

loadTables

SqlTableIdentity[] loadTables(String[] schemaInclusionPatterns,
                              String[] schemaExclusionPatterns,
                              String[] tableInclusionPatterns,
                              String[] tableExclusionPatterns,
                              String additionalWHERECondition)
                       throws SQLEngineException

Load tables.

Parameters:

schemaInclusionPatterns - the schema inclusion patterns

schemaExclusionPatterns - the schema exclusion patterns

tableInclusionPatterns - the table inclusion patterns

tableExclusionPatterns - the table exclusion patterns

additionalWHERECondition - the additional where condition

Returns:

the sql table identity[]

Throws:

SQLEngineException - the sQL engine exception

loadTablesAsStrings

List<String> loadTablesAsStrings(String[] schemaInclusionPatterns,
                                 String[] schemaExclusionPatterns,
                                 String[] tableInclusionPatterns,
                                 String[] tableExclusionPatterns,
                                 String additionalWHERECondition)
                          throws SQLEngineException

Load tables as strings.

Parameters:

schemaInclusionPatterns - the schema inclusion patterns

schemaExclusionPatterns - the schema exclusion patterns

tableInclusionPatterns - the table inclusion patterns

tableExclusionPatterns - the table exclusion patterns

additionalWHERECondition - the additional where condition

Returns:

the list

Throws:

SQLEngineException - the sQL engine exception

createSelect_INFORMATION_SCHEMA_COLUMNS

String createSelect_INFORMATION_SCHEMA_COLUMNS(SqlTableIdentity table)

Creates the select_ informatio n_ schem a_ columns.

Parameters:

table - the table

Returns:

the string

createSelect_INFORMATION_SCHEMA_INDICES

String createSelect_INFORMATION_SCHEMA_INDICES(SqlTableIdentity table)

Creates the select_ informatio n_ schem a_ indices.

Parameters:

table - the table

Returns:

the string

loadColumns

SqlField[] loadColumns(SqlTableIdentity table)
                throws SQLEngineException

Load columns.

Parameters:

table - the table

Returns:

the sql field[]

Throws:

SQLEngineException - the sQL engine exception

loadIndices

SqlIndex[] loadIndices(SqlTableIdentity table)
                throws SQLEngineException

Load indices.

Parameters:

table - the table

Returns:

the sql index[]

Throws:

SQLEngineException - the sQL engine exception

parseColumnDefaultValue

Object parseColumnDefaultValue(Object rawDefaultValue)

Parses the column default value.

Parameters:

rawDefaultValue - the raw default value

Returns:

the object

getRetrospectionCodeGenerationNote

String getRetrospectionCodeGenerationNote()

Gets the retrospection code generation note.

Returns:

the retrospection code generation note