org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation
Show all versions of spring-data-cassandra Show documentation
Cassandra support for Spring Data
/*
* Copyright 2013-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.cassandra.core.mapping;
import org.springframework.data.cassandra.core.cql.CqlIdentifier;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.lang.Nullable;
import com.datastax.driver.core.TupleType;
import com.datastax.driver.core.UserType;
/**
* Cassandra specific {@link PersistentEntity} abstraction.
*
* @author Alex Shvid
* @author Matthew T. Adams
* @author Mark Paluch
*/
public interface CassandraPersistentEntity extends PersistentEntity {
/**
* Returns whether this entity represents a composite primary key.
*/
boolean isCompositePrimaryKey();
/**
* Sets whether to enforce quoting when using the {@link #getTableName()} in CQL.
*
* @param forceQuote {@literal true} to enforce quoting; {@literal false} to disable enforced quoting usage.
*/
void setForceQuote(boolean forceQuote);
/**
* Returns the table name to which the entity shall be persisted.
*/
CqlIdentifier getTableName();
/**
* Sets the CQL table name.
*
* @param tableName must not be {@literal null}.
*/
void setTableName(CqlIdentifier tableName);
/**
* @return {@literal true} if the type is a mapped tuple type.
* @since 2.1
* @see Tuple
*/
boolean isTupleType();
/**
* @return the {@link TupleType} matching the data types from {@link BasicCassandraPersistentTupleProperty mapped
* tuple elements}.
* @since 2.1
*/
@Nullable
TupleType getTupleType();
/**
* @return {@literal true} if the type is a mapped user defined type.
* @since 1.5
* @see UserDefinedType
*/
boolean isUserDefinedType();
/**
* @return the CQL {@link UserType} if the type is a mapped user defined type, otherwise {@literal null}.
* @since 1.5
* @see UserDefinedType
*/
@Nullable
UserType getUserType();
}