Fork me on GitHub
  • API

    Show / Hide Table of Contents

    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
    System.Object
    Term
    Implements
    System.IComparable<Term>
    System.IEquatable<Term>
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    [Serializable]
    public sealed class Term : IComparable<Term>, IEquatable<Term>

    Constructors

    | Improve this Doc View Source

    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.

    Declaration
    public Term(string fld)
    Parameters
    Type Name Description
    System.String fld

    field's name

    | Improve this Doc View Source

    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.

    Declaration
    public Term(string fld, BytesRef bytes)
    Parameters
    Type Name Description
    System.String fld
    BytesRef bytes
    | Improve this Doc View Source

    Term(String, String)

    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.

    Declaration
    public Term(string fld, string text)
    Parameters
    Type Name Description
    System.String fld
    System.String text

    Properties

    | Improve this Doc View Source

    Bytes

    Returns the bytes of this term.

    Declaration
    public BytesRef Bytes { get; }
    Property Value
    Type Description
    BytesRef
    | Improve this Doc View Source

    Field

    Returns the field of this term. The field indicates the part of a document which this term came from.

    Declaration
    public string Field { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    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.

    Declaration
    public string Text { get; }
    Property Value
    Type Description
    System.String

    Methods

    | Improve this Doc View Source

    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.

    Declaration
    public int CompareTo(Term other)
    Parameters
    Type Name Description
    Term other
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    Equals(Term)

    Declaration
    public bool Equals(Term other)
    Parameters
    Type Name Description
    Term other
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Object.Equals(System.Object)
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Object.GetHashCode()
    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()
    | Improve this Doc View Source

    ToString(BytesRef)

    Returns human-readable form of the term text. If the term is not unicode, the raw bytes will be printed instead.

    Declaration
    public static string ToString(BytesRef termText)
    Parameters
    Type Name Description
    BytesRef termText
    Returns
    Type Description
    System.String

    Implements

    System.IComparable<T>
    System.IEquatable<T>
    • Improve this Doc
    • View Source
    Back to top Copyright © 2021 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.