org.apache.lucene.index

Class Term

Implemented Interfaces:
Comparable, java.io.Serializable

public final class Term
extends java.lang.Object
implements Comparable, java.io.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.

See Also:
Serialized Form

Constructor Summary

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

Method Summary

int
compareTo(Object other)
int
compareTo(Term other)
Compares two terms, returning an integer which is less than zero iff this term belongs after the argument, equal zero iff this term is equal to the argument, and greater than zero iff this term belongs after the argument.
boolean
equals(Object o)
Compares two terms, returning true iff they have the same field and text.
String
field()
Returns the field of this term, an interned string.
int
hashCode()
Combines the hashCode() of the field and the text.
String
text()
Returns the text of this term.
String
toString()

Constructor Details

Term

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

Method Details

compareTo

public int compareTo(Object other)


compareTo

public final int compareTo(Term other)
Compares two terms, returning an integer which is less than zero iff this term belongs after the argument, equal zero iff this term is equal to the argument, and greater than zero iff this term belongs after the argument. The ordering of terms is first by field, then by text.


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-2005 Apache Software Foundation. All Rights Reserved.