org.hibernate.search.engine.impl

Class ReflectionReplacingSearchConfiguration

java.lang.Object

org.hibernate.search.engine.impl.ReflectionReplacingSearchConfiguration

All Implemented Interfaces:

SearchConfiguration

public final class ReflectionReplacingSearchConfiguration
extends Object
implements SearchConfiguration

Wraps another SearchConfiguration to override its ReflectionManager

Since:

4.1

Author:

Sanne Grinovero

Constructor Summary

Constructors

Constructor and Description
ReflectionReplacingSearchConfiguration(org.hibernate.annotations.common.reflection.ReflectionManager reflectionManager, SearchConfiguration searchConfiguration) Create a new SearchConfiguration which returns the same values as the provided SearchConfiguration instance, with the exception of getReflectionManager() which will return the constructor defined ReflectionManager.

Method Summary

Modifier and Type	Method and Description
ClassLoaderService	getClassLoaderService()
Class<?>	getClassMapping(String name) Returns a Class from a String parameter.
Iterator<Class<?>>	getClassMappings() Returns an iterator over the list of indexed classes
InstanceInitializer	getInstanceInitializer() Returns the initializer to be used to initialize potentially lazy entities or collections.
SearchMapping	getProgrammaticMapping()
Properties	getProperties() Gets properties as a java.util.Properties object.
String	getProperty(String propertyName) Gets a configuration property from its name or null if not present
Map<Class<? extends Service>,Object>	getProvidedServices() Return the provided services.
org.hibernate.annotations.common.reflection.ReflectionManager	getReflectionManager() Returns a reflection manager if already available in the environment null otherwise
boolean	isDeleteByTermEnforced()
boolean	isIdProvidedImplicit()
boolean	isIndexMetadataComplete()
boolean	isJPAAnnotationsProcessingEnabled()
boolean	isMultitenancyEnabled()
boolean	isTransactionManagerExpected() By default Hibernate Search expects to execute in the context of a transaction, and will log warning when certain operations are executed out of such a scope.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.cfg.spi.SearchConfiguration

getBeanResolver

Constructor Detail

ReflectionReplacingSearchConfiguration

public ReflectionReplacingSearchConfiguration(org.hibernate.annotations.common.reflection.ReflectionManager reflectionManager,
                                              SearchConfiguration searchConfiguration)

Create a new SearchConfiguration which returns the same values as the provided SearchConfiguration instance, with the exception of getReflectionManager() which will return the constructor defined ReflectionManager.

Parameters:

reflectionManager - the current reflection manager

searchConfiguration - the search configuration

Method Detail

getClassMappings

public Iterator<Class<?>> getClassMappings()

Description copied from interface: SearchConfiguration

Returns an iterator over the list of indexed classes

Specified by:

getClassMappings in interface SearchConfiguration

Returns:

iterator of indexed classes.

getClassMapping

public Class<?> getClassMapping(String name)

Description copied from interface: SearchConfiguration

Returns a Class from a String parameter.

Specified by:

getClassMapping in interface SearchConfiguration

Parameters:

name - the class name as string

Returns:

corresponding class instance

getProperty

public String getProperty(String propertyName)

Description copied from interface: SearchConfiguration

Gets a configuration property from its name or null if not present

Specified by:

getProperty in interface SearchConfiguration

Parameters:

propertyName - - as a String.

Returns:

the property as a String

getProperties

public Properties getProperties()

Description copied from interface: SearchConfiguration

Gets properties as a java.util.Properties object.

Specified by:

getProperties in interface SearchConfiguration

Returns:

a java.util.Properties object.

See Also:

object

getReflectionManager

public org.hibernate.annotations.common.reflection.ReflectionManager getReflectionManager()

Description copied from interface: SearchConfiguration

Returns a reflection manager if already available in the environment null otherwise

Specified by:

getReflectionManager in interface SearchConfiguration

Returns:

ReflectionManager

getProgrammaticMapping

public SearchMapping getProgrammaticMapping()

Specified by:

getProgrammaticMapping in interface SearchConfiguration

Returns:

the programmatic configuration or null

getProvidedServices

public Map<Class<? extends Service>,Object> getProvidedServices()

Description copied from interface: SearchConfiguration

Return the provided services. These services are passed untouched by Hibernate Search. Provided services have priority over managed services (ie the ones using the service locator pattern).

Specified by:

getProvidedServices in interface SearchConfiguration

Returns:

a map of service roles to service instances

isTransactionManagerExpected

public boolean isTransactionManagerExpected()

Description copied from interface: SearchConfiguration

By default Hibernate Search expects to execute in the context of a transaction, and will log warning when certain operations are executed out of such a scope.

Specified by:

isTransactionManagerExpected in interface SearchConfiguration

Returns:

when returning false Search will avoid logging such warnings.

getInstanceInitializer

public InstanceInitializer getInstanceInitializer()

Description copied from interface: SearchConfiguration

Returns the initializer to be used to initialize potentially lazy entities or collections.

Specified by:

getInstanceInitializer in interface SearchConfiguration

Returns:

the initializer to be used to initialize potentially lazy entities or collections.

isIndexMetadataComplete

public boolean isIndexMetadataComplete()

Specified by:

isIndexMetadataComplete in interface SearchConfiguration

Returns:

true if it is safe to assume that the information we have about index metadata is accurate. This should be set to false for example if the index could contain Documents related to types not known to this SearchFactory instance.

isDeleteByTermEnforced

public boolean isDeleteByTermEnforced()

Specified by:

isDeleteByTermEnforced in interface SearchConfiguration

Returns:

true if regardless of isIndexMetadataComplete and the number of types present in the index it is safe to delete by term given that the underlying store guarantees uniqueness of ids

isIdProvidedImplicit

public boolean isIdProvidedImplicit()

Specified by:

isIdProvidedImplicit in interface SearchConfiguration

Returns:

true if we should treat indexed entities as implicitly annotated with a ProvidedId, if no other Id is specified.

getClassLoaderService

public ClassLoaderService getClassLoaderService()

Specified by:

getClassLoaderService in interface SearchConfiguration

Returns:

a classloader service for this configuration of Search. Access to the service is via the ServiceManager.getClassLoaderService()

isMultitenancyEnabled

public boolean isMultitenancyEnabled()

Specified by:

isMultitenancyEnabled in interface SearchConfiguration

Returns:

true if multitenancy should be enabled. When in doubt, this should return true.

isJPAAnnotationsProcessingEnabled

public boolean isJPAAnnotationsProcessingEnabled()

Specified by:

isJPAAnnotationsProcessingEnabled in interface SearchConfiguration

Returns:

true if the Hibernate Search mapping should look for JPA annotations to affect the mapping. Disable this if the JPA API is not available, or to ignore them. Ignoring them implies to ignore, among others, the javax.persistence.Id annotation, which implies the primary identifiers will require explicit mapping over the "provided id" mechanism or the use of DocumentId.