Package org.elasticsearch.common.lucene

Class Lucene

java.lang.Object

org.elasticsearch.common.lucene.Lucene

public class Lucene
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static ScoreDoc[]	EMPTY_SCORE_DOCS
static TopDocs	EMPTY_TOP_DOCS
static NamedAnalyzer	KEYWORD_ANALYZER
static String	LATEST_CODEC
static String	LATEST_DOC_VALUES_FORMAT
static String	LATEST_POSTINGS_FORMAT
static String	SOFT_DELETES_FIELD
static NamedAnalyzer	STANDARD_ANALYZER

Method Summary

Modifier and Type	Method	Description
static Bits	asSequentialAccessBits(int maxDoc, ScorerSupplier scorerSupplier)	Return a Bits view of the provided scorer.
static Bits	asSequentialAccessBits(int maxDoc, ScorerSupplier scorerSupplier, long estimatedGetCount)	Given a ScorerSupplier, return a Bits instance that will match all documents contained in the set.
static boolean	canEarlyTerminate(Sort searchSort, Sort indexSort)	Whether a query sorted by searchSort can be early-terminated if the index is sorted by indexSort.
static void	checkSegmentInfoIntegrity(Directory directory)
static void	cleanLuceneIndex(Directory directory)	This method removes all lucene files from the given directory.
static LeafReader	emptyReader(int maxDoc)	Returns an empty leaf reader with the given max docs.
static boolean	exists(IndexSearcher searcher, Query query)	Check whether there is one or more documents matching the provided query.
static Iterable<String>	files(SegmentInfos infos)	Returns an iterable that allows to iterate over all files in this segments info
static IndexCommit	getIndexCommit(SegmentInfos si, Directory directory)	Returns an index commit for the given SegmentInfos in the given directory.
static int	getNumDocs(SegmentInfos info)	Returns the number of documents in the index referenced by this SegmentInfos
static boolean	indexExists(Directory directory)
static boolean	isCorruptionException(Throwable t)	Returns true iff the given exception or one of it's causes is an instance of CorruptIndexException, IndexFormatTooOldException, or IndexFormatTooNewException otherwise false.
static NumericDocValuesField	newSoftDeletesField()	Returns a numeric docvalues which can be used to soft-delete documents.
static Version	parseVersion(String version, Version defaultVersion, org.apache.logging.log4j.Logger logger)
static Version	parseVersionLenient(String toParse, Version defaultValue)	Parses the version string lenient and returns the default value if the given string is null or empty
static SegmentInfos	pruneUnreferencedFiles(String segmentsFileName, Directory directory)	This method removes all files from the given directory that are not referenced by the given segments file.
static Explanation	readExplanation(StreamInput in)
static FieldDoc	readFieldDoc(StreamInput in)
static ScoreDoc	readScoreDoc(StreamInput in)
static SegmentInfos	readSegmentInfos(IndexCommit commit)	Reads the segments infos from the given commit, failing if it fails to load
static SegmentInfos	readSegmentInfos(Directory directory)	Reads the segments infos, failing if it fails to load
static SortField	readSortField(StreamInput in)
static SortField.Type	readSortType(StreamInput in)
static Comparable	readSortValue(StreamInput in)
static TopDocsAndMaxScore	readTopDocs(StreamInput in)
static TotalHits	readTotalHits(StreamInput in)
static SegmentReader	segmentReader(LeafReader reader)	Tries to extract a segment reader from the given index reader.
static boolean	waitForIndex(Directory directory, long timeLimitMillis)	Wait for an index to exist for up to timeLimitMillis.
static DirectoryReader	wrapAllDocsLive(DirectoryReader in)	Wraps a directory reader to make all documents live except those were rolled back or hard-deleted due to non-aborting exceptions during indexing.
static void	writeExplanation(StreamOutput out, Explanation explanation)
static void	writeFieldDoc(StreamOutput out, FieldDoc fieldDoc)
static void	writeScoreDoc(StreamOutput out, ScoreDoc scoreDoc)
static void	writeSortField(StreamOutput out, SortField sortField)
static void	writeSortType(StreamOutput out, SortField.Type sortType)
static void	writeSortValue(StreamOutput out, Object field)
static void	writeTopDocs(StreamOutput out, TopDocsAndMaxScore topDocs)
static void	writeTotalHits(StreamOutput out, TotalHits totalHits)

