org.datanucleus.store.schema.naming

Interface NamingFactory

All Known Implementing Classes:

AbstractNamingFactory, DN2NamingFactory, JPANamingFactory

public interface NamingFactory

Representation of a naming factory for schema components (tables, columns, etc).

Method Summary

Methods

Modifier and Type	Method and Description
String	getColumnName(AbstractClassMetaData cmd, ColumnType type) Method to return the name of the column for the specified class (version, datastore-id, discriminator etc).
String	getColumnName(AbstractMemberMetaData mmd, ColumnType type) Method to return the name of the column for the specified field.
String	getColumnName(AbstractMemberMetaData mmd, ColumnType type, int position) Method to return the name of the column for the position of the specified field.
String	getTableName(AbstractClassMetaData cmd) Method to return the name of the table for the specified class.
String	getTableName(AbstractMemberMetaData mmd) Method to return the name of the (join) table for the specified field.
NamingFactory	setMaximumLength(SchemaComponent cmpt, int max) Method to set the maximum length of the name of the specified schema component.
NamingFactory	setNamingCase(NamingCase nameCase) Method to set the required case of the names.
NamingFactory	setQuoteString(String quote) Method to set the quote string to use (when the identifiers need to be quoted).
NamingFactory	setWordSeparator(String sep) Method to set the word separator of the names.

Method Detail

setMaximumLength

NamingFactory setMaximumLength(SchemaComponent cmpt,
                             int max)

Method to set the maximum length of the name of the specified schema component.

Parameters:

cmpt - The component

max - The maximum it accepts

Returns:

This naming factory

setQuoteString

NamingFactory setQuoteString(String quote)

Method to set the quote string to use (when the identifiers need to be quoted). See

setIdentifierCase

.

Parameters:

quote - The quote string

Returns:

This naming factory

setWordSeparator

NamingFactory setWordSeparator(String sep)

Method to set the word separator of the names.

Parameters:

sep - Separator

Returns:

This naming factory

setNamingCase

NamingFactory setNamingCase(NamingCase nameCase)

Method to set the required case of the names.

Parameters:

nameCase - Required case

Returns:

This naming factory

getTableName

String getTableName(AbstractClassMetaData cmd)

Method to return the name of the table for the specified class.

Parameters:

cmd - Metadata for the class

Returns:

Name of the table

getTableName

String getTableName(AbstractMemberMetaData mmd)

Method to return the name of the (join) table for the specified field.

Parameters:

mmd - Metadata for the field/property needing a join table

Returns:

Name of the table

getColumnName

String getColumnName(AbstractClassMetaData cmd,
                   ColumnType type)

Method to return the name of the column for the specified class (version, datastore-id, discriminator etc).

Parameters:

cmd - Metadata for the class

type - Column type

Returns:

Name of the column

getColumnName

String getColumnName(AbstractMemberMetaData mmd,
                   ColumnType type)

Method to return the name of the column for the specified field. If you have multiple columns for a field then call the other

getColumnName

method.

Parameters:

mmd - Metadata for the field

type - Type of column

Returns:

The column name

getColumnName

String getColumnName(AbstractMemberMetaData mmd,
                   ColumnType type,
                   int position)

Method to return the name of the column for the position of the specified field. Normally the position will be 0 since most fields map to a single column, but where you have a FK to an object with composite id, or where the Java type maps to multiple columns then the position is used.

Parameters:

mmd - Metadata for the field

type - Type of column

position - Position of the column

Returns:

The column name