org.apache.lucene.index: public final class: Term

org.apache.lucene.index
public final class: Term [javadoc | source]

java.lang.Object
   org.apache.lucene.index.Term

All Implemented Interfaces:
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 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.

Field Summary
String	field
String	text

Constructor:
public Term(String fld, String txt) { this(fld, txt, true); } 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) { field = intern ? fld.intern() : fld; // field names are interned text = txt; // unless already known to be }

Constructor:

 public Term(String fld,
    String txt) {
    this(fld, txt, true);
}

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) {
    field = intern ? fld.intern() : fld;	  // field names are interned
    text = txt;					  // unless already known to be
}

Method from org.apache.lucene.index.Term Summary:
compareTo, compareTo, createTerm, equals, field, hashCode, set, text, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.lucene.index.Term Detail:
public int compareTo(Object other) { return compareTo((Term)other); }
public final int compareTo(Term other) { if (field == other.field) // fields are interned return text.compareTo(other.text); else return field.compareTo(other.field); } 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) { return new Term(field,text,false); } Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
public final boolean equals(Object o) { 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); } Compares two terms, returning true iff they have the same field and text.
public final String field() { return field; } Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.
public final int hashCode() { return field.hashCode() + text.hashCode(); } Combines the hashCode() of the field and the text.
final void set(String fld, String txt) { field = fld; text = txt; } Resets the field and text of a Term.
public final String text() { return 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() { return field + ":" + text; }

Method from org.apache.lucene.index.Term Detail:

 public int compareTo(Object other) {
    return compareTo((Term)other);
}

 public final int compareTo(Term other) {
    if (field == other.field)			  // fields are interned
      return text.compareTo(other.text);
    else
      return field.compareTo(other.field);
}

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) {
      return new Term(field,text,false);
}

Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead

 public final boolean equals(Object o) {
    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);
}

Compares two terms, returning true iff they have the same field and text.

 public final String field() {
 return field;
}

Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.

 public final int hashCode() {
    return field.hashCode() + text.hashCode();
}

Combines the hashCode() of the field and the text.

 final  void set(String fld,
    String txt) {
    field = fld;
    text = txt;
}

Resets the field and text of a Term.

 public final String text() {
 return 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() {
 return field + ":" + text;
}