@Retention(value=RUNTIME) @Target(value={FIELD,METHOD}) @Documented public @interface IndexedEmbedded
Modifier and Type | Fields and Description |
---|---|
static String |
DEFAULT_NULL_TOKEN
Value for
indexNullAs() parameter indicating that null values should not indexed using the |
static String |
DO_NOT_INDEX_NULL
Default value for
indexNullAs() parameter. |
Modifier and Type | Optional Element and Description |
---|---|
int |
depth
Stop indexing embedded elements when depth is reached
depth=1 means the associated element is indexed, but not its embedded elements.
|
String[] |
includePaths
List which paths of the object graph should be included
in the index, and need to match the field names used to store them in the index, so they will
also match the field names used to specify full text queries.
|
String |
indexNullAs |
String |
prefix
Field name prefix
Default to 'propertyname.'
|
Class<?> |
targetElement
Overrides the type of an association.
|
public static final String DO_NOT_INDEX_NULL
indexNullAs()
parameter. Indicates that null
values should not be indexed.public static final String DEFAULT_NULL_TOKEN
indexNullAs()
parameter indicating that null
values should not indexed using thepublic abstract String prefix
public abstract String[] includePaths
List which paths of the object graph should be included in the index, and need to match the field names used to store them in the index, so they will also match the field names used to specify full text queries.
Defined paths are going to be indexed even if they exceed the depth
threshold.
When includePaths
is not empty, the default value for depth
is 0.
Defined paths are implicitly prefixed with the prefix()
.
public abstract int depth
Stop indexing embedded elements when depth is reached depth=1 means the associated element is indexed, but not its embedded elements.
The default value depends on the value of the includePaths
attribute: if no paths
are defined, the default is Integer.MAX_VALUE
; if any includePaths
are
defined, the default depth
is interpreted as 0 if not specified to a different value
than it's default.
Note that when defining any path to the includePaths
attribute the default is zero also
when explicitly set to Integer.MAX_VALUE
.
public abstract Class<?> targetElement
public abstract String indexNullAs
null
. Per default
IndexedEmbedded.DO_NOT_INDEX_NULL
is
returned indicating that null values are not indexed.Copyright © 2006–2016 Hibernate. All rights reserved.