Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class BoostAttribute

    Implementation class for IBoostAttribute.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Inheritance
    object
    Attribute
    BoostAttribute
    Implements
    IBoostAttribute
    IAttribute
    Inherited Members
    Attribute.ReflectAsString(bool)
    Attribute.ReflectWith(IAttributeReflector)
    Attribute.ToString()
    Attribute.Clone()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class BoostAttribute : Attribute, IBoostAttribute, IAttribute

    Properties

    Boost

    Gets or Sets the boost in this attribute. Default is 1.0f.

    Declaration
    public float Boost { get; set; }
    Property Value
    Type Description
    float

    Methods

    Clear()

    Clears the values in this Attribute and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.

    Declaration
    public override void Clear()
    Overrides
    Attribute.Clear()

    CopyTo(IAttribute)

    Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the IAttributes this implementation supports.

    Declaration
    public override void CopyTo(IAttribute target)
    Parameters
    Type Name Description
    IAttribute target
    Overrides
    Attribute.CopyTo(IAttribute)

    Implements

    IBoostAttribute
    IAttribute
    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.