Interface Overview
-
- All Known Implementing Classes:
OverviewImpl
public interface Overview
A dedicated interface for Luke's Overview tab.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 openedDirectory
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 byTermCountsOrder
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.
-
-
-
Method Detail
-
getIndexPath
String getIndexPath()
Returns the currently opened index directory path, or the root directory path if multiple index directories are opened.
-
getNumFields
int getNumFields()
Returns the number of fields in this index.
-
getNumDocuments
int getNumDocuments()
Returns the number of documents in this index.
-
getNumTerms
long getNumTerms()
Returns the total number of terms in this index.- Throws:
LukeException
- - if an internal error occurs when accessing index
-
hasDeletions
boolean hasDeletions()
Returns true if this index includes deleted documents.
-
getNumDeletedDocs
int getNumDeletedDocs()
Returns the number of deleted documents in this index.
-
isOptimized
Optional<Boolean> isOptimized()
Returns true if the index is optimized. Empty Optional instance is returned if multiple indexes are opened.
-
getIndexVersion
Optional<Long> getIndexVersion()
Returns the version number when this index was opened. Empty Optional instance is returned if multiple indexes are opened.
-
getIndexFormat
Optional<String> getIndexFormat()
Returns the string representation for the Lucene segment version when the index was created. Empty Optional instance is returned if multiple indexes are opened.- Throws:
LukeException
- - if an internal error occurs when accessing index
-
getDirImpl
Optional<String> getDirImpl()
Returns the currently openedDirectory
implementation class name. Empty Optional instance is returned if multiple indexes are opened.
-
getCommitDescription
Optional<String> getCommitDescription()
Returns the information of the commit point that reader has opened. Empty Optional instance is returned if multiple indexes are opened.
-
getCommitUserData
Optional<String> getCommitUserData()
Returns the user provided data for the commit point. Empty Optional instance is returned if multiple indexes are opened.- Throws:
LukeException
- - if an internal error occurs when accessing index
-
getSortedTermCounts
Map<String,Long> getSortedTermCounts(TermCountsOrder order)
Returns all fields with the number of terms for each field sorted byTermCountsOrder
- Parameters:
order
- - the sort order- Returns:
- the ordered map of terms and their frequencies
- Throws:
LukeException
- - if an internal error occurs when accessing index
-
getTopTerms
List<TermStats> getTopTerms(String field, int numTerms)
Returns the top indexed terms with their statistics for the specified field.- Parameters:
field
- - the field namenumTerms
- - the max number of terms to be returned- Returns:
- the list of top terms and their document frequencies
- Throws:
LukeException
- - if an internal error occurs when accessing index
-
-