Class Term
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.
Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.
Inheritance
Assembly: DistributedLucene.Net.dll
Syntax
public sealed class Term : IComparable<Term>, IEquatable<Term>Constructors
| Name | Description |
|---|---|
| Term(String) | 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(String, BytesRef) | Constructs a Term with the given field and bytes. Note that a null field or null bytes value results in undefined behavior for most Lucene APIs that accept a Term parameter. WARNING: the provided BytesRef is not copied, but used directly. Therefore the bytes should not be modified after construction, for example, you should clone a copy by DeepCopyOf(BytesRef) rather than pass reused bytes from a TermsEnum. |
| Term(String, String) | Constructs a Term with the given field and text. Note that a |
Properties
| Name | Description |
|---|---|
| Bytes | Returns the bytes of this term. |
| Field | Returns the field of this term. The field indicates the part of a document which this term came from. |
Methods
| Name | Description |
|---|---|
| CompareTo(Term) | 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. |
| Equals(Term) | |
| Equals(Object) | |
| GetHashCode() | |
| 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() | |
| ToString(BytesRef) | Returns human-readable form of the term text. If the term is not unicode, the raw bytes will be printed instead. |
