| java.lang.Object
 org.apache.lucene.index.Term
| Term | | final public class Term implements Comparable,java.io.Serializable(Code) | | 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 occured in, an interned string.
Note that terms may represent more than words from text fields, but also
things like dates, email addresses, urls, etc.
|
| Constructor Summary | |
| public | Term(String fld, String txt)
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. | | | Term(String fld, String txt, boolean intern)
|
| Method Summary | |
| public int | compareTo(Object other)
| | final public int | compareTo(Term other)
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. | | public Term | createTerm(String text)
| | final public boolean | equals(Object o)
Compares two terms, returning true iff they have the same
field and text. | | final public String | field()
Returns the field of this term, an interned string. | | final public int | hashCode()
Combines the hashCode() of the field and the text. | | final void | set(String fld, String txt)
Resets the field and text of a Term. | | final public String | text()
Returns the text of this term. | | final public String | toString()
|
| Term | | public Term(String fld, String txt)(Code) | | 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.
|
| compareTo | | final public int compareTo(Term other)(Code) | | 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.
|
| createTerm | | public Term createTerm(String text)(Code) | | Optimized construction of new Terms by reusing same field as this Term
- avoids field.intern() overhead
Parameters:
text - The text of the new term (field is implicitly same as this Term instance) A new Term |
| equals | | final public boolean equals(Object o)(Code) | | Compares two terms, returning true iff they have the same
field and text.
|
| field | | final public String field()(Code) | | Returns the field of this term, an interned string. The field indicates
the part of a document which this term came from.
|
| hashCode | | final public int hashCode()(Code) | | Combines the hashCode() of the field and the text.
|
| text | | final public String text()(Code) | | 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.
|
|
|