Class BasicCouchbasePersistentEntity<T>

java.lang.Object

org.springframework.data.mapping.model.BasicPersistentEntity<T, CouchbasePersistentProperty>

org.springframework.data.couchbase.core.mapping.BasicCouchbasePersistentEntity<T>

All Implemented Interfaces:

Iterable<CouchbasePersistentProperty>, Aware, EnvironmentAware, EnvironmentCapable, CouchbasePersistentEntity<T>, MutablePersistentEntity<T, CouchbasePersistentProperty>, PersistentEntity<T, CouchbasePersistentProperty>

public class BasicCouchbasePersistentEntity<T>
extends BasicPersistentEntity<T, CouchbasePersistentProperty>
implements CouchbasePersistentEntity<T>, EnvironmentAware

The representation of a persistent entity.

Author:

Michael Nitschinger, Mark Paluch, Michael Reiche, Tigran Babloyan

Field Summary

Fields inherited from interface CouchbasePersistentEntity

TTL_IN_SECONDS_INCLUSIVE_END

Constructor Summary

Constructors

Constructor	Description
BasicCouchbasePersistentEntity(TypeInformation<T> typeInformation)	Create a new entity.

Method Summary

Modifier and Type	Method	Description
com.couchbase.client.core.msg.kv.DurabilityLevel	getDurabilityLevel()	Returns the durability level of the entity.
int	getExpiry()	Deprecated.
static int	getExpiry(Expiry annotation, Environment environment)	Deprecated.
Duration	getExpiryDuration()	Returns the expiration time of the entity.
CouchbasePersistentProperty	getExpiryProperty()
CouchbasePersistentProperty	getTextScoreProperty()
boolean	hasTextScoreProperty()
boolean	isTouchOnRead()	Flag for using getAndTouch operations for reads, resetting the expiration (if one was set) when the entity is directly read (eg. findOne, findById).
protected CouchbasePersistentProperty	returnPropertyIfBetterIdPropertyCandidateOrNull(CouchbasePersistentProperty property)
void	setEnvironment(Environment environment)

Methods inherited from class BasicPersistentEntity

addAssociation, addPersistentProperty, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getEnvironment, getEvaluationContext, getEvaluationContext, getFallbackIsNewStrategy, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistentProperties, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getTransientProperty, getType, getTypeAlias, getTypeInformation, getValueEvaluationContext, getValueEvaluationContext, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isCreatorArgument, isIdProperty, isImmutable, isNew, isTransient, isVersionProperty, iterator, requiresPropertyPopulation, setEvaluationContextProvider, setPersistentPropertyAccessorFactory, verify

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface PersistentEntity

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

Constructor Details

BasicCouchbasePersistentEntity

public BasicCouchbasePersistentEntity(TypeInformation<T> typeInformation)

Create a new entity.

Parameters:

typeInformation - the type information of the entity.

Method Details

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

Overrides:

setEnvironment in class BasicPersistentEntity<T, CouchbasePersistentProperty>

returnPropertyIfBetterIdPropertyCandidateOrNull

protected CouchbasePersistentProperty returnPropertyIfBetterIdPropertyCandidateOrNull(CouchbasePersistentProperty property)

Overrides:

returnPropertyIfBetterIdPropertyCandidateOrNull in class BasicPersistentEntity<T, CouchbasePersistentProperty>

getExpiry

@Deprecated
public int getExpiry()

Deprecated.

Description copied from interface: CouchbasePersistentEntity

Returns the expiration time of the entity.

The Couchbase format for expiration time is: - for TTL invalid input: '<' 31 days (invalid input: '<'= 30 * 24 * 60 * 60): expressed as a TTL in seconds - for TTL > 30 days: expressed as Unix UTC time of expiry (number of SECONDS since the Epoch)

Specified by:

getExpiry in interface CouchbasePersistentEntity<T>

Returns:

the expiration time in correct Couchbase format.

getExpiry

@Deprecated
public static int getExpiry(Expiry annotation,
 Environment environment)

Deprecated.

getExpiryDuration

public Duration getExpiryDuration()

Description copied from interface: CouchbasePersistentEntity

Returns the expiration time of the entity.

The Couchbase format for expiration time is: - for TTL invalid input: '<' 31 days (invalid input: '<'= 30 * 24 * 60 * 60): expressed as a TTL in seconds - for TTL > 30 days: expressed as Unix UTC time of expiry (number of SECONDS since the Epoch)

Specified by:

getExpiryDuration in interface CouchbasePersistentEntity<T>

Returns:

the expiration time Duration

getDurabilityLevel

public com.couchbase.client.core.msg.kv.DurabilityLevel getDurabilityLevel()

Description copied from interface: CouchbasePersistentEntity

Returns the durability level of the entity.

Allows the application to wait until this replication (or persistence) is successful before proceeding

Specified by:

getDurabilityLevel in interface CouchbasePersistentEntity<T>

Returns:

the durability level.

isTouchOnRead

public boolean isTouchOnRead()

Description copied from interface: CouchbasePersistentEntity

Flag for using getAndTouch operations for reads, resetting the expiration (if one was set) when the entity is directly read (eg. findOne, findById).

Specified by:

isTouchOnRead in interface CouchbasePersistentEntity<T>

Returns:

true if a direct read of the document should trigger a touch, resetting its expiration timer.

hasTextScoreProperty

public boolean hasTextScoreProperty()

Specified by:

hasTextScoreProperty in interface CouchbasePersistentEntity<T>

getTextScoreProperty

public CouchbasePersistentProperty getTextScoreProperty()

Specified by:

getTextScoreProperty in interface CouchbasePersistentEntity<T>

getExpiryProperty

public CouchbasePersistentProperty getExpiryProperty()

Specified by:

getExpiryProperty in interface CouchbasePersistentEntity<T>