Package org.elasticsearch.common.lucene.uid

Class VersionsAndSeqNoResolver

java.lang.Object

org.elasticsearch.common.lucene.uid.VersionsAndSeqNoResolver

public final class VersionsAndSeqNoResolver
extends java.lang.Object

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VersionsAndSeqNoResolver.DocIdAndSeqNo	loadDocIdAndSeqNo(org.apache.lucene.index.IndexReader reader, org.apache.lucene.index.Term term)	Loads the internal docId and sequence number of the latest copy for a given uid from the provided reader.
static VersionsAndSeqNoResolver.DocIdAndVersion	loadDocIdAndVersion(org.apache.lucene.index.IndexReader reader, org.apache.lucene.index.Term term, boolean loadSeqNo)	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

Methods inherited from class java.lang.Object

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

Method Detail

loadDocIdAndVersion

public static VersionsAndSeqNoResolver.DocIdAndVersion loadDocIdAndVersion(org.apache.lucene.index.IndexReader reader,
                                                                           org.apache.lucene.index.Term term,
                                                                           boolean loadSeqNo)
                                                                    throws java.io.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

Throws:

java.io.IOException

loadDocIdAndSeqNo

public static VersionsAndSeqNoResolver.DocIdAndSeqNo loadDocIdAndSeqNo(org.apache.lucene.index.IndexReader reader,
                                                                       org.apache.lucene.index.Term term)
                                                                throws java.io.IOException

Loads the internal docId and sequence number of the latest copy for a given uid from the provided reader. The flag VersionsAndSeqNoResolver.DocIdAndSeqNo.isLive indicates whether the returned document is live or (soft)deleted. This returns null if no such document matching the given term uid.

Throws:

java.io.IOException