| Constructor and Description |
|---|
OverviewImpl(IndexReader reader,
String indexPath)
Constructs an OverviewImpl that holds the given
IndexReader. |
| 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.
|
getFieldNamespublic OverviewImpl(IndexReader reader, String indexPath)
IndexReader.reader - - the index readerindexPath - - the (root) index directory pathLukeException - - if an internal error is occurred when accessing indexpublic String getIndexPath()
OverviewgetIndexPath in interface Overviewpublic int getNumFields()
OverviewgetNumFields in interface Overviewpublic int getNumDocuments()
OverviewgetNumDocuments in interface Overviewpublic long getNumTerms()
OverviewgetNumTerms in interface Overviewpublic boolean hasDeletions()
OverviewhasDeletions in interface Overviewpublic int getNumDeletedDocs()
OverviewgetNumDeletedDocs in interface Overviewpublic Optional<Boolean> isOptimized()
OverviewisOptimized in interface Overviewpublic Optional<Long> getIndexVersion()
OverviewgetIndexVersion in interface Overviewpublic Optional<String> getIndexFormat()
OverviewgetIndexFormat in interface Overviewpublic Optional<String> getDirImpl()
OverviewDirectory implementation class name.
Empty Optional instance is returned if multiple indexes are opened.getDirImpl in interface Overviewpublic Optional<String> getCommitDescription()
OverviewgetCommitDescription in interface Overviewpublic Optional<String> getCommitUserData()
OverviewgetCommitUserData in interface Overviewpublic Map<String,Long> getSortedTermCounts(TermCountsOrder order)
OverviewTermCountsOrdergetSortedTermCounts in interface Overvieworder - - the sort orderpublic List<TermStats> getTopTerms(String field, int numTerms)
OverviewgetTopTerms in interface Overviewfield - - the field namenumTerms - - the max number of terms to be returnedCopyright © 2000-2024 Apache Software Foundation. All Rights Reserved.