Termpublic final class Term extends Object implements Comparable, Serializable| 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. |
| Fields Summary |
|---|
| String | field | | String | text |
| Constructors 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.
this(fld, txt, true);
| Term(String fld, String txt, boolean intern)
field = intern ? fld.intern() : fld; // field names are interned
text = txt; // unless already known to be
|
| Methods Summary |
|---|
| public int | compareTo(java.lang.Object other)
return compareTo((Term)other);
| | public final int | compareTo(org.apache.lucene.index.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.
The ordering of terms is first by field, then by text.
if (field == other.field) // fields are interned
return text.compareTo(other.text);
else
return field.compareTo(other.field);
| | public org.apache.lucene.index.Term | createTerm(java.lang.String text)Optimized construction of new Terms by reusing same field as this Term
- avoids field.intern() overhead
return new Term(field,text,false);
| | public final boolean | equals(java.lang.Object o)Compares two terms, returning true iff they have the same
field and text.
if (o == this)
return true;
if (o == null)
return false;
if (!(o instanceof Term))
return false;
Term other = (Term)o;
return field == other.field && text.equals(other.text);
| | public final java.lang.String | field()Returns the field of this term, an interned string. The field indicates
the part of a document which this term came from. return field;
| | public final int | hashCode()Combines the hashCode() of the field and the text.
return field.hashCode() + text.hashCode();
| | private void | readObject(java.io.ObjectInputStream in)
in.defaultReadObject();
field = field.intern();
| | final void | set(java.lang.String fld, java.lang.String txt)Resets the field and text of a Term.
field = fld;
text = txt;
| | public final java.lang.String | text()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. return text;
| | public final java.lang.String | toString() return field + ":" + text;
|
|
