Package org.elasticsearch.common.lucene

Class Lucene

java.lang.Object
org.elasticsearch.common.lucene.Lucene
public class Lucene
extends java.lang.Object

  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.apache.lucene.search.ScoreDoc[] EMPTY_SCORE_DOCS  
    static org.apache.lucene.search.TopDocs EMPTY_TOP_DOCS  
    static NamedAnalyzer KEYWORD_ANALYZER  
    static java.lang.String LATEST_CODEC  
    static java.lang.String SOFT_DELETES_FIELD  
    static NamedAnalyzer STANDARD_ANALYZER  
    static NamedAnalyzer WHITESPACE_ANALYZER  

  • Method Summary

    Modifier and Type Method Description
    static org.apache.lucene.util.Bits asSequentialAccessBits​(int maxDoc, org.apache.lucene.search.ScorerSupplier scorerSupplier)
    Return a Bits view of the provided scorer.
    static org.apache.lucene.util.Bits asSequentialAccessBits​(int maxDoc, org.apache.lucene.search.ScorerSupplier scorerSupplier, long estimatedGetCount)
    Given a ScorerSupplier, return a Bits instance that will match all documents contained in the set.
    static boolean canEarlyTerminate​(org.apache.lucene.search.Sort searchSort, org.apache.lucene.search.Sort indexSort)
    Whether a query sorted by searchSort can be early-terminated if the index is sorted by indexSort.
    static void checkSegmentInfoIntegrity​(org.apache.lucene.store.Directory directory)  
    static void cleanLuceneIndex​(org.apache.lucene.store.Directory directory)
    This method removes all lucene files from the given directory.
    static org.apache.lucene.index.LeafReader emptyReader​(int maxDoc)
    Returns an empty leaf reader with the given max docs.
    static boolean exists​(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.Query query)
    Check whether there is one or more documents matching the provided query.
    static java.lang.Iterable<java.lang.String> files​(org.apache.lucene.index.SegmentInfos infos)
    Returns an iterable that allows to iterate over all files in this segments info
    static org.apache.lucene.index.IndexCommit getIndexCommit​(org.apache.lucene.index.SegmentInfos si, org.apache.lucene.store.Directory directory)
    Returns an index commit for the given SegmentInfos in the given directory.
    static int getNumDocs​(org.apache.lucene.index.SegmentInfos info)
    Returns the number of documents in the index referenced by this SegmentInfos
    static boolean indexExists​(org.apache.lucene.store.Directory directory)  
    static org.apache.lucene.index.IndexWriterConfig indexWriterConfigWithNoMerging​(org.apache.lucene.analysis.Analyzer analyzer)
    Prepares a new IndexWriterConfig that does not do any merges, by setting both the merge policy and the merge scheduler.
    static boolean isCorruptionException​(java.lang.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 org.apache.lucene.document.NumericDocValuesField newSoftDeletesField()
    Returns a numeric docvalues which can be used to soft-delete documents.
    static org.apache.lucene.util.Version parseVersion​(java.lang.String version, org.apache.lucene.util.Version defaultVersion, org.apache.logging.log4j.Logger logger)  
    static org.apache.lucene.util.Version parseVersionLenient​(java.lang.String toParse, org.apache.lucene.util.Version defaultValue)
    Parses the version string lenient and returns the default value if the given string is null or empty
    static org.apache.lucene.index.SegmentInfos pruneUnreferencedFiles​(java.lang.String segmentsFileName, org.apache.lucene.store.Directory directory)
    This method removes all files from the given directory that are not referenced by the given segments file.
    static org.apache.lucene.search.Explanation readExplanation​(StreamInput in)  
    static org.apache.lucene.search.FieldDoc readFieldDoc​(StreamInput in)  
    static org.apache.lucene.search.ScoreDoc readScoreDoc​(StreamInput in)  
    static org.apache.lucene.index.SegmentInfos readSegmentInfos​(org.apache.lucene.index.IndexCommit commit)
    Reads the segments infos from the given commit, failing if it fails to load
    static org.apache.lucene.index.SegmentInfos readSegmentInfos​(org.apache.lucene.store.Directory directory)
    Reads the segments infos, failing if it fails to load
    static org.apache.lucene.search.SortField readSortField​(StreamInput in)  
    static org.apache.lucene.search.SortField.Type readSortType​(StreamInput in)  
    static java.lang.Comparable readSortValue​(StreamInput in)  
    static TopDocsAndMaxScore readTopDocs​(StreamInput in)  
    static org.apache.lucene.search.TotalHits readTotalHits​(StreamInput in)  
    static org.apache.lucene.index.SegmentReader segmentReader​(org.apache.lucene.index.LeafReader reader)
    Tries to extract a segment reader from the given index reader.
    static boolean waitForIndex​(org.apache.lucene.store.Directory directory, long timeLimitMillis)
    Wait for an index to exist for up to timeLimitMillis.
    static org.apache.lucene.index.DirectoryReader wrapAllDocsLive​(org.apache.lucene.index.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, org.apache.lucene.search.Explanation explanation)  
    static void writeFieldDoc​(StreamOutput out, org.apache.lucene.search.FieldDoc fieldDoc)  
    static void writeScoreDoc​(StreamOutput out, org.apache.lucene.search.ScoreDoc scoreDoc)  
    static void writeSortField​(StreamOutput out, org.apache.lucene.search.SortField sortField)  
    static void writeSortType​(StreamOutput out, org.apache.lucene.search.SortField.Type sortType)  
    static void writeSortValue​(StreamOutput out, java.lang.Object field)  
    static void writeTopDocs​(StreamOutput out, TopDocsAndMaxScore topDocs)  
    static void writeTotalHits​(StreamOutput out, org.apache.lucene.search.TotalHits totalHits)  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • LATEST_CODEC

      public static final java.lang.String LATEST_CODEC
      See Also:
      Constant Field Values

    • SOFT_DELETES_FIELD

      public static final java.lang.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

    • WHITESPACE_ANALYZER

      public static final NamedAnalyzer WHITESPACE_ANALYZER

    • EMPTY_SCORE_DOCS

      public static final org.apache.lucene.search.ScoreDoc[] EMPTY_SCORE_DOCS

    • EMPTY_TOP_DOCS

      public static final org.apache.lucene.search.TopDocs EMPTY_TOP_DOCS

  • Method Details

    • parseVersion

      public static org.apache.lucene.util.Version parseVersion​(@Nullable java.lang.String version, org.apache.lucene.util.Version defaultVersion, org.apache.logging.log4j.Logger logger)

    • readSegmentInfos

      public static org.apache.lucene.index.SegmentInfos readSegmentInfos​(org.apache.lucene.store.Directory directory) throws java.io.IOException
      Reads the segments infos, failing if it fails to load
      Throws:
      java.io.IOException

    • files

      public static java.lang.Iterable<java.lang.String> files​(org.apache.lucene.index.SegmentInfos infos) throws java.io.IOException
      Returns an iterable that allows to iterate over all files in this segments info
      Throws:
      java.io.IOException

    • getNumDocs

      public static int getNumDocs​(org.apache.lucene.index.SegmentInfos info)
      Returns the number of documents in the index referenced by this SegmentInfos

    • readSegmentInfos

      public static org.apache.lucene.index.SegmentInfos readSegmentInfos​(org.apache.lucene.index.IndexCommit commit) throws java.io.IOException
      Reads the segments infos from the given commit, failing if it fails to load
      Throws:
      java.io.IOException

    • pruneUnreferencedFiles

      public static org.apache.lucene.index.SegmentInfos pruneUnreferencedFiles​(java.lang.String segmentsFileName, org.apache.lucene.store.Directory directory) throws java.io.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:
      java.io.IOException

    • getIndexCommit

      public static org.apache.lucene.index.IndexCommit getIndexCommit​(org.apache.lucene.index.SegmentInfos si, org.apache.lucene.store.Directory directory) throws java.io.IOException
      Returns an index commit for the given SegmentInfos in the given directory.
      Throws:
      java.io.IOException

    • cleanLuceneIndex

      public static void cleanLuceneIndex​(org.apache.lucene.store.Directory directory) throws java.io.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:
      java.io.IOException

    • checkSegmentInfoIntegrity

      public static void checkSegmentInfoIntegrity​(org.apache.lucene.store.Directory directory) throws java.io.IOException
      Throws:
      java.io.IOException

    • exists

      public static boolean exists​(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.Query query) throws java.io.IOException
      Check whether there is one or more documents matching the provided query.
      Throws:
      java.io.IOException

    • readTotalHits

      public static org.apache.lucene.search.TotalHits readTotalHits​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • readTopDocs

      public static TopDocsAndMaxScore readTopDocs​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • readFieldDoc

      public static org.apache.lucene.search.FieldDoc readFieldDoc​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • readSortValue

      public static java.lang.Comparable readSortValue​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • readScoreDoc

      public static org.apache.lucene.search.ScoreDoc readScoreDoc​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTotalHits

      public static void writeTotalHits​(StreamOutput out, org.apache.lucene.search.TotalHits totalHits) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTopDocs

      public static void writeTopDocs​(StreamOutput out, TopDocsAndMaxScore topDocs) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeSortValue

      public static void writeSortValue​(StreamOutput out, java.lang.Object field) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeFieldDoc

      public static void writeFieldDoc​(StreamOutput out, org.apache.lucene.search.FieldDoc fieldDoc) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeScoreDoc

      public static void writeScoreDoc​(StreamOutput out, org.apache.lucene.search.ScoreDoc scoreDoc) throws java.io.IOException
      Throws:
      java.io.IOException

    • readSortType

      public static org.apache.lucene.search.SortField.Type readSortType​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • readSortField

      public static org.apache.lucene.search.SortField readSortField​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeSortType

      public static void writeSortType​(StreamOutput out, org.apache.lucene.search.SortField.Type sortType) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeSortField

      public static void writeSortField​(StreamOutput out, org.apache.lucene.search.SortField sortField) throws java.io.IOException
      Throws:
      java.io.IOException

    • readExplanation

      public static org.apache.lucene.search.Explanation readExplanation​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeExplanation

      public static void writeExplanation​(StreamOutput out, org.apache.lucene.search.Explanation explanation) throws java.io.IOException
      Throws:
      java.io.IOException

    • indexExists

      public static boolean indexExists​(org.apache.lucene.store.Directory directory) throws java.io.IOException
      Throws:
      java.io.IOException

    • waitForIndex

      public static boolean waitForIndex​(org.apache.lucene.store.Directory directory, long timeLimitMillis) throws java.io.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:
      java.io.IOException

    • isCorruptionException

      public static boolean isCorruptionException​(java.lang.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 org.apache.lucene.util.Version parseVersionLenient​(java.lang.String toParse, org.apache.lucene.util.Version defaultValue)
      Parses the version string lenient and returns the default value if the given string is null or empty

    • segmentReader

      public static org.apache.lucene.index.SegmentReader segmentReader​(org.apache.lucene.index.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 org.apache.lucene.util.Bits asSequentialAccessBits​(int maxDoc, @Nullable org.apache.lucene.search.ScorerSupplier scorerSupplier) throws java.io.IOException
      Return a Bits view of the provided scorer. NOTE: that the returned Bits instance MUST be consumed in order.
      Throws:
      java.io.IOException
      See Also:
      asSequentialAccessBits(int, ScorerSupplier, long)

    • asSequentialAccessBits

      public static org.apache.lucene.util.Bits asSequentialAccessBits​(int maxDoc, @Nullable org.apache.lucene.search.ScorerSupplier scorerSupplier, long estimatedGetCount) throws java.io.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:
      java.io.IOException

    • canEarlyTerminate

      public static boolean canEarlyTerminate​(org.apache.lucene.search.Sort searchSort, org.apache.lucene.search.Sort indexSort)
      Whether a query sorted by searchSort can be early-terminated if the index is sorted by indexSort.

    • wrapAllDocsLive

      public static org.apache.lucene.index.DirectoryReader wrapAllDocsLive​(org.apache.lucene.index.DirectoryReader in) throws java.io.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:
      java.io.IOException

    • newSoftDeletesField

      public static org.apache.lucene.document.NumericDocValuesField newSoftDeletesField()
      Returns a numeric docvalues which can be used to soft-delete documents.

    • emptyReader

      public static org.apache.lucene.index.LeafReader emptyReader​(int maxDoc)
      Returns an empty leaf reader with the given max docs. The reader will be fully deleted.

    • indexWriterConfigWithNoMerging

      public static org.apache.lucene.index.IndexWriterConfig indexWriterConfigWithNoMerging​(org.apache.lucene.analysis.Analyzer analyzer)
      Prepares a new IndexWriterConfig that does not do any merges, by setting both the merge policy and the merge scheduler. Setting just the merge policy means that constructing the index writer will create a ConcurrentMergeScheduler by default, which is quite heavyweight and in particular it can unnecessarily block on IOUtils.spins(org.apache.lucene.store.Directory).