java.lang.Object
- org.hibernate.search.engine.backend.types.spi.AbstractIndexValueFieldType<SC,N,F>

All Implemented Interfaces:: IndexValueFieldTypeDescriptor, IndexFieldType<F>, SearchIndexNodeTypeContext<SC,N>, SearchIndexValueFieldTypeContext<SC,N,F>

public abstract class AbstractIndexValueFieldType<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
extends Object
implements IndexValueFieldTypeDescriptor, IndexFieldType<F>, SearchIndexValueFieldTypeContext<SC,N,F>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractIndexValueFieldType.Builder<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractIndexValueFieldType(AbstractIndexValueFieldType.Builder<SC,N,F> builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`aggregable()`
`Optional<String>`	`analyzerName()`
`Class<?>`	`dslArgumentClass()`
`DslConverter<?,F>`	`dslConverter()`
`Optional<String>`	`normalizerName()`
`boolean`	`projectable()`
`Class<?>`	`projectedValueClass()`
`ProjectionConverter<F,?>`	`projectionConverter()`
`<T> SearchQueryElementFactory<? extends T,? super SC,? super N>`	`queryElementFactory(SearchQueryElementTypeKey<T> key)`
`DslConverter<F,F>`	`rawDslConverter()`
`ProjectionConverter<F,F>`	`rawProjectionConverter()`
`boolean`	`searchable()`
`Optional<String>`	`searchAnalyzerName()`
`boolean`	`sortable()`
`String`	`toString()`
`Class<F>`	`valueClass()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexValueFieldTypeContext
dslConverter, projectionConverter

- Constructor Detail
  - AbstractIndexValueFieldType
```
protected AbstractIndexValueFieldType(AbstractIndexValueFieldType.Builder<SC,N,F> builder)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - valueClass
```
public final Class<F> valueClass()
```
    Specified by:
    
    valueClass in interface IndexValueFieldTypeDescriptor
    
    Specified by:
    
    valueClass in interface SearchIndexValueFieldTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
    
    Returns:
    
    The raw Java type of values for this field. This may not be the expected type for arguments passed to the DSL for this field, nor the type of projected values for this field. See IndexValueFieldTypeDescriptor.dslArgumentClass()
  - searchable
```
public final boolean searchable()
```
    Specified by:
    
    searchable in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    true if search predicates are supported on fields of this type. Some sorts may still be unsupported because they don't make sense (e.g. a "within circle" predicate on a string field).
  - sortable
```
public final boolean sortable()
```
    Specified by:
    
    sortable in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    true if sorts are supported on fields of this type. Some sorts may still be unsupported because they don't make sense (e.g. a distance sort aggregation on a string field).
  - projectable
```
public final boolean projectable()
```
    Specified by:
    
    projectable in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    true if projections are supported on fields of this type. Some projections may still be unsupported because they don't make sense (e.g. a distance projection aggregation on a string field).
  - aggregable
```
public final boolean aggregable()
```
    Specified by:
    
    aggregable in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    true if aggregations are supported on fields of this type. Some aggregations may still be unsupported because they don't make sense (e.g. a range aggregation on an analyzed string field).
  - dslArgumentClass
```
public final Class<?> dslArgumentClass()
```
    Specified by:
    
    dslArgumentClass in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    The expected raw Java type of arguments passed to the DSL for this field.
    
    See Also:
    
    ValueConvert.YES, ToDocumentValueConverter
  - dslConverter
```
public final DslConverter<?,F> dslConverter()
```
    Specified by:
    
    dslConverter in interface SearchIndexValueFieldTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
  - rawDslConverter
```
public final DslConverter<F,F> rawDslConverter()
```
    Specified by:
    
    rawDslConverter in interface SearchIndexValueFieldTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
  - projectedValueClass
```
public final Class<?> projectedValueClass()
```
    Specified by:
    
    projectedValueClass in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    The raw Java type of projected values for this field.
    
    See Also:
    
    ValueConvert.YES, FromDocumentValueConverter
  - projectionConverter
```
public final ProjectionConverter<F,?> projectionConverter()
```
    Specified by:
    
    projectionConverter in interface SearchIndexValueFieldTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
  - rawProjectionConverter
```
public final ProjectionConverter<F,F> rawProjectionConverter()
```
    Specified by:
    
    rawProjectionConverter in interface SearchIndexValueFieldTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>
  - analyzerName
```
public final Optional<String> analyzerName()
```
    Specified by:
    
    analyzerName in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    The name of the analyzer assigned to this type, if any. Only ever set for String fields.
  - normalizerName
```
public final Optional<String> normalizerName()
```
    Specified by:
    
    normalizerName in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    The name of the normalizer assigned to this type, if any. Only ever set for String fields.
  - searchAnalyzerName
```
public final Optional<String> searchAnalyzerName()
```
    Specified by:
    
    searchAnalyzerName in interface IndexValueFieldTypeDescriptor
    
    Returns:
    
    The name of the search analyzer assigned to this type, if any. Only ever set for String fields. By default, the search analyzer is the same as the analyzer.
  - queryElementFactory
```
public final <T> SearchQueryElementFactory<? extends T,? super SC,? super N> queryElementFactory(SearchQueryElementTypeKey<T> key)
```
    Specified by:
    
    queryElementFactory in interface SearchIndexNodeTypeContext<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>>

Class AbstractIndexValueFieldType<SC extends SearchIndexScope<?>,​N extends SearchIndexValueFieldContext<SC>,​F>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexValueFieldTypeContext

Constructor Detail

AbstractIndexValueFieldType

Method Detail

toString

valueClass

searchable

sortable

projectable

aggregable

dslArgumentClass

dslConverter

rawDslConverter

projectedValueClass

projectionConverter

rawProjectionConverter

analyzerName

normalizerName

searchAnalyzerName

queryElementFactory

Class AbstractIndexValueFieldType<SC extends SearchIndexScope<?>,N extends SearchIndexValueFieldContext<SC>,F>