Package org.springframework.data.cassandra.core.convert

Class SchemaFactory

java.lang.Object

org.springframework.data.cassandra.core.convert.SchemaFactory

public class SchemaFactory
extends Object

Factory for Cassandra Schema objects such as user-defined types, tables and indexes.

Since:

3.0

Author:

Mark Paluch, Christoph Strobl, Aleksei Zotov

See Also:

• CreateUserTypeSpecification
• CreateTableSpecification
• CreateIndexSpecification
• CassandraMappingContext

Constructor Summary

Constructors

Constructor	Description
SchemaFactory(CassandraConverter converter)	Creates a new SchemaFactory given CassandraConverter.
SchemaFactory(MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty> mappingContext, CustomConversions customConversions, com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)	Creates a new SchemaFactory given MappingContext, CustomConversions and CodecRegistry.

Method Summary

Modifier and Type	Method	Description
List<CreateIndexSpecification>	getCreateIndexSpecificationsFor(Class<?> entityType)	Returns index specifications derived from CassandraPersistentEntity.
List<CreateIndexSpecification>	getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity)	Returns index specifications derived from CassandraPersistentEntity.
List<CreateIndexSpecification>	getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity, com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Returns index specifications derived from CassandraPersistentEntity using table name.
CreateTableSpecification	getCreateTableSpecificationFor(Class<?> entityType)	Returns a CreateTableSpecification for the given entity, including all mapping information.
CreateTableSpecification	getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity)	Returns a CreateTableSpecification for the given entity, including all mapping information.
CreateTableSpecification	getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity, com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Returns a CreateTableSpecification for the given entity using table name, including all mapping information.
CreateUserTypeSpecification	getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity)	Returns a CreateUserTypeSpecification for the given entity, including all mapping information.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaFactory

public SchemaFactory(CassandraConverter converter)

Creates a new SchemaFactory given CassandraConverter.

Parameters:

converter - must not be null.

SchemaFactory

public SchemaFactory(MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty> mappingContext,
 CustomConversions customConversions,
 com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry codecRegistry)

Creates a new SchemaFactory given MappingContext, CustomConversions and CodecRegistry.

Parameters:

mappingContext - must not be null.

customConversions - must not be null.

codecRegistry - must not be null.

Method Details

getCreateTableSpecificationFor

public CreateTableSpecification getCreateTableSpecificationFor(Class<?> entityType)

Returns a CreateTableSpecification for the given entity, including all mapping information.

Parameters:

entityType - must not be null.

Returns:

the CreateTableSpecification derived from entityType.

getCreateTableSpecificationFor

public CreateTableSpecification getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity)

Returns a CreateTableSpecification for the given entity, including all mapping information.

Parameters:

entity - must not be null.

Returns:

the CreateTableSpecification derived from CassandraPersistentEntity.

getCreateTableSpecificationFor

public CreateTableSpecification getCreateTableSpecificationFor(CassandraPersistentEntity<?> entity,
 com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Returns a CreateTableSpecification for the given entity using table name, including all mapping information.

Parameters:

entity - must not be null.

tableName - must not be null.

Returns:

Since:

2.2

getCreateIndexSpecificationsFor

public List<CreateIndexSpecification> getCreateIndexSpecificationsFor(Class<?> entityType)

Returns index specifications derived from CassandraPersistentEntity.

Parameters:

entityType - must not be null.

Returns:

the CreateTableSpecification derived from entityType.

getCreateIndexSpecificationsFor

public List<CreateIndexSpecification> getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity)

Returns index specifications derived from CassandraPersistentEntity.

Parameters:

entity - must not be null.

Returns:

Since:

2.0

getCreateIndexSpecificationsFor

public List<CreateIndexSpecification> getCreateIndexSpecificationsFor(CassandraPersistentEntity<?> entity,
 com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Returns index specifications derived from CassandraPersistentEntity using table name.

Parameters:

entity - must not be null.

tableName - must not be null.

Returns:

Since:

2.0

getCreateUserTypeSpecificationFor

public CreateUserTypeSpecification getCreateUserTypeSpecificationFor(CassandraPersistentEntity<?> entity)

Returns a CreateUserTypeSpecification for the given entity, including all mapping information.

Parameters:

entity - must not be null.