Namespace Umbraco.Cms.Infrastructure.Examine

Classes

AddExamineComposer

BackOfficeExamineSearcher

BaseValueSetBuilder<TContent>

ConfigurationEnabledDirectoryFactory

An Examine directory factory implementation based on configured values

ContentIndexPopulator

Performs the data lookups required to rebuild a content index

ContentValueSetBuilder

Builds Examine.ValueSets for IContent items

ContentValueSetValidator

Used to validate a ValueSet for content/media - based on permissions, parent id, etc....

DeliveryApiContentIndex

ExamineIndexModel

Represents the data model used for an Examine index in Umbraco.

ExamineSearcherModel

Represents the model used to configure and interact with an Examine searcher within the Umbraco CMS infrastructure.

ExternalMemberIndexPopulator

Populates and maintains the member index with external-only member data used by the Examine search engine in Umbraco.

ExternalMemberValueSetBuilder

Builds Examine.ValueSet instances for external-only members so they can be indexed by Examine.

GenericIndexDiagnostics

Used to return diagnostic data for any index

IndexDiagnosticsFactory

Default implementation of IIndexDiagnosticsFactory which returns GenericIndexDiagnostics for indexes that don't have an implementation

IndexPopulator

Provides functionality to populate and manage Examine indexes with data in Umbraco.

IndexPopulator<TIndex>

An IIndexPopulator that is automatically associated to any index of type TIndex

IndexTypes

The index types stored in the Lucene Index

LuceneIndexDiagnostics

LuceneIndexDiagnosticsFactory

Implementation of IIndexDiagnosticsFactory which returns LuceneIndexDiagnostics for lucene based indexes that don't have an implementation else fallsback to the default IndexDiagnosticsFactory implementation.

LuceneRAMDirectoryFactory

MediaIndexPopulator

Performs the data lookups required to rebuild a media index

MediaValueSetBuilder

Responsible for constructing Examine.ValueSet instances representing media items for indexing by the Examine search engine in Umbraco. This builder extracts relevant properties from media entities to facilitate efficient searching and retrieval.

MemberIndexPopulator

Populates and maintains the member index used by the Examine search engine in Umbraco. This ensures that member data is searchable and kept up to date within the index.

MemberValueSetBuilder

Provides functionality to build value sets for member entities, enabling them to be indexed by Examine.

MemberValueSetValidator

Provides validation logic for member value sets during the Examine indexing process in Umbraco.

NoPrefixSimpleFsLockFactory

A custom Lucene.Net.Store.SimpleFSLockFactory that ensures a prefixless lock prefix

NoopBackOfficeExamineSearcher

Represents a no-operation (noop) implementation of the back office Examine searcher, which performs no search actions. This can be used as a placeholder or default when search functionality is not required.

PublishedContentIndexPopulator

Performs the data lookups required to rebuild a content index containing only published content

RebuildOnStartupHandler

Handles how the indexes are rebuilt on startup

UmbracoApplicationRoot

Sets the Examine Examine.IApplicationRoot to be ExamineIndexes sub directory of the Umbraco TEMP folder

UmbracoContentIndex

An indexer for Umbraco content and media.

UmbracoExamineFieldNames

Provides constant field names used by Umbraco for indexing and searching content with Examine.

UmbracoExamineFieldNames.DeliveryApiContentIndex

Field names specifically used in the Delivery API content index

UmbracoExamineIndex

An abstract provider containing the basic functionality to be able to query against Umbraco data.

UmbracoExamineIndexDiagnostics

UmbracoFieldDefinitionCollection

Custom Examine.FieldDefinitionCollection allowing dynamic creation of Examine.FieldDefinition

UmbracoIndexConfig

Represents the configuration settings for an Umbraco Examine index.

UmbracoLockFactory

UmbracoMemberIndex

Custom indexer for members

UmbracoTempEnvFileSystemDirectoryFactory

Custom version of https://github.com/Shazwazza/Examine/blob/release/3.0/src/Examine.Lucene/Directories/TempEnvFileSystemDirectoryFactory.cs that includes the Umbraco SiteName property in the path hash

ValueSetValidator

Performing basic validation of a value set

Interfaces

IBackOfficeExamineSearcher

Used to search the back office for Examine indexed entities (Documents, Media and Members)

IContentValueSetBuilder

Creates a collection of Examine.ValueSet to be indexed based on a collection of IContent.

IContentValueSetValidator

An extended Examine.IValueSetValidator for content indexes

IDeliveryApiContentIndexFieldDefinitionBuilder

Provides a contract for building field definitions used in the Delivery API content index.

IDeliveryApiContentIndexValueSetBuilder

Represents a contract for building value sets used in the Delivery API content index.

IIndexDiagnostics

Exposes diagnostic information about an index

IIndexDiagnosticsFactory

Creates IIndexDiagnostics for an index if it doesn't implement IIndexDiagnostics

IIndexPopulator

Defines the contract for classes responsible for populating search indexes with data. Implementations of this interface handle the logic required to add or update content in an index.

IIndexRebuilder

Interface for rebuilding search indexes.

IPublishedContentValueSetBuilder

Marker interface for a Examine.ValueSet builder for only published content

IUmbracoContentIndex

Marker interface for indexes of Umbraco content

IUmbracoIndex

A Marker interface for defining an Umbraco indexer

IUmbracoIndexConfig

Represents the configuration settings used to define and customize an Umbraco Examine index.

IUmbracoMemberIndex

Represents an interface for the Umbraco member index within the Examine search provider, defining the contract for member indexing functionality.

IUmbracoTreeSearcherFields

Used to propagate hardcoded internal Field lists

IValueSetBuilder<T>

Creates a collection of Examine.ValueSet to be indexed based on a collection of T.