Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class StraightBytesDocValuesField

    Field that stores a per-document BytesRef value. If values may be shared it's better to use SortedDocValuesField. Here's an example usage:

    document.Add(new StraightBytesDocValuesField(name, new BytesRef("hello")));

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

    Inheritance
    object
    Field
    BinaryDocValuesField
    StraightBytesDocValuesField
    Implements
    IIndexableField
    IFormattable
    Inherited Members
    BinaryDocValuesField.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.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.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.dll
    Syntax
    [Obsolete("Use BinaryDocValuesField instead.")]
    public class StraightBytesDocValuesField : BinaryDocValuesField, IIndexableField, IFormattable

    Constructors

    StraightBytesDocValuesField(string, BytesRef)

    Create a new fixed or variable length DocValues field.

    Declaration
    public StraightBytesDocValuesField(string name, BytesRef bytes)
    Parameters
    Type Name Description
    string name

    field name

    BytesRef bytes

    binary content

    Exceptions
    Type Condition
    ArgumentNullException

    if the field name is null

    See Also
    BinaryDocValuesField

    StraightBytesDocValuesField(string, BytesRef, bool)

    Create a new fixed or variable length direct DocValues field.

    Declaration
    public StraightBytesDocValuesField(string name, BytesRef bytes, bool isFixedLength)
    Parameters
    Type Name Description
    string name

    field name

    BytesRef bytes

    binary content

    bool isFixedLength

    (ignored)

    Exceptions
    Type Condition
    ArgumentNullException

    if the field name is null

    See Also
    BinaryDocValuesField

    Fields

    TYPE_FIXED_LEN

    Type for direct bytes DocValues: all with the same length

    Declaration
    public static readonly FieldType TYPE_FIXED_LEN
    Field Value
    Type Description
    FieldType
    See Also
    BinaryDocValuesField

    TYPE_VAR_LEN

    Type for direct bytes DocValues: can have variable lengths

    Declaration
    public static readonly FieldType TYPE_VAR_LEN
    Field Value
    Type Description
    FieldType
    See Also
    BinaryDocValuesField

    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

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