Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ByteDocValuesField

    Field that stores a per-document byte value for scoring, sorting or value retrieval. Here's an example usage:

    document.Add(new ByteDocValuesField(name, (byte) 22));

    If you also need to store the value, you should add a separate StoredField instance.

    Inheritance
    object
    Field
    NumericDocValuesField
    ByteDocValuesField
    Implements
    IIndexableField
    IFormattable
    Inherited Members
    NumericDocValuesField.TYPE
    Field.m_type
    Field.m_name
    Field.FieldsData
    Field.m_tokenStream
    Field.m_boost
    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.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.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.dll
    Syntax
    [Obsolete("Use NumericDocValuesField instead")]
    public class ByteDocValuesField : NumericDocValuesField, IIndexableField, IFormattable

    Constructors

    ByteDocValuesField(string, byte)

    Creates a new DocValues field with the specified 8-bit byte value

    Declaration
    public ByteDocValuesField(string name, byte value)
    Parameters
    Type Name Description
    string name

    field name

    byte value

    8-bit byte value

    Exceptions
    Type Condition
    ArgumentNullException

    if the field name is null.

    See Also
    NumericDocValuesField

    Methods

    SetByteValue(byte)

    Expert: change the value of this field. See SetStringValue(string).

    Declaration
    public override void SetByteValue(byte value)
    Parameters
    Type Name Description
    byte value
    Overrides
    Field.SetByteValue(byte)
    See Also
    NumericDocValuesField

    Implements

    IIndexableField
    IFormattable

    Extension Methods

    IndexableFieldExtensions.GetByteValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetDoubleValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt16ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt32ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetInt64ValueOrDefault(IIndexableField)
    IndexableFieldExtensions.GetSingleValueOrDefault(IIndexableField)

    See Also

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