Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class FacetField

    Add an instance of this to your Lucene.Net.Documents.Document for every facet label.

    NOTE: you must call Build(Document) before you add the document to Lucene.Net.Index.IndexWriter.

    Inheritance
    object
    Field
    FacetField
    Implements
    IIndexableField
    IFormattable
    Inherited Members
    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(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.Facet
    Assembly: Lucene.Net.Facet.dll
    Syntax
    public class FacetField : Field, IIndexableField, IFormattable

    Constructors

    FacetField(string, params string[])

    Creates the this from dim and path.

    Declaration
    public FacetField(string dim, params string[] path)
    Parameters
    Type Name Description
    string dim
    string[] path

    Properties

    Dim

    Dimension for this field.

    Declaration
    public string Dim { get; }
    Property Value
    Type Description
    string

    Path

    Path for this field.

    Declaration
    public string[] Path { get; }
    Property Value
    Type Description
    string[]

    Methods

    ToString()

    Prints a Lucene.Net.Documents.Field for human consumption.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    Lucene.Net.Documents.Field.ToString()

    VerifyLabel(string)

    Verifies the label is not null or empty string.

    Note

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

    Declaration
    public static void VerifyLabel(string label)
    Parameters
    Type Name Description
    string label

    Implements

    Lucene.Net.Index.IIndexableField
    IFormattable
    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.