Package org.hibernate.search.engine

Class DocumentBuilderIndexedEntity<T>

java.lang.Object

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

org.hibernate.search.engine.DocumentBuilderIndexedEntity<T>

All Implemented Interfaces:

DocumentBuilder

public class DocumentBuilderIndexedEntity<T>
extends AbstractDocumentBuilder<T>

Set up and provide a manager for classes which are directly annotated with @Indexed.

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.search.engine.AbstractDocumentBuilder

AbstractDocumentBuilder.PropertiesMetadata

Field Summary

Fields inherited from class org.hibernate.search.engine.AbstractDocumentBuilder

beanClass, beanXClassName, containedInCollectionRoles, entityState, fieldCollectionRoles, indexedEmbeddedCollectionRoles, metadata, reflectionManager

Fields inherited from interface org.hibernate.search.engine.DocumentBuilder

CLASS_FIELDNAME

Constructor Summary

Constructors

Constructor	Description
DocumentBuilderIndexedEntity(XClass clazz, ConfigContext context, DirectoryProviderFactory.DirectoryProviders providerWrapper, ReflectionManager reflectionManager, Set<XClass> optimizationBlackList)	Creates a document builder for entities annotated with @Indexed.

Method Summary

Modifier and Type	Method	Description
void	addWorkToQueue(Class<T> entityClass, T entity, Serializable id, boolean delete, boolean add, boolean batch, List<LuceneWork> queue)
boolean	allowFieldSelectionInProjection()
protected void	checkDocumentId(XProperty member, AbstractDocumentBuilder.PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, ConfigContext context)
AddLuceneWork	createAddWork(Class<T> entityClass, T entity, Serializable id, String idInString, EntityInitializer sessionInitializer, boolean isBatch)
protected void	documentBuilderSpecificChecks(XProperty member, AbstractDocumentBuilder.PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, ConfigContext context)
FieldBridge	getBridge(String fieldName)
DirectoryProvider[]	getDirectoryProviders()
IndexShardingStrategy	getDirectoryProviderSelectionStrategy()
Document	getDocument(T instance, Serializable id, Map<String,String> fieldToAnalyzerMap, EntityInitializer objectInitializer)	Builds the Lucene Document for a given entity instance and its id.
Set<FieldCacheType>	getFieldCacheOption()
Serializable	getId(Object entity)	Return the id used for indexing if possible An IllegalStateException otherwise
TwoWayFieldBridge	getIdBridge()
String	getIdentifierName()
FieldCacheCollectorFactory	getIdFieldCacheCollectionFactory()
XMember	getIdGetter()
String	getIdKeywordName()
Term	getTerm(Serializable id)
String	objectToString(String fieldName, Object value)

Methods inherited from class org.hibernate.search.engine.AbstractDocumentBuilder

addToScopedAnalyzer, appendContainedInWorkForInstance, forceStateInspectionOptimizationsDisabled, getAnalyzer, getAnalyzer, getBeanClass, getBeanXClass, getBoost, getDynamicBoost, getEntityState, getIndex, getMappedSubclasses, getMetadata, getPrecisionStep, getSimilarity, getTermVector, isCollectionRoleExcluded, isDirty, isRoot, postInitialize

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentBuilderIndexedEntity

public DocumentBuilderIndexedEntity(XClass clazz,
 ConfigContext context,
 DirectoryProviderFactory.DirectoryProviders providerWrapper,
 ReflectionManager reflectionManager,
 Set<XClass> optimizationBlackList)

Creates a document builder for entities annotated with @Indexed.

Parameters:

clazz - The class for which to build a DocumentBuilderContainedEntity

context - Handle to default configuration settings

providerWrapper - wrapper for access to directory providers for the underlying Lucene indexes

reflectionManager - Reflection manager to use for processing the annotations

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

Method Details

getIdGetter

public XMember getIdGetter()

getIdFieldCacheCollectionFactory

public FieldCacheCollectorFactory getIdFieldCacheCollectionFactory()

documentBuilderSpecificChecks

protected void documentBuilderSpecificChecks(XProperty member,
 AbstractDocumentBuilder.PropertiesMetadata propertiesMetadata,
 boolean isRoot,
 String prefix,
 ConfigContext context)

Specified by:

documentBuilderSpecificChecks in class AbstractDocumentBuilder<T>

checkDocumentId

protected void checkDocumentId(XProperty member,
 AbstractDocumentBuilder.PropertiesMetadata propertiesMetadata,
 boolean isRoot,
 String prefix,
 ConfigContext context)

addWorkToQueue

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

Specified by:

addWorkToQueue in class AbstractDocumentBuilder<T>

createAddWork

public AddLuceneWork createAddWork(Class<T> entityClass,
 T entity,
 Serializable id,
 String idInString,
 EntityInitializer sessionInitializer,
 boolean isBatch)

getDocument

public Document getDocument(T instance,
 Serializable id,
 Map<String,String> fieldToAnalyzerMap,
 EntityInitializer objectInitializer)

Builds the Lucene Document for a given entity instance and its id.

Parameters:

instance - The entity for which to build the matching Lucene Document

id - the entity id.

fieldToAnalyzerMap - this maps gets populated while generating the Document. It allows to specify for any document field a named analyzer to use. This parameter cannot be null.

objectInitializer -

Returns:

The Lucene Document for the specified entity.

getIdentifierName

public String getIdentifierName()

getDirectoryProviders

public DirectoryProvider[] getDirectoryProviders()

getDirectoryProviderSelectionStrategy

public IndexShardingStrategy getDirectoryProviderSelectionStrategy()

allowFieldSelectionInProjection

public boolean allowFieldSelectionInProjection()

getFieldCacheOption

public Set<FieldCacheType> getFieldCacheOption()

getTerm

public Term getTerm(Serializable id)

getIdBridge

public TwoWayFieldBridge getIdBridge()

getIdKeywordName

public String getIdKeywordName()

getId

public Serializable getId(Object entity)

Return the id used for indexing if possible An IllegalStateException otherwise

If the id is provided, we can't extract it from the entity

Specified by:

getId in class AbstractDocumentBuilder<T>

Parameters:

entity - The entity for which to return the id. Cannot be null.

Returns:

entity id

objectToString

public String objectToString(String fieldName,
 Object value)

getBridge

public FieldBridge getBridge(String fieldName)