Package org.springframework.data.cassandra.core.mapping

Interface NamingStrategy

All Known Implementing Classes:

SnakeCaseNamingStrategy, TransformingNamingStrategy

public interface NamingStrategy

Interface and default implementation of a naming strategy. Defaults to table name based on Class and column name based on property names. Names are used as-is without quoting. Lower-case, non-keyword names are used without quoting. Upper-case, keyword or other names requiring quoting are used with quotes.

NOTE: Can also be used as an adapter. Create a lambda or an anonymous subclass and override any settings to implement a different strategy on the fly.

Since:

3.0

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field	Description
static final NamingStrategy	CASE_SENSITIVE	Empty implementation of the interface utilizing only the default implementation.
static final NamingStrategy	INSTANCE	Default implementation converting all names to String.toLowerCase().
static final NamingStrategy	SNAKE_CASE	Naming strategy that renders CamelCase name parts to snake_case.

Method Summary

Modifier and Type	Method	Description
default String	getColumnName(CassandraPersistentProperty property)	Create a column name from the given property.
default String	getTableName(CassandraPersistentEntity<?> entity)	Create a table name from the given CassandraPersistentEntity.
default String	getUserDefinedTypeName(CassandraPersistentEntity<?> entity)	Create a user-defined type name from the given CassandraPersistentEntity.
default NamingStrategy	transform(UnaryOperator<String> mappingFunction)	Apply a transformation function to create a new NamingStrategy that applies the given transformation to each name component.

Field Details

CASE_SENSITIVE

static final NamingStrategy CASE_SENSITIVE

Empty implementation of the interface utilizing only the default implementation.

Using this avoids creating essentially the same class over and over again.

Since:

3.3.6

INSTANCE

static final NamingStrategy INSTANCE

Default implementation converting all names to String.toLowerCase().

SNAKE_CASE

static final NamingStrategy SNAKE_CASE

Naming strategy that renders CamelCase name parts to snake_case.

Method Details

getTableName

default String getTableName(CassandraPersistentEntity<?> entity)

Create a table name from the given CassandraPersistentEntity.

getUserDefinedTypeName

default String getUserDefinedTypeName(CassandraPersistentEntity<?> entity)

Create a user-defined type name from the given CassandraPersistentEntity.

getColumnName

default String getColumnName(CassandraPersistentProperty property)

Create a column name from the given property.

transform

default NamingStrategy transform(UnaryOperator<String> mappingFunction)

Apply a transformation function to create a new NamingStrategy that applies the given transformation to each name component. Example:

NamingStrategy lower = NamingStrategy.INSTANCE.transform(String::toLowerCase);

Parameters:

mappingFunction - must not be null.

Returns:

the NamingStrategy that applies the given transformation function.