-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
MongoPersistentEntity.java
96 lines (85 loc) · 2.42 KB
/
MongoPersistentEntity.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
* Copyright 2011-2020 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.mongodb.core.mapping;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.lang.Nullable;
/**
* MongoDB specific {@link PersistentEntity} abstraction.
*
* @author Oliver Gierke
* @author Christoph Strobl
*/
public interface MongoPersistentEntity<T> extends PersistentEntity<T, MongoPersistentProperty> {
/**
* Returns the collection the entity shall be persisted to.
*
* @return
*/
String getCollection();
/**
* Returns the default language to be used for this entity.
*
* @return
* @since 1.6
*/
String getLanguage();
/**
* Returns the property holding text score value.
*
* @return {@literal null} if not present.
* @see #hasTextScoreProperty()
* @since 1.6
*/
@Nullable
MongoPersistentProperty getTextScoreProperty();
/**
* Returns whether the entity has a {@link TextScore} property.
*
* @return true if property annotated with {@link TextScore} is present.
* @since 1.6
*/
boolean hasTextScoreProperty();
/**
* Returns the collation of the entity evaluating a potential SpEL expression within the current context.
*
* @return {@literal null} if not set.
* @since 2.2
*/
@Nullable
org.springframework.data.mongodb.core.query.Collation getCollation();
/**
* @return {@literal true} if the entity is annotated with
* {@link org.springframework.data.mongodb.core.mapping.Collation}.
* @since 2.2
*/
default boolean hasCollation() {
return getCollation() != null;
}
/**
* Get the entities shard key if defined.
*
* @return {@link ShardKey#none()} if not not set.
* @since 3.0
*/
ShardKey getShardKey();
/**
* @return {@literal true} if the {@link #getShardKey() shard key} is sharded.
* @since 3.0
*/
default boolean isSharded() {
return getShardKey().isSharded();
}
}