public class

ShortFieldSource

extends FieldCacheSource
java.lang.Object
   ↳ org.apache.lucene.search.function.ValueSource
     ↳ org.apache.lucene.search.function.FieldCacheSource
       ↳ org.apache.lucene.search.function.ShortFieldSource

Class Overview

Expert: obtains short field values from the FieldCache using getShorts() and makes those values available as other numeric types, casting as needed.

WARNING: The status of the search.function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

See Also

Summary

Public Constructors
ShortFieldSource(String field)
Create a cached short field source with default string-to-short parser.
ShortFieldSource(String field, FieldCache.ShortParser parser)
Create a cached short field source with a specific string-to-short parser.
Public Methods
boolean cachedFieldSourceEquals(FieldCacheSource o)
Check if equals to another FieldCacheSource, already knowing that cache and field are equal.
int cachedFieldSourceHashCode()
Return a hash code of a FieldCacheSource, without the hash-codes of the field and the cache (those are taken care of elsewhere).
String description()
description of field, used in explain()
DocValues getCachedFieldValues(FieldCache cache, String field, IndexReader reader)
Return cached DocValues for input field and reader.
[Expand]
Inherited Methods
From class org.apache.lucene.search.function.FieldCacheSource
From class org.apache.lucene.search.function.ValueSource
From class java.lang.Object

Public Constructors

public ShortFieldSource (String field)

Create a cached short field source with default string-to-short parser.

public ShortFieldSource (String field, FieldCache.ShortParser parser)

Create a cached short field source with a specific string-to-short parser.

Public Methods

public boolean cachedFieldSourceEquals (FieldCacheSource o)

Check if equals to another FieldCacheSource, already knowing that cache and field are equal.

public int cachedFieldSourceHashCode ()

Return a hash code of a FieldCacheSource, without the hash-codes of the field and the cache (those are taken care of elsewhere).

public String description ()

description of field, used in explain()

public DocValues getCachedFieldValues (FieldCache cache, String field, IndexReader reader)

Return cached DocValues for input field and reader.

Parameters
cache FieldCache so that values of a field are loaded once per reader (RAM allowing)
field Field for which values are required.
Throws
IOException