java.lang.Object | |
↳ | org.apache.lucene.index.Term |
A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occurred in, an interned string. Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a Term with the given field and text.
| |||||||||||
Constructs a Term with the given field and empty text.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Compares two terms, returning a negative integer if this
term belongs before the argument, zero if this term is equal to the
argument, and a positive integer if this term belongs after the argument.
| |||||||||||
Optimized construction of new Terms by reusing same field as this Term
- avoids field.intern() overhead
| |||||||||||
Returns the field of this term, an interned string.
| |||||||||||
Returns the text of this term.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
Constructs a Term with the given field and text.
Note that a null field or null text value results in undefined behavior for most Lucene APIs that accept a Term parameter.
Constructs a Term with the given field and empty text. This serves two purposes: 1) reuse of a Term with the same field. 2) pattern for a query.
Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument. The ordering of terms is first by field, then by text.
Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
text | The text of the new term (field is implicitly same as this Term instance) |
---|
Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.
Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string.