org.hibernate.search.engine.impl

Class ConfigContext

java.lang.Object

org.hibernate.search.engine.impl.ConfigContext

public final class ConfigContext
extends Object

Provides access to some default configuration settings (eg default Analyzer or default Similarity) and checks whether certain optional libraries are available.

Author:

Emmanuel Bernard, Hardy Ferentschik

Constructor Summary

Constructors

Constructor and Description
ConfigContext(SearchConfiguration searchConfiguration, BuildContext buildContext)
ConfigContext(SearchConfiguration searchConfiguration, BuildContext buildContext, SearchMapping searchMapping, Map<IndexManagerType,AnalyzerRegistry> previousAnalyzerRegistries)

Method Summary

Modifier and Type	Method and Description
void	addAnalyzerDef(AnalyzerDef analyzerDef, org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement) Add an analyzer definition which was defined as annotation.
void	addFullTextFilterDef(FullTextFilterDef filterDef, org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement) Add a full-filter definition which was defined as annotation
void	addGlobalAnalyzerDef(AnalyzerDef analyzerDef)
void	addGlobalFullTextFilterDef(FullTextFilterDef filterDef)
MutableAnalyzerRegistry	getAnalyzerRegistry(IndexManagerType type)
Map<FieldBridge,ClassBridge>	getClassBridgeInstances(Class<?> type) Returns class bridge instances configured via the programmatic API, if any.
String	getDefaultNullToken()
ServiceManager	getServiceManager()
Map<IndexManagerType,AnalyzerRegistry>	initAnalyzerRegistries(IndexManagerHolder indexesFactory) Initialize the named analyzer references created throughout the mapping creation with the analyzer definitions collected throughout the mapping creation.
Map<String,FilterDef>	initFilters()
boolean	isJpaPresent()
boolean	isProvidedIdImplicit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigContext

public ConfigContext(SearchConfiguration searchConfiguration,
                     BuildContext buildContext)

ConfigContext

public ConfigContext(SearchConfiguration searchConfiguration,
                     BuildContext buildContext,
                     SearchMapping searchMapping,
                     Map<IndexManagerType,AnalyzerRegistry> previousAnalyzerRegistries)

Method Detail

getServiceManager

public ServiceManager getServiceManager()

addAnalyzerDef

public void addAnalyzerDef(AnalyzerDef analyzerDef,
                           org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement)

Add an analyzer definition which was defined as annotation.

Parameters:

analyzerDef - the analyzer definition annotation

annotatedElement - the annotated element it was defined on

addFullTextFilterDef

public void addFullTextFilterDef(FullTextFilterDef filterDef,
                                 org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement)

Add a full-filter definition which was defined as annotation

Parameters:

filterDef - the filter definition annotation

annotatedElement - the annotated element it was defined on

addGlobalAnalyzerDef

public void addGlobalAnalyzerDef(AnalyzerDef analyzerDef)

addGlobalFullTextFilterDef

public void addGlobalFullTextFilterDef(FullTextFilterDef filterDef)

getAnalyzerRegistry

public MutableAnalyzerRegistry getAnalyzerRegistry(IndexManagerType type)

getDefaultNullToken

public String getDefaultNullToken()

initAnalyzerRegistries

public Map<IndexManagerType,AnalyzerRegistry> initAnalyzerRegistries(IndexManagerHolder indexesFactory)

Initialize the named analyzer references created throughout the mapping creation with the analyzer definitions collected throughout the mapping creation.

Analyzer definitions and references are handled simultaneously during the mapping creation, so it's actually possible that, while creating the mapping, we encounter references to analyzer which haven't been defined yet.

To work around this issue, we do not resolve references immediately, but instead create "dangling" references whose initialization will be delayed to the end of the mapping (see getAnalyzerRegistry(IndexManagerType)).

This method executes the final initialization, resolving dangling references.

Parameters:

indexesFactory - The index manager holder, giving access to the relevant index manager types.

Returns:

The named analyzer references, to be accessed through SearchFactory.getAnalyzer(String) or ExtendedSearchIntegrator.getAnalyzerReference(String).

initFilters

public Map<String,FilterDef> initFilters()

isJpaPresent

public boolean isJpaPresent()

isProvidedIdImplicit

public boolean isProvidedIdImplicit()

Returns:

true if we have to assume entities are annotated with @ProvidedId implicitly

getClassBridgeInstances

public Map<FieldBridge,ClassBridge> getClassBridgeInstances(Class<?> type)

Returns class bridge instances configured via the programmatic API, if any. The returned map's values are @ClassBridge annotations representing the corresponding analyzer etc. configuration.

Parameters:

type - the type for which to return the configured class bridge instances

Returns:

a map with class bridge instances and their configuration; May be empty but never null