org.hibernate.search.impl
Class ConfigContext

java.lang.Object
  org.hibernate.search.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

ConfigContext(SearchConfiguration cfg)

ConfigContext(SearchConfiguration cfg, SearchMapping searchMapping)

Method Summary

void	addAnalyzerDef(AnalyzerDef analyzerDef, org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement) Add an analyzer definition which was defined as annotation.
void	addFacetFieldName(String facetFieldName) Add a facet field name.
void	addGlobalAnalyzerDef(AnalyzerDef analyzerDef)
org.apache.lucene.analysis.Analyzer	buildLazyAnalyzer(String name)
Map<FieldBridge,ClassBridge>	getClassBridgeInstances(Class<?> type) Returns class bridge instances configured via the programmatic API, if any.
org.apache.lucene.analysis.Analyzer	getDefaultAnalyzer()
String	getDefaultNullToken()
org.apache.lucene.search.Similarity	getDefaultSimilarity()
Collection<String>	getFacetFieldNames()
List<DelegateNamedAnalyzer>	getLazyAnalyzers()
org.apache.lucene.util.Version	getLuceneMatchVersion()
Map<String,org.apache.lucene.analysis.Analyzer>	initLazyAnalyzers()
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 cfg)

ConfigContext

public ConfigContext(SearchConfiguration cfg,
                     SearchMapping searchMapping)

Method Detail

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

addFacetFieldName

public void addFacetFieldName(String facetFieldName)

Add a facet field name.

Parameters:

facetFieldName - the name of the faceted field

getFacetFieldNames

public Collection<String> getFacetFieldNames()

addGlobalAnalyzerDef

public void addGlobalAnalyzerDef(AnalyzerDef analyzerDef)

buildLazyAnalyzer

public org.apache.lucene.analysis.Analyzer buildLazyAnalyzer(String name)

getLazyAnalyzers

public List<DelegateNamedAnalyzer> getLazyAnalyzers()

getDefaultNullToken

public String getDefaultNullToken()

getDefaultAnalyzer

public org.apache.lucene.analysis.Analyzer getDefaultAnalyzer()

getDefaultSimilarity

public org.apache.lucene.search.Similarity getDefaultSimilarity()

getLuceneMatchVersion

public org.apache.lucene.util.Version getLuceneMatchVersion()

initLazyAnalyzers

public Map<String,org.apache.lucene.analysis.Analyzer> initLazyAnalyzers()

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