Class BasicRelationalPersistentProperty

java.lang.Object

org.springframework.data.mapping.model.AbstractPersistentProperty<RelationalPersistentProperty>

org.springframework.data.mapping.model.AnnotationBasedPersistentProperty<RelationalPersistentProperty>

org.springframework.data.relational.core.mapping.BasicRelationalPersistentProperty

All Implemented Interfaces:

PersistentProperty<RelationalPersistentProperty>, RelationalPersistentProperty

public class BasicRelationalPersistentProperty
extends AnnotationBasedPersistentProperty<RelationalPersistentProperty>
implements RelationalPersistentProperty

SQL-specific PersistentProperty implementation.

Author:

Jens Schauder, Greg Turnquist, Florian Lüdiger, Bastian Wilhelm, Kurt Niemi, Sergey Korotaev, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
BasicRelationalPersistentProperty(Property property, PersistentEntity<?, RelationalPersistentProperty> owner, SimpleTypeHolder simpleTypeHolder, NamingStrategy namingStrategy)	Creates a new BasicRelationalPersistentProperty.

Method Summary

Modifier and Type	Method	Description
protected Association<RelationalPersistentProperty>	createAssociation()
SqlIdentifier	getColumnName()	Returns the name of the column backing this property.
String	getEmbeddedPrefix()
@Nullable SqlIdentifier	getKeyColumn()
RelationalPersistentEntity<?>	getOwner()
Class<?>	getQualifierColumnType()
SqlIdentifier	getReverseColumnName(RelationalPersistentEntity<?> owner)
@Nullable SqlIdentifier	getSequence()
boolean	hasExplicitColumnName()	Returns whether the property uses an annotated field name through Column.
boolean	isEmbedded()
boolean	isEntity()
boolean	isForceQuote()
boolean	isInsertOnly()	Returns whether this property is only to be used during inserts and read.
boolean	isOrdered()	Returns whether this property is an ordered property.
boolean	isQualified()	Returns if this property is a qualified property, i.e. a property referencing multiple elements that can get picked by a key or an index.
void	setForceQuote(boolean forceQuote)
boolean	shouldCreateEmptyEmbedded()	Returns whether an empty embedded object is supposed to be created for this property.

Methods inherited from class AnnotationBasedPersistentProperty

findAnnotation, findPropertyOrOwnerAnnotation, getAssociationTargetTypeInformation, getSpelExpression, isAnnotationPresent, isAssociation, isIdProperty, isTransient, isVersionProperty, isWritable, toString, usePropertyAccess

Methods inherited from class AbstractPersistentProperty

equals, getActualType, getActualTypeInformation, getAssociation, getAssociationTargetType, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityTypeInformation, getProperty, getRawType, getSetter, getType, getTypeInformation, getWither, hashCode, isArray, isCollectionLike, isImmutable, isMap, isReadable

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface PersistentProperty

findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getPersistentEntityTypeInformation, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isIdProperty, isImmutable, isMap, isReadable, isTransient, isVersionProperty, isWritable, usePropertyAccess

Methods inherited from interface RelationalPersistentProperty

hasSequence

Constructor Details

BasicRelationalPersistentProperty

public BasicRelationalPersistentProperty(Property property,
 PersistentEntity<?, RelationalPersistentProperty> owner,
 SimpleTypeHolder simpleTypeHolder,
 NamingStrategy namingStrategy)

Creates a new BasicRelationalPersistentProperty.

Parameters:

property - must not be null.

owner - must not be null.

simpleTypeHolder - must not be null.

namingStrategy - must not be null

Since:

2.0

Method Details

createAssociation

protected Association<RelationalPersistentProperty> createAssociation()

Specified by:

createAssociation in class AbstractPersistentProperty<RelationalPersistentProperty>

isForceQuote

public boolean isForceQuote()

setForceQuote

public void setForceQuote(boolean forceQuote)

isEntity

public boolean isEntity()

Specified by:

isEntity in interface PersistentProperty<RelationalPersistentProperty>

Overrides:

isEntity in class AbstractPersistentProperty<RelationalPersistentProperty>

getColumnName

public SqlIdentifier getColumnName()

Description copied from interface: RelationalPersistentProperty

Returns the name of the column backing this property.

Specified by:

getColumnName in interface RelationalPersistentProperty

Returns:

the name of the column backing this property.

hasExplicitColumnName

public boolean hasExplicitColumnName()

Description copied from interface: RelationalPersistentProperty

Returns whether the property uses an annotated field name through Column.

Specified by:

hasExplicitColumnName in interface RelationalPersistentProperty

Returns:

getOwner

public RelationalPersistentEntity<?> getOwner()

Specified by:

getOwner in interface PersistentProperty<RelationalPersistentProperty>

Specified by:

getOwner in interface RelationalPersistentProperty

Overrides:

getOwner in class AbstractPersistentProperty<RelationalPersistentProperty>

getReverseColumnName

public SqlIdentifier getReverseColumnName(RelationalPersistentEntity<?> owner)

Specified by:

getReverseColumnName in interface RelationalPersistentProperty

Parameters:

owner - the owning entity.

Returns:

the column name to represent the owning side.

getKeyColumn

public @Nullable SqlIdentifier getKeyColumn()

Specified by:

getKeyColumn in interface RelationalPersistentProperty

isQualified

public boolean isQualified()

Description copied from interface: RelationalPersistentProperty

Returns if this property is a qualified property, i.e. a property referencing multiple elements that can get picked by a key or an index.

Specified by:

isQualified in interface RelationalPersistentProperty

getQualifierColumnType

public Class<?> getQualifierColumnType()

Specified by:

getQualifierColumnType in interface RelationalPersistentProperty

isOrdered

public boolean isOrdered()

Description copied from interface: RelationalPersistentProperty

Returns whether this property is an ordered property.

Specified by:

isOrdered in interface RelationalPersistentProperty

isEmbedded

public boolean isEmbedded()

Specified by:

isEmbedded in interface RelationalPersistentProperty

Returns:

true, if the Property is an embedded value object, otherwise false.

getEmbeddedPrefix

public String getEmbeddedPrefix()

Specified by:

getEmbeddedPrefix in interface RelationalPersistentProperty

Returns:

Prefix for embedded columns. If the column is not embedded the return value is empty.

shouldCreateEmptyEmbedded

public boolean shouldCreateEmptyEmbedded()

Description copied from interface: RelationalPersistentProperty

Returns whether an empty embedded object is supposed to be created for this property.

Specified by:

shouldCreateEmptyEmbedded in interface RelationalPersistentProperty

isInsertOnly

public boolean isInsertOnly()

Description copied from interface: RelationalPersistentProperty

Returns whether this property is only to be used during inserts and read.

Specified by:

isInsertOnly in interface RelationalPersistentProperty

getSequence

public @Nullable SqlIdentifier getSequence()

Specified by:

getSequence in interface RelationalPersistentProperty

Returns:

the target sequence that should be used for value generation.