Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class StringField

    A field that is indexed but not tokenized: the entire string value is indexed as a single token. For example this might be used for a 'country' field or an 'id' field, or any field that you intend to use for sorting or access through the field cache.

    Inheritance
    object
    Field
    StringField
    Implements
    IIndexableField
    IFormattable
    Inherited Members
    Field.GetStringValue()
    Field.GetStringValue(IFormatProvider)
    Field.GetStringValue(string)
    Field.GetStringValue(string, IFormatProvider)
    Field.GetReaderValue()
    Field.GetTokenStreamValue()
    Field.SetStringValue(string)
    Field.SetReaderValue(TextReader)
    Field.SetBytesValue(BytesRef)
    Field.SetBytesValue(byte[])
    Field.SetByteValue(byte)
    Field.SetInt16Value(short)
    Field.SetInt32Value(int)
    Field.SetInt64Value(long)
    Field.SetSingleValue(float)
    Field.SetDoubleValue(double)
    Field.SetTokenStream(TokenStream)
    Field.Name
    Field.Boost
    Field.GetNumericValue()
    Field.NumericType
    Field.GetByteValue()
    Field.GetInt16Value()
    Field.GetInt32Value()
    Field.GetInt64Value()
    Field.GetSingleValue()
    Field.GetDoubleValue()
    Field.GetBinaryValue()
    Field.ToString()
    Field.ToString(string)
    Field.ToString(IFormatProvider)
    Field.ToString(string, IFormatProvider)
    Field.FieldType
    Field.IndexableFieldType
    Field.GetTokenStream(Analyzer)
    Field.TranslateFieldType(Field.Store, Field.Index, Field.TermVector)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class StringField : Field, IIndexableField, IFormattable

    Constructors

    StringField(string, string, Store)

    Creates a new StringField (a field that is indexed but not tokenized)

    Declaration
    public StringField(string name, string value, Field.Store stored)
    Parameters
    Type Name Description
    string name

    field name

    string value

    string value

    Field.Store stored

    YES if the content should also be stored

    Exceptions
    Type Condition
    ArgumentNullException

    if the field name or value is null.

    Fields

    TYPE_NOT_STORED

    Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored.

    Declaration
    public static readonly FieldType TYPE_NOT_STORED
    Field Value
    Type Description
    FieldType

    TYPE_STORED

    Indexed, not tokenized, omits norms, indexes DOCS_ONLY, stored

    Declaration
    public static readonly FieldType TYPE_STORED
    Field Value
    Type Description
    FieldType

    Implements

    IIndexableField
    IFormattable

    Extension Methods

    IndexableFieldExtensions.GetByteValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetDoubleValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt16ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt32ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt64ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetSingleValueOrDefault(IIndexableField)
    Back to top Copyright © 2024 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.