Class FieldDefinitionBase

Namespace

Dynamicweb.Indexing.Schemas

Assembly

Dynamicweb.Core.dll

Base class for field definitions

public abstract class FieldDefinitionBase

Inheritance

object

FieldDefinitionBase

Derived

CopyFieldDefinition

ExtensionFieldDefinition

FieldDefinition

GroupingFieldDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Analyzed

Gets or sets a value indicating whether the field is run through an analyzer (tokenized) when indexed. When false the value is indexed as a single untokenized term. Only relevant when Indexed is true.

public bool Analyzed { get; set; }

Property Value

bool

AnalyzerTypeName

Analyzer type name

public string? AnalyzerTypeName { get; set; }

Property Value

string

Boost

Gets or sets the index-time boost applied to the field, parsed as a float. Higher values increase the relevance contribution of the field at query time.

public string? Boost { get; set; }

Property Value

string

ClassName

public string ClassName { get; }

Property Value

string

DefaultStoreTermVectors

Gets the default value used by StoreTermVectors when it has not been explicitly set. Defaults to false; field types that rely on term vectors (e.g. for spell-check) override this.

protected virtual bool DefaultStoreTermVectors { get; }

Property Value

bool

Facetable

Gets or sets a value indicating whether facet values are generated for the field, allowing it to be used for faceted navigation. Only relevant when Indexed is true.

public bool Facetable { get; set; }

Property Value

bool

Group

Group name

public string Group { get; set; }

Property Value

string

Hidden

Gets or sets the value indicating whether the field is hidden.

public bool Hidden { get; set; }

Property Value

bool

Indexed

Gets or sets a value indicating whether the field is indexed and therefore searchable. When false the field is not added to the inverted index and cannot be queried.

public bool Indexed { get; set; }

Property Value

bool

IsFieldFromSchemaExtender

Is field from a schema extender

public bool IsFieldFromSchemaExtender { get; set; }

Property Value

bool

IsNumeric

Determines whether the type of the field is numeric.

public bool IsNumeric { get; }

Property Value

bool

Name

Name of field definition

public string Name { get; set; }

Property Value

string

StoreTermVectors

Gets or sets a value indicating whether term vectors are stored for this field. Term vectors are required for spell-check suggestions and highlighting, but add significant write cost and disk usage on every indexed document. Only enable on fields that need those features; leaving it disabled improves indexing throughput and reduces index size, which matters most on large indexes (millions of documents). Only relevant when Indexed is true. When not explicitly set, falls back to DefaultStoreTermVectors, which most field types default to false.

public bool StoreTermVectors { get; set; }

Property Value

bool

Stored

Gets or sets a value indicating whether the field value is stored in the index and can be retrieved verbatim in query results. Stored fields are not searchable on their own; combine with Indexed to make the field both retrievable and searchable.

public bool Stored { get; set; }

Property Value

bool

SystemName

System name

public string SystemName { get; set; }

Property Value

string

TypeName

Type of field definition

public string TypeName { get; set; }

Property Value

string

Methods

GetAnalyzer(string)

Gets analyzer type name specified by provider type name

public string? GetAnalyzer(string providerTypeName)

Parameters

providerTypeName string

Provider type name

Returns

string

Analyzer type name

GetTypeOfField()

Gets the type of the field.

public Type? GetTypeOfField()

Returns

Type

GetTypeOfFieldOrElement()

Gets the type of the field type or the element type if the type is an array.

public Type? GetTypeOfFieldOrElement()

Returns

Type

SetFieldType(FieldTypeDefinition)

Sets type of field definition

public void SetFieldType(FieldTypeDefinition fieldType)

Parameters

fieldType FieldTypeDefinition