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.
|
getFieldNames
public 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()
Overview
getIndexPath
in interface Overview
public int getNumFields()
Overview
getNumFields
in interface Overview
public int getNumDocuments()
Overview
getNumDocuments
in interface Overview
public long getNumTerms()
Overview
getNumTerms
in interface Overview
public boolean hasDeletions()
Overview
hasDeletions
in interface Overview
public int getNumDeletedDocs()
Overview
getNumDeletedDocs
in interface Overview
public Optional<Boolean> isOptimized()
Overview
isOptimized
in interface Overview
public Optional<Long> getIndexVersion()
Overview
getIndexVersion
in interface Overview
public Optional<String> getIndexFormat()
Overview
getIndexFormat
in interface Overview
public Optional<String> getDirImpl()
Overview
Directory
implementation class name.
Empty Optional instance is returned if multiple indexes are opened.getDirImpl
in interface Overview
public Optional<String> getCommitDescription()
Overview
getCommitDescription
in interface Overview
public Optional<String> getCommitUserData()
Overview
getCommitUserData
in interface Overview
public Map<String,Long> getSortedTermCounts(TermCountsOrder order)
Overview
TermCountsOrder
getSortedTermCounts
in interface Overview
order
- - the sort orderpublic List<TermStats> getTopTerms(String field, int numTerms)
Overview
getTopTerms
in interface Overview
field
- - the field namenumTerms
- - the max number of terms to be returnedCopyright © 2000-2021 Apache Software Foundation. All Rights Reserved.