DocValuesFieldValueSource (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.search.v2.score.DocValuesFieldValueSource

All Implemented Interfaces:

FieldValueSource
```
@Deprecated(forRemoval=true)
public class DocValuesFieldValueSource
extends Object
implements FieldValueSource
```
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7, not supported on OpenSearch.

Represents binary doc values field its value is of type byte[].
NOTE: Format of bytes is in UTF-8 format.

Since:

7.12

Constructor Summary

Constructors
Constructor	Description
`DocValuesFieldValueSource(String fieldName, Function<byte[],Double> extractor)`	Deprecated, for removal: This API element is subject to removal in a future version. Creates a value source for a doc values field.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Deprecated, for removal: This API element is subject to removal in a future version.
`Function<byte[],Double>`	`getExtractor()`	Deprecated, for removal: This API element is subject to removal in a future version.
`String`	`getFieldName()`	Deprecated, for removal: This API element is subject to removal in a future version. Returns field name where the numerical value comes from.
`int`	`hashCode()`	Deprecated, for removal: This API element is subject to removal in a future version.

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

- Constructor Detail
  - DocValuesFieldValueSource
```
public DocValuesFieldValueSource(String fieldName,
                                 Function<byte[],Double> extractor)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Creates a value source for a doc values field.
    
    Parameters:
    
    fieldName - field name for doc values.
    
    extractor - for converting relevant UTF-8 bytes from doc values field to a Double value.
- Method Detail
  - getFieldName
```
public String getFieldName()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Description copied from interface: FieldValueSource
    
    Returns field name where the numerical value comes from.
    
    Specified by:
    
    getFieldName in interface FieldValueSource
  - getExtractor
```
public Function<byte[],Double> getExtractor()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
  - equals
```
public boolean equals(Object o)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Overrides:
    
    hashCode in class Object