Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ByteDocValuesField

    Field that stores a per-document System.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
    System.Object
    Field
    NumericDocValuesField
    ByteDocValuesField
    Implements
    IIndexableField
    System.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(Int16)
    Field.SetInt32Value(Int32)
    Field.SetInt64Value(Int64)
    Field.SetSingleValue(Single)
    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)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.dll
    Syntax
    [Obsolete("Use NumericDocValuesField instead")]
    public class ByteDocValuesField : NumericDocValuesField, IIndexableField, IFormattable

    Constructors

    | Improve this Doc View Source

    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
    System.String name

    field name

    System.Byte value

    8-bit byte value

    Exceptions
    Type Condition
    System.ArgumentNullException

    if the field name is null.

    Methods

    | Improve this Doc View Source

    SetByteValue(Byte)

    Declaration
    public override void SetByteValue(byte value)
    Parameters
    Type Name Description
    System.Byte value
    Overrides
    Field.SetByteValue(Byte)

    Implements

    IIndexableField
    System.IFormattable

    Extension Methods

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

    See Also

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