public interface Overview
Modifier and Type | Method and Description |
---|---|
Optional<String> |
getCommitDescription()
Returns the information of the commit point that reader has opened.
|
Optional<String> |
getCommitUserData()
Returns the user provided data for the commit point.
|
Optional<String> |
getDirImpl()
Returns the currently opened
Directory implementation class name. |
Optional<String> |
getIndexFormat()
Returns the string representation for the Lucene segment version when the index was created.
|
String |
getIndexPath()
Returns the currently opened index directory path,
or the root directory path if multiple index directories are opened.
|
Optional<Long> |
getIndexVersion()
Returns the version number when this index was opened.
|
int |
getNumDeletedDocs()
Returns the number of deleted documents in this index.
|
int |
getNumDocuments()
Returns the number of documents in this index.
|
int |
getNumFields()
Returns the number of fields in this index.
|
long |
getNumTerms()
Returns the total number of terms in this index.
|
Map<String,Long> |
getSortedTermCounts(TermCountsOrder order)
Returns all fields with the number of terms for each field sorted by
TermCountsOrder |
List<TermStats> |
getTopTerms(String field,
int numTerms)
Returns the top indexed terms with their statistics for the specified field.
|
boolean |
hasDeletions()
Returns true if this index includes deleted documents.
|
Optional<Boolean> |
isOptimized()
Returns true if the index is optimized.
|
String getIndexPath()
int getNumFields()
int getNumDocuments()
long getNumTerms()
LukeException
- - if an internal error occurs when accessing indexboolean hasDeletions()
int getNumDeletedDocs()
Optional<Boolean> isOptimized()
Optional<Long> getIndexVersion()
Optional<String> getIndexFormat()
LukeException
- - if an internal error occurs when accessing indexOptional<String> getDirImpl()
Directory
implementation class name.
Empty Optional instance is returned if multiple indexes are opened.Optional<String> getCommitDescription()
Optional<String> getCommitUserData()
LukeException
- - if an internal error occurs when accessing indexMap<String,Long> getSortedTermCounts(TermCountsOrder order)
TermCountsOrder
order
- - the sort orderLukeException
- - if an internal error occurs when accessing indexList<TermStats> getTopTerms(String field, int numTerms)
field
- - the field namenumTerms
- - the max number of terms to be returnedLukeException
- - if an internal error occurs when accessing indexCopyright © 2000-2021 Apache Software Foundation. All Rights Reserved.