org.datanucleus.store.schema.naming

Class AbstractNamingFactory

java.lang.Object

org.datanucleus.store.schema.naming.AbstractNamingFactory

All Implemented Interfaces:

NamingFactory

Direct Known Subclasses:

DN2NamingFactory, JPANamingFactory

public abstract class AbstractNamingFactory
extends Object
implements NamingFactory

Abstract base for any naming factory, providing convenience facilities like truncation.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoaderResolver	clr
protected NamingCase	namingCase
protected NucleusContext	nucCtx
protected String	quoteString Quote used when the identifier case selected requires it.
protected String	wordSeparator Separator to use for words in the identifiers.

Constructor Summary

Constructors

Constructor and Description
AbstractNamingFactory(NucleusContext nucCtx)

Method Summary

Methods

Modifier and Type	Method and Description
String	getColumnName(AbstractMemberMetaData mmd, ColumnType type) Method to return the name of the column for the specified field.
protected int	getMaximumLengthForComponent(SchemaComponent cmpt)
protected String	getNameInRequiredCase(String name) Convenience method to convert the passed name into a name in the required "case".
String	getTableName(AbstractClassMetaData cmd) Method to return the name of the table for the specified class.
protected String	prepareColumnNameForUse(String name)
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.
protected static String	truncate(String name, int length) Method to truncate a name to fit within the specified name length.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datanucleus.store.schema.naming.NamingFactory

getColumnName, getColumnName, getTableName

Field Detail

wordSeparator

protected String wordSeparator

Separator to use for words in the identifiers.

quoteString

protected String quoteString

Quote used when the identifier case selected requires it.

namingCase

protected NamingCase namingCase

nucCtx

protected NucleusContext nucCtx

clr

protected ClassLoaderResolver clr

Constructor Detail

AbstractNamingFactory

public AbstractNamingFactory(NucleusContext nucCtx)

Method Detail

setQuoteString

public NamingFactory setQuoteString(String quote)

Description copied from interface: NamingFactory

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

setIdentifierCase

.

Specified by:

setQuoteString in interface NamingFactory

Parameters:

quote - The quote string

Returns:

This naming factory

setWordSeparator

public NamingFactory setWordSeparator(String sep)

Description copied from interface: NamingFactory

Method to set the word separator of the names.

Specified by:

setWordSeparator in interface NamingFactory

Parameters:

sep - Separator

Returns:

This naming factory

setNamingCase

public NamingFactory setNamingCase(NamingCase nameCase)

Description copied from interface: NamingFactory

Method to set the required case of the names.

Specified by:

setNamingCase in interface NamingFactory

Parameters:

nameCase - Required case

Returns:

This naming factory

setMaximumLength

public NamingFactory setMaximumLength(SchemaComponent cmpt,
                             int max)

Description copied from interface: NamingFactory

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

Specified by:

setMaximumLength in interface NamingFactory

Parameters:

cmpt - The component

max - The maximum it accepts

Returns:

This naming factory

getMaximumLengthForComponent

protected int getMaximumLengthForComponent(SchemaComponent cmpt)

getTableName

public String getTableName(AbstractClassMetaData cmd)

Description copied from interface: NamingFactory

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

Specified by:

getTableName in interface NamingFactory

Parameters:

cmd - Metadata for the class

Returns:

Name of the table

getColumnName

public String getColumnName(AbstractMemberMetaData mmd,
                   ColumnType type)

Description copied from interface: NamingFactory

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.

Specified by:

getColumnName in interface NamingFactory

Parameters:

mmd - Metadata for the field

type - Type of column

Returns:

The column name

truncate

protected static String truncate(String name,
              int length)

Method to truncate a name to fit within the specified name length. If truncation is necessary will use a 4 char hashcode (defined by TRUNCATE_HASH_LENGTH) (at the end) to attempt to create uniqueness.

Parameters:

name - The name

length - The (max) length to use

Returns:

The truncated name.

getNameInRequiredCase

protected String getNameInRequiredCase(String name)

Convenience method to convert the passed name into a name in the required "case". Also adds on any required quoting.

Parameters:

name - The name

Returns:

The updated name in the correct case

prepareColumnNameForUse

protected String prepareColumnNameForUse(String name)