OrdFieldSource (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- org.apache.lucene.queries.function.ValueSource
- - org.apache.lucene.queries.function.valuesource.OrdFieldSource

```
public class OrdFieldSource
extends ValueSource
```
Obtains the ordinal of the field value from the default Lucene FieldCache using getStringIndex().
The native lucene index order is used to assign an ordinal value for each field value.
Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.
Example:
If there were only three field values: "apple","banana","pear"
then ord("apple")=1, ord("banana")=2, ord("pear")=3
WARNING: ord() depends on the position in an index and can thus change when other documents are inserted or deleted, or if a MultiSearcher is used.
WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry at the top level reader, while sorting and function queries now use entries at the segment level. Hence sorting or using a different function query, in addition to ord()/rord() will double memory use.

Constructor Summary

Constructors
Constructor Description

OrdFieldSource(java.lang.String field)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`description()`	description of field, used in explain()
`boolean`	`equals(java.lang.Object o)`
`FunctionValues`	`getValues(java.util.Map context, AtomicReaderContext readerContext)`	Gets the values for this reader and the context that was previously passed to createWeight()
`int`	`hashCode()`

Methods inherited from class org.apache.lucene.queries.function.ValueSource
createWeight, getSortField, newContext, toString

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

- Constructor Detail
  - OrdFieldSource
```
public OrdFieldSource(java.lang.String field)
```
- Method Detail
  - description
```
public java.lang.String description()
```
    Description copied from class: ValueSource
    
    description of field, used in explain()
    
    Specified by:
    
    description in class ValueSource
  - getValues
```
public FunctionValues getValues(java.util.Map context,
                                AtomicReaderContext readerContext)
                         throws java.io.IOException
```
    Description copied from class: ValueSource
    
    Gets the values for this reader and the context that was previously passed to createWeight()
    
    Specified by:
    
    getValues in class ValueSource
    
    Throws:
    
    java.io.IOException
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in class ValueSource
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class ValueSource