Module org.apache.lucene.analysis.common

Package org.apache.lucene.collation

Class CollationDocValuesField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.collation.CollationDocValuesField

All Implemented Interfaces:

IndexableField

public final class CollationDocValuesField
extends Field

Indexes collation keys as a single-valued SortedDocValuesField.

This is more efficient that CollationKeyAnalyzer if the field only has one value: no uninversion is necessary to sort on the field, locale-sensitive range queries can still work via DocValuesRangeQuery, and the underlying data structures built at index-time are likely more efficient and use less memory than FieldCache.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.Field

Field.Store

Field Summary

Fields

Modifier and Type	Field	Description
private final BytesRef	bytes
private final Collator	collator
private final String	name

Fields inherited from class org.apache.lucene.document.Field

fieldsData, tokenStream, type

Constructor Summary

Constructors

Constructor	Description
CollationDocValuesField(String name, Collator collator)	Create a new ICUCollationDocValuesField.

Method Summary

Modifier and Type	Method	Description
String	name()	Field name
void	setStringValue(String value)	Expert: change the value of this field.

Methods inherited from class org.apache.lucene.document.Field

binaryValue, fieldType, getCharSequenceValue, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

name

private final String name

collator

private final Collator collator

bytes

private final BytesRef bytes

Constructor Details

CollationDocValuesField

public CollationDocValuesField(String name,
 Collator collator)

Create a new ICUCollationDocValuesField.

NOTE: you should not create a new one for each document, instead just make one and reuse it during your indexing process, setting the value via setStringValue(String).

Parameters:

name - field name

collator - Collator for generating collation keys.

Method Details

name

public String name()

Description copied from interface: IndexableField

Field name

Specified by:

name in interface IndexableField

Overrides:

name in class Field

setStringValue

public void setStringValue(String value)

Description copied from class: Field

Expert: change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming Field instances. Typically a single Document instance is re-used as well. This helps most on small documents.

Each Field instance should only be used once within a single Document instance. See ImproveIndexingSpeed for details.

Overrides:

setStringValue in class Field