com.speedment.db

Interface DatabaseNamingConvention

public interface DatabaseNamingConvention

Regulates how the full name of a database entity is constructed.

Since:

2.3

Author:

Emil Forslund

Method Summary

Modifier and Type	Method and Description
String	encloseField(String field) Encloses the specified database name field in accordance to this database naming convention.
default String	fullNameOf(Column column) Returns the full name used in the database for the specified Column.
default String	fullNameOf(FieldIdentifier<?> fieldIdentifier) Returns the full name used in the database for the specified FieldIdentifier.
default String	fullNameOf(PrimaryKeyColumn pkc) Returns the full name used in the database for the specified PrimaryKeyColumn.
String	fullNameOf(String parentName, String targetName) Returns the full name used in the database for the specified parameters.
String	fullNameOf(String schemaName, String tableName, String columnName) Returns the full name used in the database for the specified parameters.
default String	fullNameOf(Table table) Returns the full name used in the database for the specified Table.
Set<String>	getSchemaExcludeSet() Returns a non-null Set of Strings that represents schema names that are to be excluded when examining a Dbms for schemas.
String	quoteField(String field) Quotes the specified value field in accordance to this database naming convention.

Method Detail

fullNameOf

String fullNameOf(String schemaName,
                  String tableName,
                  String columnName)

Returns the full name used in the database for the specified parameters. This is typically constructed by combining the schema, table and the column name with a separator, but that might be different in different implementations.

Parameters:

schemaName - schema name

tableName - table name

columnName - column name

Returns:

the full name

fullNameOf

String fullNameOf(String parentName,
                  String targetName)

Returns the full name used in the database for the specified parameters. This is typically constructed by combining the schema and the table name with a separator, but that might be different in different implementations.

Parameters:

parentName - parent name (e.g. schema name or table bane)

targetName - target name (e.g. table name or column name)

Returns:

the full name

fullNameOf

default String fullNameOf(FieldIdentifier<?> fieldIdentifier)

Returns the full name used in the database for the specified FieldIdentifier. This is typically constructed by combining the schema, table and column name with a separator, but that might be different in different implementations.

Parameters:

fieldIdentifier - to use

Returns:

the full name

fullNameOf

default String fullNameOf(PrimaryKeyColumn pkc)

Returns the full name used in the database for the specified PrimaryKeyColumn. This is typically constructed by combining the table and the column name with a separator, but that might be different in different implementations.

Parameters:

pkc - the primary key column to retrieve the name of

Returns:

the full name

fullNameOf

default String fullNameOf(Column column)

Returns the full name used in the database for the specified Column. This is typically constructed by combining the table and the column name with a separator, but that might be different in different implementations.

Parameters:

column - the column to retrieve the name of

Returns:

the full name

fullNameOf

default String fullNameOf(Table table)

Returns the full name used in the database for the specified Table. This is typically constructed by combining the schema and the table name with a separator, but that might be different in different implementations.

Parameters:

table - the table to retrieve the name of

Returns:

the full name

quoteField

String quoteField(String field)

Quotes the specified value field in accordance to this database naming convention. This is typically used around values.

Parameters:

field - the content to quote

Returns:

the quoted content

encloseField

String encloseField(String field)

Encloses the specified database name field in accordance to this database naming convention. This is typically used around column or table names.

Parameters:

field - the content to quote

Returns:

the quoted content

getSchemaExcludeSet

Set<String> getSchemaExcludeSet()

Returns a non-null Set of Strings that represents schema names that are to be excluded when examining a Dbms for schemas. The set typically contains names for system tables and similar things. For example for MySQL, the schemas "MySQL" and "information_schema" are typically excluded.

Returns:

a non-null Set of Strings that represents schema names that are to be excluded when examining a Dbms for schemas