ElasticsearchPersistentProperty (Spring Data Elasticsearch 4.4.3 API)

All Superinterfaces:

PersistentProperty<ElasticsearchPersistentProperty>

All Known Implementing Classes:

SimpleElasticsearchPersistentProperty
```
public interface ElasticsearchPersistentProperty
extends PersistentProperty<ElasticsearchPersistentProperty>
```
ElasticsearchPersistentProperty

Author:

Rizwan Idrees, Mohsin Husen, Sascha Woo, Oliver Gierke, Peter-Josef Meisch, Roman Puchkovskiy

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ElasticsearchPersistentProperty.PropertyToFieldNameConverter`
`static class`	`ElasticsearchPersistentProperty.QueryPropertyToFieldNameConverter` when building CriteriaQueries use the name; the fieldname is set later with `ElasticsearchConverter`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Class<?>`	`getActualTypeOrNull()` calls `PersistentProperty.getActualType()` but returns null when an exception is thrown
`String`	`getFieldName()` Returns the name to be used to store the property in the document.
`PropertyValueConverter`	`getPropertyValueConverter()`
`boolean`	`hasPropertyValueConverter()`
`boolean`	`isCompletionProperty()`
`boolean`	`isGeoPointProperty()`
`boolean`	`isGeoShapeProperty()`
`boolean`	`isJoinFieldProperty()`
`boolean`	`isReadable()` Returns true if the property may be read.
`boolean`	`isSeqNoPrimaryTermProperty()` Returns whether the current property is a `SeqNoPrimaryTerm` property.
`boolean`	`storeNullValue()`

- Method Detail
  - getFieldName
```
String getFieldName()
```
    Returns the name to be used to store the property in the document.
    
    Returns:
  - isSeqNoPrimaryTermProperty
```
boolean isSeqNoPrimaryTermProperty()
```
    Returns whether the current property is a SeqNoPrimaryTerm property.
    
    Returns:
    
    true if the type is SeqNoPrimaryTerm
    
    Since:
    
    4.0
  - hasPropertyValueConverter
```
boolean hasPropertyValueConverter()
```
    Returns:
    
    true if an PropertyValueConverter is available for this instance.
    
    Since:
    
    4.0
  - getPropertyValueConverter
```
@Nullable
PropertyValueConverter getPropertyValueConverter()
```
    Returns:
    
    the PropertyValueConverter for this instance.
    
    Since:
    
    4.0
  - isReadable
```
boolean isReadable()
```
    Returns true if the property may be read.
    
    Returns:
    
    true if readable, false otherwise
    
    Since:
    
    4.0
  - storeNullValue
```
boolean storeNullValue()
```
    Returns:
    
    true if null values should be stored in Elasticsearch
    
    Since:
    
    4.1
  - isGeoPointProperty
```
boolean isGeoPointProperty()
```
    Returns:
    
    true if this is a GeoPoint property
    
    Since:
    
    4.1
  - isGeoShapeProperty
```
boolean isGeoShapeProperty()
```
    Returns:
    
    true if this is a GeoShape property
    
    Since:
    
    4.1
  - isJoinFieldProperty
```
boolean isJoinFieldProperty()
```
    Returns:
    
    true if this is a JoinField property
    
    Since:
    
    4.1
  - isCompletionProperty
```
boolean isCompletionProperty()
```
    Returns:
    
    true if this is a Completion property
    
    Since:
    
    4.1
  - getActualTypeOrNull
```
@Nullable
default Class<?> getActualTypeOrNull()
```
    calls PersistentProperty.getActualType() but returns null when an exception is thrown
    
    Since:
    
    4.1

Interface ElasticsearchPersistentProperty

Nested Class Summary

Method Summary

Methods inherited from interface org.springframework.data.mapping.PersistentProperty

Method Detail

getFieldName

isSeqNoPrimaryTermProperty

hasPropertyValueConverter

getPropertyValueConverter

isReadable

storeNullValue

isGeoPointProperty

isGeoShapeProperty

isJoinFieldProperty

isCompletionProperty

getActualTypeOrNull