org.apache.lucene.collation.tokenattributes

Class CollatedTermAttributeImpl

java.lang.Object

org.apache.lucene.util.AttributeImpl

org.apache.lucene.analysis.tokenattributes.CharTermAttributeImpl

org.apache.lucene.collation.tokenattributes.CollatedTermAttributeImpl

All Implemented Interfaces:

java.lang.Appendable, java.lang.CharSequence, java.lang.Cloneable, CharTermAttribute, TermToBytesRefAttribute, Attribute

public class CollatedTermAttributeImpl
extends CharTermAttributeImpl

Extension of CharTermAttributeImpl that encodes the term text as a binary Unicode collation key instead of as UTF-8 bytes.

Field Summary

Fields

Modifier and Type	Field and Description
private java.text.Collator	collator

Fields inherited from class org.apache.lucene.analysis.tokenattributes.CharTermAttributeImpl

builder

Constructor Summary

Constructors

Constructor and Description
CollatedTermAttributeImpl(java.text.Collator collator) Create a new CollatedTermAttributeImpl

Method Summary

Modifier and Type	Method and Description
BytesRef	getBytesRef() Retrieve this attribute's BytesRef.

Methods inherited from class org.apache.lucene.analysis.tokenattributes.CharTermAttributeImpl

append, append, append, append, append, append, buffer, charAt, clear, clone, copyBuffer, copyTo, equals, hashCode, length, reflectWith, resizeBuffer, setEmpty, setLength, subSequence, toString

Methods inherited from class org.apache.lucene.util.AttributeImpl

end, reflectAsString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

collator

private final java.text.Collator collator

Constructor Detail

CollatedTermAttributeImpl

public CollatedTermAttributeImpl(java.text.Collator collator)

Create a new CollatedTermAttributeImpl

Parameters:

collator - Collation key generator

Method Detail

getBytesRef

public BytesRef getBytesRef()

Description copied from interface: TermToBytesRefAttribute

Retrieve this attribute's BytesRef. The bytes are updated from the current term. The implementation may return a new instance or keep the previous one.

Specified by:

getBytesRef in interface TermToBytesRefAttribute

Overrides:

getBytesRef in class CharTermAttributeImpl

Returns:

a BytesRef to be indexed (only stays valid until token stream gets incremented)