Package org.apache.lucene.document
Class FloatField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.FloatField
- All Implemented Interfaces:
IndexableField
Field that stores a per-document
float
value for scoring, sorting or value retrieval
and index the field for fast range filters. If you need more fine-grained control you can use
FloatPoint
, FloatDocValuesField
and StoredField
.
This field defines static factory methods for creating common queries:
newExactQuery(String, float)
for matching an exact 1D point.newRangeQuery(String, float, float)
for matching a 1D range.newSetQuery(String, float...)
for matching a 1D set.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorDescriptionFloatField
(String name, float value) Deprecated.FloatField
(String name, float value, Field.Store stored) Creates a new FloatField, indexing the provided point, storing it as a DocValue, and optionally storing it as a stored field. -
Method Summary
Modifier and TypeMethodDescriptionNon-null if this field has a binary valuestatic Query
newExactQuery
(String field, float value) Create a query for matching an exact float value.static Query
newRangeQuery
(String field, float lowerValue, float upperValue) Create a range query for float values.static Query
newSetQuery
(String field, float... values) Create a query matching values in a supplied setstatic SortField
newSortField
(String field, boolean reverse, SortedNumericSelector.Type selector) Create a newSortField
for float values.void
setFloatValue
(float value) Expert: change the value of this field.void
setLongValue
(long value) Expert: change the value of this field.Stored value.toString()
Prints a Field for human consumption.Methods inherited from class org.apache.lucene.document.Field
fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setIntValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue
-
Constructor Details
-
FloatField
Deprecated.UseFloatField(String, float, Field.Store)
withField.Store.NO
instead.Creates a new FloatField, indexing the provided point and storing it as a DocValue- Parameters:
name
- field namevalue
- the float value- Throws:
IllegalArgumentException
- if the field name or value is null.
-
FloatField
Creates a new FloatField, indexing the provided point, storing it as a DocValue, and optionally storing it as a stored field.- Parameters:
name
- field namevalue
- the float valuestored
- whether to store the field- Throws:
IllegalArgumentException
- if the field name or value is null.
-
-
Method Details
-
binaryValue
Description copied from interface:IndexableField
Non-null if this field has a binary value- Specified by:
binaryValue
in interfaceIndexableField
- Overrides:
binaryValue
in classField
-
storedValue
Description copied from interface:IndexableField
Stored value. This method is called to populate stored fields and must return a non-null value if the field stored.- Specified by:
storedValue
in interfaceIndexableField
- Overrides:
storedValue
in classField
-
toString
Description copied from class:Field
Prints a Field for human consumption. -
setFloatValue
public void setFloatValue(float value) Description copied from class:Field
Expert: change the value of this field. SeeField.setStringValue(String)
.- Overrides:
setFloatValue
in classField
-
setLongValue
public void setLongValue(long value) Description copied from class:Field
Expert: change the value of this field. SeeField.setStringValue(String)
.- Overrides:
setLongValue
in classField
-
newExactQuery
Create a query for matching an exact float value.- Parameters:
field
- field name. must not benull
.value
- exact value- Returns:
- a query matching documents with this exact value
- Throws:
IllegalArgumentException
- iffield
is null.
-
newRangeQuery
Create a range query for float values.You can have half-open ranges (which are in fact </≤ or >/≥ queries) by setting
lowerValue = Float.NEGATIVE_INFINITY
orupperValue = Float.POSITIVE_INFINITY
.Range comparisons are consistent with
Float.compareTo(Float)
.- Parameters:
field
- field name. must not benull
.lowerValue
- lower portion of the range (inclusive).upperValue
- upper portion of the range (inclusive).- Returns:
- a query matching documents within this range.
- Throws:
IllegalArgumentException
- iffield
is null.
-
newSetQuery
Create a query matching values in a supplied set- Parameters:
field
- field name. must not benull
.values
- float values- Returns:
- a query matching documents within this set.
- Throws:
IllegalArgumentException
- iffield
is null.
-
newSortField
public static SortField newSortField(String field, boolean reverse, SortedNumericSelector.Type selector) Create a newSortField
for float values.- Parameters:
field
- field name. must not benull
.reverse
- true if natural order should be reversed.selector
- custom selector type for choosing the sort value from the set.
-
FloatField(String, float, Field.Store)
withField.Store.NO
instead.