org.hibernate.search.engine.spi
Class AbstractDocumentBuilder<T>

java.lang.Object
  org.hibernate.search.engine.spi.AbstractDocumentBuilder<T>

Direct Known Subclasses:

DocumentBuilderContainedEntity, DocumentBuilderIndexedEntity

public abstract class AbstractDocumentBuilder<T>
extends Object

Abstract base class for the document builders.

Author:

Hardy Ferentschik, Davide D'Alto, Sanne Grinovero

Field Summary

protected EntityState

entityState

Constructor Summary

AbstractDocumentBuilder(org.hibernate.annotations.common.reflection.XClass xClass, ConfigContext configContext, org.apache.lucene.search.Similarity similarity, org.hibernate.annotations.common.reflection.ReflectionManager reflectionManager, Set<org.hibernate.annotations.common.reflection.XClass> optimizationBlackList, InstanceInitializer instanceInitializer)
Constructor.

Method Summary

abstract void	addWorkToQueue(Class<T> entityClass, T entity, Serializable id, boolean delete, boolean add, List<LuceneWork> queue, ConversionContext contextualBridge)
void	appendContainedInWorkForInstance(Object instance, WorkPlan workPlan, DepthValidator currentDepth) If we have a work instance we have to check whether the instance to be indexed is contained in any other indexed entities.
void	close() Closes any resource
boolean	collectionChangeRequiresIndexUpdate(String collectionRoleName) Returns true if the collection event is going to affect the index state.
void	forceStateInspectionOptimizationsDisabled() Makes sure isCollectionRoleExcluded will always return false, so that collection update events are always processed.
ScopedAnalyzer	getAnalyzer()
Class<?>	getBeanClass()
org.hibernate.annotations.common.reflection.XClass	getBeanXClass()
EntityState	getEntityState()
abstract Serializable	getId(Object entity) In case of an indexed entity, return the value of it's identifier: what is marked as @Id or @DocumentId; in case the entity uses @ProvidedId, it's illegal to call this method.
protected InstanceInitializer	getInstanceInitializer()
Set<Class<?>>	getMappedSubclasses()
TypeMetadata	getMetadata()
org.apache.lucene.search.Similarity	getSimilarity()
TypeMetadata	getTypeMetadata()
boolean	isCollectionRoleExcluded(String collectionRole) Deprecated. Use collectionChangeRequiresIndexUpdate(String) instead
boolean	isDirty(String[] dirtyPropertyNames) Hibernate entities might be dirty (their state has changed), but none of these changes would effect the the index state.
boolean	isIdMatchingJpaId() To be removed, see org.hibernate.search.engine.DocumentBuilderIndexedEntity.isIdMatchingJpaId()
boolean	isRoot()
void	postInitialize(Set<Class<?>> indexedClasses)
boolean	requiresProvidedId() To be removed, see org.hibernate.search.engine.DocumentBuilderIndexedEntity.isIdMatchingJpaId()

Methods inherited from class java.lang.Object

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

Field Detail

entityState

protected EntityState entityState

Constructor Detail

AbstractDocumentBuilder

public AbstractDocumentBuilder(org.hibernate.annotations.common.reflection.XClass xClass,
                               ConfigContext configContext,
                               org.apache.lucene.search.Similarity similarity,
                               org.hibernate.annotations.common.reflection.ReflectionManager reflectionManager,
                               Set<org.hibernate.annotations.common.reflection.XClass> optimizationBlackList,
                               InstanceInitializer instanceInitializer)

Constructor.

Parameters:

xClass - The class for which to build a document builder

configContext - Handle to default configuration settings

similarity - The index level similarity

reflectionManager - Reflection manager to use for processing the annotations

optimizationBlackList - keeps track of types on which we need to disable collection events optimizations

instanceInitializer - a InstanceInitializer object.

Method Detail

addWorkToQueue

public abstract void addWorkToQueue(Class<T> entityClass,
                                    T entity,
                                    Serializable id,
                                    boolean delete,
                                    boolean add,
                                    List<LuceneWork> queue,
                                    ConversionContext contextualBridge)

getId

public abstract Serializable getId(Object entity)

In case of an indexed entity, return the value of it's identifier: what is marked as @Id or @DocumentId; in case the entity uses @ProvidedId, it's illegal to call this method.

Parameters:

entity - the instance for which to retrieve the id

Returns:

the value, or null if it's not an indexed entity

Throws:

IllegalStateException - when used with a @ProvidedId annotated entity

getTypeMetadata

public TypeMetadata getTypeMetadata()

isRoot

public boolean isRoot()

getBeanClass

public Class<?> getBeanClass()

getBeanXClass

public org.hibernate.annotations.common.reflection.XClass getBeanXClass()

getMetadata

public TypeMetadata getMetadata()

getSimilarity

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

getAnalyzer

public ScopedAnalyzer getAnalyzer()

getEntityState

public EntityState getEntityState()

getMappedSubclasses

public Set<Class<?>> getMappedSubclasses()

postInitialize

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

appendContainedInWorkForInstance

public void appendContainedInWorkForInstance(Object instance,
                                             WorkPlan workPlan,
                                             DepthValidator currentDepth)

If we have a work instance we have to check whether the instance to be indexed is contained in any other indexed entities.

Parameters:

instance - the instance to be indexed

workPlan - the current work plan

currentDepth - the current DepthValidator object used to check the graph traversal

getInstanceInitializer

protected InstanceInitializer getInstanceInitializer()

isDirty

public boolean isDirty(String[] dirtyPropertyNames)

Hibernate entities might be dirty (their state has changed), but none of these changes would effect the the index state. This method will return true if any of changed entity properties identified by their names (dirtyPropertyNames) will effect the index state.

Parameters:

dirtyPropertyNames - array of property names for the changed entity properties, null in case the changed properties cannot be specified.

Returns:

true if the entity changes will effect the index state, false otherwise

Since:

3.4

requiresProvidedId

public boolean requiresProvidedId()

To be removed, see org.hibernate.search.engine.DocumentBuilderIndexedEntity.isIdMatchingJpaId()

Returns:

true if a providedId needs to be provided for indexing

isIdMatchingJpaId

public boolean isIdMatchingJpaId()

To be removed, see org.hibernate.search.engine.DocumentBuilderIndexedEntity.isIdMatchingJpaId()

Returns:

true if @DocumentId and @Id are found on the same property

collectionChangeRequiresIndexUpdate

public boolean collectionChangeRequiresIndexUpdate(String collectionRoleName)

Returns true if the collection event is going to affect the index state. In this case the indexing event can be ignored. false otherwise.

Parameters:

collectionRoleName - a String object.

Returns:

true if an update to the collection identified by the given role name effects the index state, false otherwise.

isCollectionRoleExcluded

public boolean isCollectionRoleExcluded(String collectionRole)

Deprecated. Use collectionChangeRequiresIndexUpdate(String) instead

forceStateInspectionOptimizationsDisabled

public void forceStateInspectionOptimizationsDisabled()

Makes sure isCollectionRoleExcluded will always return false, so that collection update events are always processed.

See Also:

isCollectionRoleExcluded(String)

close

public void close()

Closes any resource