Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » index » [javadoc | source]
org.apache.lucene.index
public final class: Term [javadoc | source]
java.lang.Object
   org.apache.lucene.index.Term

All Implemented Interfaces:
    java$io$Serializable, Comparable

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.
Field Summary
 String field     
 String text     
Constructor:
 public Term(String fld) 
    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.
    Parameters:
    fld -
 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 from org.apache.lucene.index.Term Summary:
compareTo,   createTerm,   equals,   field,   hashCode,   set,   text,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.index.Term Detail:
 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.
 public Term createTerm(String text) 
    Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
 public boolean equals(Object obj) 
 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.
 public int hashCode() 
 final  void set(String fld,
    String txt) 
    Resets the field and text of a Term.
 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.
 public final String toString()