Methods inherited from class java.lang.Object

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

Field Detail

LATEST_DOC_VALUES_FORMAT

public static final String LATEST_DOC_VALUES_FORMAT

See Also:

Constant Field Values

LATEST_POSTINGS_FORMAT

public static final String LATEST_POSTINGS_FORMAT

See Also:

Constant Field Values

LATEST_CODEC

public static final String LATEST_CODEC

See Also:

Constant Field Values

SOFT_DELETES_FIELD

public static final String SOFT_DELETES_FIELD

See Also:

Constant Field Values

STANDARD_ANALYZER

public static final NamedAnalyzer STANDARD_ANALYZER

KEYWORD_ANALYZER

public static final NamedAnalyzer KEYWORD_ANALYZER

EMPTY_SCORE_DOCS

public static final ScoreDoc[] EMPTY_SCORE_DOCS

EMPTY_TOP_DOCS

public static final TopDocs EMPTY_TOP_DOCS

Method Detail

parseVersion

public static Version parseVersion(@Nullable
                                   String version,
                                   Version defaultVersion,
                                   org.apache.logging.log4j.Logger logger)

readSegmentInfos

public static SegmentInfos readSegmentInfos(Directory directory)
                                     throws IOException

Reads the segments infos, failing if it fails to load

Throws:

IOException

files

public static Iterable<String> files(SegmentInfos infos)
                              throws IOException

Returns an iterable that allows to iterate over all files in this segments info

Throws:

IOException

getNumDocs

public static int getNumDocs(SegmentInfos info)

Returns the number of documents in the index referenced by this SegmentInfos

readSegmentInfos

public static SegmentInfos readSegmentInfos(IndexCommit commit)
                                     throws IOException

Reads the segments infos from the given commit, failing if it fails to load

Throws:

IOException

pruneUnreferencedFiles

public static SegmentInfos pruneUnreferencedFiles(String segmentsFileName,
                                                  Directory directory)
                                           throws IOException

This method removes all files from the given directory that are not referenced by the given segments file. This method will open an IndexWriter and relies on index file deleter to remove all unreferenced files. Segment files that are newer than the given segments file are removed forcefully to prevent problems with IndexWriter opening a potentially broken commit point / leftover. Note: this method will fail if there is another IndexWriter open on the given directory. This method will also acquire a write lock from the directory while pruning unused files. This method expects an existing index in the given directory that has the given segments file.

Throws:

IOException

getIndexCommit

public static IndexCommit getIndexCommit(SegmentInfos si,
                                         Directory directory)
                                  throws IOException

Returns an index commit for the given SegmentInfos in the given directory.

Throws:

IOException

cleanLuceneIndex

public static void cleanLuceneIndex(Directory directory)
                             throws IOException

This method removes all lucene files from the given directory. It will first try to delete all commit points / segments files to ensure broken commits or corrupted indices will not be opened in the future. If any of the segment files can't be deleted this operation fails.

Throws:

IOException

checkSegmentInfoIntegrity

public static void checkSegmentInfoIntegrity(Directory directory)
                                      throws IOException

Throws:

IOException

exists

public static boolean exists(IndexSearcher searcher,
                             Query query)
                      throws IOException

Check whether there is one or more documents matching the provided query.

Throws:

IOException

readTotalHits

public static TotalHits readTotalHits(StreamInput in)
                               throws IOException

Throws:

IOException

readTopDocs

public static TopDocsAndMaxScore readTopDocs(StreamInput in)
                                      throws IOException

Throws:

IOException

readFieldDoc

public static FieldDoc readFieldDoc(StreamInput in)
                             throws IOException

Throws:

IOException

readSortValue

public static Comparable readSortValue(StreamInput in)
                                throws IOException

Throws:

IOException

readScoreDoc

public static ScoreDoc readScoreDoc(StreamInput in)
                             throws IOException

Throws:

IOException

writeTotalHits

