Package org.springframework.data.relational.core.mapping

Interface RelationalPersistentEntity<T>

All Superinterfaces:

Aware, EnvironmentAware, Iterable<RelationalPersistentProperty>, MutablePersistentEntity<T,RelationalPersistentProperty>, PersistentEntity<T,RelationalPersistentProperty>

public interface RelationalPersistentEntity<T>
extends MutablePersistentEntity<T,RelationalPersistentProperty>

A PersistentEntity interface with additional methods for JDBC/RDBMS related metadata.

Author:

Jens Schauder, Oliver Gierke, Mark Paluch, Mikhail Polivakha

Method Summary

Modifier and Type	Method	Description
SqlIdentifier	getIdColumn()	Deprecated, for removal: This API element is subject to removal in a future version. because an entity may have multiple id columns.
default SqlIdentifier	getQualifiedTableName()	Returns the qualified name of the table backing the given entity, including the schema.
SqlIdentifier	getTableName()	Returns the unqualified name of the table (i.e. without schema or owner) backing the given entity.

Methods inherited from interface org.springframework.context.EnvironmentAware

setEnvironment

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.springframework.data.mapping.model.MutablePersistentEntity

addAssociation, addPersistentProperty, setEvaluationContextProvider, setPersistentPropertyAccessorFactory, verify

Methods inherited from interface org.springframework.data.mapping.PersistentEntity

doWithAll, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

Method Details

getTableName

SqlIdentifier getTableName()

Returns the unqualified name of the table (i.e. without schema or owner) backing the given entity.

Returns:

the table name.

getQualifiedTableName

default SqlIdentifier getQualifiedTableName()

Returns the qualified name of the table backing the given entity, including the schema.

Returns:

the table name including the schema if there is any specified.

Since:

3.0

getIdColumn

@Deprecated(forRemoval=true)
SqlIdentifier getIdColumn()

Deprecated, for removal: This API element is subject to removal in a future version.

because an entity may have multiple id columns. Use AggregatePath.getTableInfo().getIdColumnInfos() instead.

Returns the column representing the identifier.

Returns:

will never be null.