org.apache.lucene.index

Class Term

public 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.
Constructor Summary
Term(String fld, String txt)
Constructs a Term with the given field and text.
Method Summary
intcompareTo(Object other)
intcompareTo(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.
TermcreateTerm(String text)
Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
booleanequals(Object o)
Compares two terms, returning true iff they have the same field and text.
Stringfield()
Returns the field of this term, an interned string.
inthashCode()
Combines the hashCode() of the field and the text.
Stringtext()
Returns the text of this term.
StringtoString()

Constructor Detail

Term

public Term(String fld, String txt)
Constructs a Term with the given field and text.

Method Detail

compareTo

public int compareTo(Object other)

compareTo

public final 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. The ordering of terms is first by field, then by text.

createTerm

public Term createTerm(String text)
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)

Returns: A new Term

equals

public final boolean equals(Object o)
Compares two terms, returning true iff they have the same field and text.

field

public final String field()
Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.

hashCode

public final int hashCode()
Combines the hashCode() of the field and the text.

text

public final 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.

toString

public final String toString()
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.