org.hibernate.search.engine.spi

Interface EntityIndexBinding

All Known Subinterfaces:

MutableEntityIndexBinding

All Known Implementing Classes:

DefaultMutableEntityIndexBinding, DynamicShardingEntityIndexBinding

public interface EntityIndexBinding

Specifies the relation and options from an indexed entity to its index(es).

Author:

Sanne Grinovero (C) 2011 Red Hat Inc., Hardy Ferentschik

Method Summary

Methods

Modifier and Type	Method and Description
DocumentBuilderIndexedEntity	getDocumentBuilder()
EntityIndexingInterceptor	getEntityIndexingInterceptor()
FieldCacheCollectorFactory	getIdFieldCacheCollectionFactory()
IndexManager[]	getIndexManagers()
IndexShardingStrategy	getSelectionStrategy()
ShardIdentifierProvider	getShardIdentifierProvider()
Similarity	getSimilarity()
void	postInitialize(Set<Class<?>> indexedClasses) Called once during bootstrapping

Method Detail

getSimilarity

Similarity getSimilarity()

Returns:

the Similarity used to search and index this entity

getSelectionStrategy

IndexShardingStrategy getSelectionStrategy()

Returns:

the sharding strategy

getShardIdentifierProvider

ShardIdentifierProvider getShardIdentifierProvider()

Returns:

the shard identifier provider. Can be null depending on selected IndexShardingStrategy.

getDocumentBuilder

DocumentBuilderIndexedEntity getDocumentBuilder()

Returns:

the document builder for this binding

getIdFieldCacheCollectionFactory

FieldCacheCollectorFactory getIdFieldCacheCollectionFactory()

Returns:

factory for the field caches

postInitialize

void postInitialize(Set<Class<?>> indexedClasses)

Called once during bootstrapping

Parameters:

indexedClasses - set of indexed classes

getIndexManagers

IndexManager[] getIndexManagers()

Returns:

the array of index managers

getEntityIndexingInterceptor

EntityIndexingInterceptor getEntityIndexingInterceptor()

Returns:

the interceptor for indexing operations. Can be null