public static void writeTotalHits(StreamOutput out,
                                  TotalHits totalHits)
                           throws IOException

Throws:

IOException

writeTopDocs

public static void writeTopDocs(StreamOutput out,
                                TopDocsAndMaxScore topDocs)
                         throws IOException

Throws:

IOException

writeSortValue

public static void writeSortValue(StreamOutput out,
                                  Object field)
                           throws IOException

Throws:

IOException

writeFieldDoc

public static void writeFieldDoc(StreamOutput out,
                                 FieldDoc fieldDoc)
                          throws IOException

Throws:

IOException

writeScoreDoc

public static void writeScoreDoc(StreamOutput out,
                                 ScoreDoc scoreDoc)
                          throws IOException

Throws:

IOException

readSortType

public static SortField.Type readSortType(StreamInput in)
                                   throws IOException

Throws:

IOException

readSortField

public static SortField readSortField(StreamInput in)
                               throws IOException

Throws:

IOException

writeSortType

public static void writeSortType(StreamOutput out,
                                 SortField.Type sortType)
                          throws IOException

Throws:

IOException

writeSortField

public static void writeSortField(StreamOutput out,
                                  SortField sortField)
                           throws IOException

Throws:

IOException

readExplanation

public static Explanation readExplanation(StreamInput in)
                                   throws IOException

Throws:

IOException

writeExplanation

public static void writeExplanation(StreamOutput out,
                                    Explanation explanation)
                             throws IOException

Throws:

IOException

indexExists

public static boolean indexExists(Directory directory)
                           throws IOException

Throws:

IOException

waitForIndex

public static boolean waitForIndex(Directory directory,
                                   long timeLimitMillis)
                            throws IOException

Wait for an index to exist for up to timeLimitMillis. Returns true if the index eventually exists, false if not. Will retry the directory every second for at least timeLimitMillis

Throws:

IOException

isCorruptionException

public static boolean isCorruptionException(Throwable t)

Returns true iff the given exception or one of it's causes is an instance of CorruptIndexException, IndexFormatTooOldException, or IndexFormatTooNewException otherwise false.

parseVersionLenient

public static Version parseVersionLenient(String toParse,
                                          Version defaultValue)

Parses the version string lenient and returns the default value if the given string is null or empty

segmentReader

public static SegmentReader segmentReader(LeafReader reader)

Tries to extract a segment reader from the given index reader. If no SegmentReader can be extracted an IllegalStateException is thrown.

asSequentialAccessBits

public static Bits asSequentialAccessBits(int maxDoc,
                                          @Nullable
                                          ScorerSupplier scorerSupplier)
                                   throws IOException

Return a Bits view of the provided scorer. NOTE: that the returned Bits instance MUST be consumed in order.

Throws:

IOException

See Also:

asSequentialAccessBits(int, ScorerSupplier, long)

asSequentialAccessBits

public static Bits asSequentialAccessBits(int maxDoc,
                                          @Nullable
                                          ScorerSupplier scorerSupplier,
                                          long estimatedGetCount)
                                   throws IOException

Given a ScorerSupplier, return a Bits instance that will match all documents contained in the set. NOTE: that the returned Bits instance MUST be consumed in order.

Parameters:

estimatedGetCount - an estimation of the number of times that Bits.get(int) will get called

Throws:

IOException

canEarlyTerminate

public static boolean canEarlyTerminate(Sort searchSort,
                                        Sort indexSort)

Whether a query sorted by searchSort can be early-terminated if the index is sorted by indexSort.

wrapAllDocsLive

public static DirectoryReader wrapAllDocsLive(DirectoryReader in)
                                       throws IOException

Wraps a directory reader to make all documents live except those were rolled back or hard-deleted due to non-aborting exceptions during indexing. The wrapped reader can be used to query all documents.

Parameters:

in - the input directory reader

Returns:

the wrapped reader

Throws:

IOException

newSoftDeletesField

public static NumericDocValuesField newSoftDeletesField()

Returns a numeric docvalues which can be used to soft-delete documents.

emptyReader

public static LeafReader emptyReader(int maxDoc)

Returns an empty leaf reader with the given max docs. The reader will be fully deleted.