public interface Documents
| Modifier and Type | Method and Description |
|---|---|
Optional<Term> |
firstTerm(String field)
Returns the first indexed term in the specified field.
|
Optional<Integer> |
firstTermDoc()
Returns the first document id (posting) associated with the current term.
|
String |
getCurrentField()
Returns the current target field name.
|
Optional<Integer> |
getDocFreq()
Returns the document frequency for the current term (the number of documents containing the current term.)
Empty Optional instance is returned if the terms iterator has not been positioned yet.
|
List<DocumentField> |
getDocumentFields(int docid)
Returns the list of field information and field data for the specified document.
|
Optional<DocValues> |
getDocValues(int docid,
String field)
Returns the doc values for the specified field in the specified document.
|
Collection<String> |
getFieldNames()
Returns field names in this index.
|
int |
getMaxDoc()
Returns one greater than the largest possible document number.
|
List<TermPosting> |
getTermPositions()
Returns the list of the position information for the current posting.
|
List<TermVectorEntry> |
getTermVectors(int docid,
String field)
Returns the term vectors for the specified field in the specified document.
|
boolean |
isLive(int docid)
Returns true if the document with the specified
docid is not deleted, otherwise false. |
Optional<Term> |
nextTerm()
Increments the terms iterator and returns the next indexed term for the target field.
|
Optional<Integer> |
nextTermDoc()
Increments the postings iterator and returns the next document id (posting) for the current term.
|
Optional<Term> |
seekTerm(String termText)
Seeks to the specified term, if it exists, or to the next (ceiling) term.
|
int getMaxDoc()
Collection<String> getFieldNames()
boolean isLive(int docid)
docid is not deleted, otherwise false.docid - - document idList<DocumentField> getDocumentFields(int docid)
docid - - document idLukeException - - if an internal error occurs when accessing indexString getCurrentField()
Optional<Term> firstTerm(String field)
field - - field nameLukeException - - if an internal error occurs when accessing indexOptional<Term> nextTerm()
LukeException - - if an internal error occurs when accessing indexOptional<Term> seekTerm(String termText)
termText - - term to seekLukeException - - if an internal error occurs when accessing indexOptional<Integer> firstTermDoc()
LukeException - - if an internal error occurs when accessing indexOptional<Integer> nextTermDoc()
LukeException - - if an internal error occurs when accessing indexList<TermPosting> getTermPositions()
LukeException - - if an internal error occurs when accessing indexOptional<Integer> getDocFreq()
LukeException - - if an internal error occurs when accessing indexList<TermVectorEntry> getTermVectors(int docid, String field)
docid - - document idfield - - field nameLukeException - - if an internal error occurs when accessing indexOptional<DocValues> getDocValues(int docid, String field)
docid - - document idfield - - field nameLukeException - - if an internal error occurs when accessing indexCopyright © 2000-2024 Apache Software Foundation. All Rights Reserved.