org.elasticsearch.common.lucene.uid
Class UidField

java.lang.Object
  org.apache.lucene.document.AbstractField
      org.elasticsearch.common.lucene.uid.UidField

All Implemented Interfaces:

java.io.Serializable, org.apache.lucene.document.Fieldable

public class UidField
extends org.apache.lucene.document.AbstractField

See Also:

Serialized Form

Nested Class Summary

static class	UidField.DocIdAndVersion
static class	UidField.UidPayloadTokenStream

Field Summary

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

binaryLength, binaryOffset, boost, fieldsData, isBinary, isIndexed, isStored, isTokenized, lazy, name, omitNorms, omitTermFreqAndPositions, storeOffsetWithTermVector, storePositionWithTermVector, storeTermVector, tokenStream

Constructor Summary

UidField(java.lang.String name, java.lang.String uid, long version)

Method Summary

static UidField.DocIdAndVersion	loadDocIdAndVersion(org.apache.lucene.index.IndexReader reader, org.apache.lucene.index.Term term)
static long	loadVersion(org.apache.lucene.index.IndexReader reader, org.apache.lucene.index.Term term) Load the version for the uid from the reader, returning -1 if no doc exists, or -2 if no version is available (for backward comp.)
java.io.Reader	readerValue()
void	setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions)
java.lang.String	stringValue()
org.apache.lucene.analysis.TokenStream	tokenStreamValue()
long	version()
void	version(long version)

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

getBinaryLength, getBinaryOffset, getBinaryValue, getBinaryValue, getBoost, getOmitNorms, getOmitTermFreqAndPositions, isBinary, isIndexed, isLazy, isStored, isStoreOffsetWithTermVector, isStorePositionWithTermVector, isTermVectorStored, isTokenized, name, setBoost, setOmitNorms, setStoreTermVector, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UidField

public UidField(java.lang.String name,
                java.lang.String uid,
                long version)

Method Detail

loadDocIdAndVersion

public static UidField.DocIdAndVersion loadDocIdAndVersion(org.apache.lucene.index.IndexReader reader,
                                                           org.apache.lucene.index.Term term)

loadVersion

public static long loadVersion(org.apache.lucene.index.IndexReader reader,
                               org.apache.lucene.index.Term term)

Load the version for the uid from the reader, returning -1 if no doc exists, or -2 if no version is available (for backward comp.)

setOmitTermFreqAndPositions

public void setOmitTermFreqAndPositions(boolean omitTermFreqAndPositions)

Specified by:

setOmitTermFreqAndPositions in interface org.apache.lucene.document.Fieldable

Overrides:

setOmitTermFreqAndPositions in class org.apache.lucene.document.AbstractField

stringValue

public java.lang.String stringValue()

readerValue

public java.io.Reader readerValue()

version

public long version()

version

public void version(long version)

tokenStreamValue

public org.apache.lucene.analysis.TokenStream tokenStreamValue()