org.elasticsearch.common.lucene.uid

Class Versions

java.lang.Object

org.elasticsearch.common.lucene.uid.Versions

public class Versions
extends Object

Utility class to resolve the Lucene doc ID and version for a given uid.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Versions.DocIdAndVersion Wraps an LeafReaderContext, a doc ID relative to the context doc base and a version.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MATCH_ANY
static long	NOT_FOUND
static long	NOT_SET used when the document is old and doesn't contain any version information in the index see PerThreadIDAndVersionLookup.lookup(org.apache.lucene.util.BytesRef, org.apache.lucene.util.Bits, org.apache.lucene.index.LeafReaderContext)

Method Summary

Methods

Modifier and Type	Method and Description
static Versions.DocIdAndVersion	loadDocIdAndVersion(org.apache.lucene.index.IndexReader reader, org.apache.lucene.index.Term term) Load the internal doc ID and version for the uid from the reader, returning null if the uid wasn't found, a doc ID and a version otherwise, the version being potentially set to NOT_SET if the uid has no associated version
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 NOT_FOUND if no matching doc exists, NOT_SET if no version is available, the version associated with the provided uid otherwise

Methods inherited from class java.lang.Object

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

Field Detail

MATCH_ANY

public static final long MATCH_ANY

See Also:

Constant Field Values

NOT_FOUND

public static final long NOT_FOUND

See Also:

Constant Field Values

NOT_SET

public static final long NOT_SET

used when the document is old and doesn't contain any version information in the index see PerThreadIDAndVersionLookup.lookup(org.apache.lucene.util.BytesRef, org.apache.lucene.util.Bits, org.apache.lucene.index.LeafReaderContext)

See Also:

Constant Field Values

Method Detail

loadDocIdAndVersion

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

Load the internal doc ID and version for the uid from the reader, returning

• null if the uid wasn't found,
• a doc ID and a version otherwise, the version being potentially set to NOT_SET if the uid has no associated version

Throws:

IOException

loadVersion

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

Load the version for the uid from the reader, returning

• NOT_FOUND if no matching doc exists,
• NOT_SET if no version is available,
• the version associated with the provided uid otherwise

Throws:

IOException