com.azure.spring.data.cosmos.repository.support

Class CosmosEntityInformation<T,ID>

java.lang.Object

org.springframework.data.repository.core.support.AbstractEntityInformation<T,ID>

com.azure.spring.data.cosmos.repository.support.CosmosEntityInformation<T,ID>

All Implemented Interfaces:

org.springframework.data.repository.core.EntityInformation<T,ID>, org.springframework.data.repository.core.EntityMetadata<T>

public class CosmosEntityInformation<T,ID>
extends org.springframework.data.repository.core.support.AbstractEntityInformation<T,ID>

Class to describe cosmosDb entity

Constructor Summary

Constructors

Constructor and Description
CosmosEntityInformation(Class<T> domainType) Initialization

Method Summary

Modifier and Type	Method and Description
String	getContainerName() Get container name
ID	getId(T entity) Get the field represented by the supplied id field on the specified entity.
Field	getIdField() Get id field
String	getIdFieldName() Get id field name
Class<ID>	getIdType() Get id type
IndexingPolicy	getIndexingPolicy() Get indexing policy
static CosmosEntityInformation<?,?>	getInstance(Class<?> domainClass) Static Factory
String	getPartitionKeyFieldName()
Object	getPartitionKeyFieldValue(T entity) Get the field value represented by the supplied partitionKeyField object on the specified entity object.
String	getPartitionKeyPath() Get the computed partition key path for container
Integer	getRequestUnit() Get request unit value
Integer	getTimeToLive() Get timeToLive value
String	getVersionFieldName() Get name of field annotated with @Version if any
String	getVersionFieldValue(Object entity) Get the value of the field marked as the version field
boolean	isAutoCreateContainer() Check if auto creating container is allowed
boolean	isAutoScale() Check if container should use autoscale for resource units
boolean	isIndexingPolicySpecified()
boolean	isNew(T entity)
boolean	isVersioned() Check if is versioned
boolean	shouldGenerateId() Should generate Id field value

Methods inherited from class org.springframework.data.repository.core.support.AbstractEntityInformation

getJavaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.repository.core.EntityInformation

getRequiredId

Constructor Detail

CosmosEntityInformation

public CosmosEntityInformation(Class<T> domainType)

Initialization

Parameters:

domainType - to specify id field

Method Detail

getInstance

public static CosmosEntityInformation<?,?> getInstance(Class<?> domainClass)

Static Factory

Parameters:

domainClass - to specify id field

Returns:

new CosmosEntityInformation

isNew

public boolean isNew(T entity)

Specified by:

isNew in interface org.springframework.data.repository.core.EntityInformation<T,ID>

Overrides:

isNew in class org.springframework.data.repository.core.support.AbstractEntityInformation<T,ID>

getId

public ID getId(T entity)

Get the field represented by the supplied id field on the specified entity.

Parameters:

entity - the target object from which to get the field

Returns:

the id's current value

getIdField

public Field getIdField()

Get id field

Returns:

id

getIdFieldName

public String getIdFieldName()

Get id field name

Returns:

string

shouldGenerateId

public boolean shouldGenerateId()

Should generate Id field value

Returns:

boolean

getIdType

public Class<ID> getIdType()

Get id type

Returns:

class of id type

getContainerName

public String getContainerName()

Get container name

Returns:

container name

getRequestUnit

public Integer getRequestUnit()

Get request unit value

Returns:

request unit

getTimeToLive

public Integer getTimeToLive()

Get timeToLive value

Returns:

timeToLive

getIndexingPolicy

@NonNull
public IndexingPolicy getIndexingPolicy()

Get indexing policy

Returns:

IndexingPolicy

isVersioned

public boolean isVersioned()

Check if is versioned

Returns:

boolean

getVersionFieldName

public String getVersionFieldName()

Get name of field annotated with @Version if any

Returns:

String

getPartitionKeyPath

public String getPartitionKeyPath()

Get the computed partition key path for container

Returns:

partition key path

getVersionFieldValue

public String getVersionFieldValue(Object entity)

Get the value of the field marked as the version field

Parameters:

entity - the object to get the value from

Returns:

the value of the version field

getPartitionKeyFieldValue

public Object getPartitionKeyFieldValue(T entity)

Get the field value represented by the supplied partitionKeyField object on the specified entity object.

Parameters:

entity - the target object from which to get the field

Returns:

partition key field

getPartitionKeyFieldName

public String getPartitionKeyFieldName()

isAutoCreateContainer

public boolean isAutoCreateContainer()

Check if auto creating container is allowed

Returns:

boolean

isAutoScale

public boolean isAutoScale()

Check if container should use autoscale for resource units

Returns:

boolean

isIndexingPolicySpecified

public boolean isIndexingPolicySpecified()