Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Index.Term Class Reference

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. More...

Inherits IComparable< Term >.

Public Member Functions

 Term (System.String fld, System.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 (System.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.
 
Term CreateTerm (System.String text)
 Optimized construction of new Terms by reusing same field as this Term
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
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.
 
override System.String ToString ()
 

Properties

string Field [get]
 Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.
 
string Text [get]
 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.
 

Detailed Description

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.

Definition at line 32 of file Term.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.Term.Term ( System.String  fld,
System.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.

Definition at line 41 of file Term.cs.

Lucene.Net.Index.Term.Term ( System.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

Definition at line 54 of file Term.cs.

Member Function Documentation

int Lucene.Net.Index.Term.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.

Definition at line 135 of file Term.cs.

Term Lucene.Net.Index.Term.CreateTerm ( System.String  text)

Optimized construction of new Terms by reusing same field as this Term

  • avoids field.intern() overhead
Parameters
textThe text of the new term (field is implicitly same as this Term instance)
Returns
A new Term

Definition at line 88 of file Term.cs.

override bool Lucene.Net.Index.Term.Equals ( System.Object  obj)

Definition at line 94 of file Term.cs.

override int Lucene.Net.Index.Term.GetHashCode ( )

Definition at line 121 of file Term.cs.

override System.String Lucene.Net.Index.Term.ToString ( )

Definition at line 151 of file Term.cs.

Property Documentation

string Lucene.Net.Index.Term.Field
get

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

Definition at line 68 of file Term.cs.

string Lucene.Net.Index.Term.Text
get

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.

Definition at line 77 of file Term.cs.


The documentation for this class was generated from the following file: