/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat, Inc. and/or its affiliates or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat, Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.search.engine.spi;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.document.Fieldable;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.Similarity;
import org.hibernate.search.ProjectionConstants;
import org.hibernate.search.annotations.Analyze;
import org.hibernate.search.annotations.Norms;
import org.hibernate.search.engine.impl.AnnotationProcessingHelper;
import org.hibernate.search.engine.impl.LuceneOptionsImpl;
import org.hibernate.search.spi.InstanceInitializer;
import org.hibernate.search.util.impl.ClassLoaderHelper;
import org.hibernate.search.util.impl.ReflectionHelper;
import org.hibernate.search.util.logging.impl.Log;
import org.hibernate.annotations.common.AssertionFailure;
import org.hibernate.annotations.common.reflection.ReflectionManager;
import org.hibernate.annotations.common.reflection.XClass;
import org.hibernate.annotations.common.reflection.XMember;
import org.hibernate.annotations.common.reflection.XProperty;
import org.hibernate.search.SearchException;
import org.hibernate.search.analyzer.Discriminator;
import org.hibernate.search.annotations.CacheFromIndex;
import org.hibernate.search.annotations.DocumentId;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.NumericField;
import org.hibernate.search.annotations.ProvidedId;
import org.hibernate.search.annotations.Store;
import org.hibernate.search.annotations.TermVector;
import org.hibernate.search.backend.AddLuceneWork;
import org.hibernate.search.backend.DeleteLuceneWork;
import org.hibernate.search.backend.LuceneWork;
import org.hibernate.search.backend.UpdateLuceneWork;
import org.hibernate.search.bridge.builtin.impl.TwoWayString2FieldBridgeAdaptor;
import org.hibernate.search.bridge.impl.BridgeFactory;
import org.hibernate.search.bridge.FieldBridge;
import org.hibernate.search.bridge.LuceneOptions;
import org.hibernate.search.bridge.StringBridge;
import org.hibernate.search.bridge.TwoWayFieldBridge;
import org.hibernate.search.bridge.TwoWayStringBridge;
import org.hibernate.search.bridge.builtin.NumericFieldBridge;
import org.hibernate.search.bridge.spi.ConversionContext;
import org.hibernate.search.bridge.util.impl.ContextualExceptionBridgeHelper;
import org.hibernate.search.impl.ConfigContext;
import org.hibernate.search.query.collector.impl.FieldCacheCollectorFactory;
import org.hibernate.search.query.fieldcache.impl.ClassLoadingStrategySelector;
import org.hibernate.search.query.fieldcache.impl.FieldCacheLoadingType;
import org.hibernate.search.util.logging.impl.LoggerFactory;
/**
* Set up and provide a manager for classes which are directly annotated with <code>@Indexed</code>.
*
* @author Gavin King
* @author Emmanuel Bernard
* @author Sylvain Vieujot
* @author Richard Hallier
* @author Hardy Ferentschik
*/
public class DocumentBuilderIndexedEntity<T> extends AbstractDocumentBuilder<T> {
private static final Log log = LoggerFactory.make();
private static final LuceneOptions NULL_EMBEDDED_MARKER_OPTIONS = new LuceneOptionsImpl(
Store.NO,
org.apache.lucene.document.Field.Index.NOT_ANALYZED_NO_NORMS,
org.apache.lucene.document.Field.TermVector.NO,
1F );
/**
* Flag indicating whether <code>@DocumentId</code> was explicitly specified.
*/
private boolean explicitDocumentId = false;
/**
* Flag indicating whether {@link org.apache.lucene.search.Searcher#doc(int, org.apache.lucene.document.FieldSelector)}
* can be used in order to retrieve documents. This is only safe to do if we know that
* all involved bridges are implementing <code>TwoWayStringBridge</code>. See HSEARCH-213.
*/
private boolean allowFieldSelectionInProjection = false;
/**
* The class member used as document id.
*/
private XMember idGetter;
/**
* Name of the document id field.
*/
private String idKeywordName;
/**
* Boost specified on the document id.
*/
private float idBoost = 1f;
/**
* The bridge used for the document id.
*/
private TwoWayFieldBridge idBridge;
/**
* Flag indicating whether there is an explicit id (@DocumentId or @Id) or not. When Search is used as make
* for example using JBoss Cache Searchable the <code>idKeywordName</code> will be provided.
*/
private boolean idProvided;
/**
* The member - if any - annotated with @DocumentId
*/
private XProperty documentIdAnnotatedMember; //FIXME: to remove, needed only for isIdMatchingJpaId()
/**
* The member - if any - annotated with @Id
*/
private XProperty jpaIdAnnotatedMember; //FIXME: to remove, needed only for isIdMatchingJpaId()
/**
* Type of allowed FieldCache usage
*/
private final Set<org.hibernate.search.annotations.FieldCacheType> fieldCacheUsage;
private final String identifierName;
/**
* Which strategy to use to load values from the FieldCache
*/
private final FieldCacheCollectorFactory idFieldCacheCollectorFactory;
/**
* Creates a document builder for entities annotated with <code>@Indexed</code>.
*
* @param clazz The class for which to build a <code>DocumentBuilderContainedEntity</code>
* @param context Handle to default configuration settings
* @param similarity the Similarity implementation set at the related index level
* @param reflectionManager Reflection manager to use for processing the annotations
* @param optimizationBlackList mutable register, keeps track of types on which we need to disable collection events optimizations
* @param instanceInitializer helper class for class object graph navigation
*/
public DocumentBuilderIndexedEntity(XClass clazz, ConfigContext context, Similarity similarity,
ReflectionManager reflectionManager, Set<XClass> optimizationBlackList, InstanceInitializer instanceInitializer) {
super( clazz, context, similarity, reflectionManager, optimizationBlackList, instanceInitializer );
// special case @ProvidedId
ProvidedId provided = findProvidedId( clazz, reflectionManager );
if ( provided != null ) {
idBridge = BridgeFactory.extractTwoWayType( provided.bridge(), clazz, reflectionManager );
idKeywordName = provided.name();
idProvided = true;
}
else if ( context.isProvidedIdImplicit() ) {
idBridge = new TwoWayString2FieldBridgeAdaptor( org.hibernate.search.bridge.builtin.StringBridge.INSTANCE );
idKeywordName = ProvidedId.defaultFieldName;
idProvided = true;
}
if ( idKeywordName == null ) {
throw new SearchException( "No document id in: " + clazz );
}
CacheFromIndex fieldCacheOptions = clazz.getAnnotation( CacheFromIndex.class );
if ( fieldCacheOptions == null ) {
this.fieldCacheUsage = Collections.unmodifiableSet( EnumSet.of( org.hibernate.search.annotations.FieldCacheType.CLASS ) );
}
else {
EnumSet<org.hibernate.search.annotations.FieldCacheType> enabledTypes = EnumSet.noneOf( org.hibernate.search.annotations.FieldCacheType.class );
Collections.addAll( enabledTypes, fieldCacheOptions.value() );
if ( enabledTypes.size() != 1 && enabledTypes.contains( org.hibernate.search.annotations.FieldCacheType.NOTHING ) ) {
throw new SearchException( "CacheFromIndex configured with conflicting parameters:" +
" if FieldCacheType.NOTHING is enabled, no other options can be added" );
}
this.fieldCacheUsage = Collections.unmodifiableSet( enabledTypes );
}
checkAllowFieldSelection();
idFieldCacheCollectorFactory = figureIdFieldCacheUsage();
if ( log.isDebugEnabled() ) {
log.debugf(
"Field selection in projections is set to %b for entity %s.",
allowFieldSelectionInProjection,
clazz
);
}
this.entityState = EntityState.INDEXED;
this.identifierName = idProvided ? null : idGetter.getName();
}
private FieldCacheCollectorFactory figureIdFieldCacheUsage() {
if ( this.fieldCacheUsage.contains( org.hibernate.search.annotations.FieldCacheType.ID ) ) {
FieldCacheLoadingType collectorTypeForId = ClassLoadingStrategySelector.guessAppropriateCollectorType( idBridge );
if ( collectorTypeForId == null ) {
log.cannotExtractValueForIdentifier( this.beanClass );
return null;
}
TwoWayStringBridge twoWayIdStringBridge = ClassLoadingStrategySelector.getTwoWayStringBridge( idBridge );
return new FieldCacheCollectorFactory( getIdKeywordName(), collectorTypeForId, twoWayIdStringBridge );
}
return null;
}
public XMember getIdGetter() {
return idGetter;
}
public FieldCacheCollectorFactory getIdFieldCacheCollectionFactory() {
return idFieldCacheCollectorFactory;
}
protected void documentBuilderSpecificChecks(XProperty member, PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, ConfigContext context, PathsContext pathsContext) {
checkDocumentId( member, propertiesMetadata, isRoot, prefix, context, pathsContext );
}
protected void checkDocumentId(XProperty member, PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, ConfigContext context, PathsContext pathsContext) {
Annotation idAnnotation = getIdAnnotation( member, context );
NumericField numericFieldAnn = member.getAnnotation( NumericField.class );
if ( idAnnotation != null ) {
String attributeName = getIdAttributeName( member, idAnnotation );
if ( pathsContext != null ) {
pathsContext.markEncounteredPath( prefix + attributeName );
}
if ( isRoot ) {
if ( explicitDocumentId ) {
if ( idAnnotation instanceof DocumentId ) {
throw log.duplicateDocumentIdFound( getBeanClass().getName() );
}
else {
//If it's not a DocumentId it's a JPA @Id: ignore it as we already have a @DocumentId
return;
}
}
if ( idAnnotation instanceof DocumentId ) {
explicitDocumentId = true;
}
idKeywordName = prefix + attributeName;
FieldBridge fieldBridge = BridgeFactory.guessType( null, numericFieldAnn, member, reflectionManager );
if ( fieldBridge instanceof TwoWayFieldBridge ) {
idBridge = (TwoWayFieldBridge) fieldBridge;
}
else {
throw new SearchException(
"Bridge for document id does not implement TwoWayFieldBridge: " + member.getName()
);
}
Float boost = AnnotationProcessingHelper.getBoost( member, null );
if ( boost != null) {
idBoost = boost.floatValue();
}
ReflectionHelper.setAccessible( member );
idGetter = member;
}
else {
//component should index their document id
ReflectionHelper.setAccessible( member );
propertiesMetadata.fieldGetters.add( member );
propertiesMetadata.fieldGetterNames.add( member.getName() );
String fieldName = prefix + attributeName;
propertiesMetadata.fieldNames.add( fieldName );
propertiesMetadata.fieldStore.add( Store.YES );
Field.Index index = AnnotationProcessingHelper.getIndex( Index.YES, Analyze.NO, Norms.YES );
propertiesMetadata.fieldIndex.add( index );
propertiesMetadata.fieldTermVectors.add( AnnotationProcessingHelper.getTermVector( TermVector.NO ) );
propertiesMetadata.fieldNullTokens.add( null );
propertiesMetadata.fieldBridges.add( BridgeFactory.guessType( null, null, member, reflectionManager ) );
propertiesMetadata.fieldBoosts.add( AnnotationProcessingHelper.getBoost( member, null ) );
propertiesMetadata.precisionSteps.add( getPrecisionStep( null ) );
propertiesMetadata.dynamicFieldBoosts.add( AnnotationProcessingHelper.getDynamicBoost( member ) );
// property > entity analyzer (no field analyzer)
Analyzer analyzer = AnnotationProcessingHelper.getAnalyzer( member.getAnnotation( org.hibernate.search.annotations.Analyzer.class ), context );
if ( analyzer == null ) {
analyzer = propertiesMetadata.analyzer;
}
if ( analyzer == null ) {
throw new AssertionFailure( "Analyzer should not be undefined" );
}
addToScopedAnalyzer( fieldName, analyzer, index );
}
}
}
/**
* Checks whether the specified property contains an annotation used as document id.
* This can either be an explicit <code>@DocumentId</code> or if no <code>@DocumentId</code> is specified a
* JPA <code>@Id</code> annotation. The check for the JPA annotation is indirectly to avoid a hard dependency
* to Hibernate Annotations.
*
* @param member the property to check for the id annotation.
* @param context Handle to default configuration settings.
*
* @return the annotation used as document id or <code>null</code> if id annotation is specified on the property.
*/
private Annotation getIdAnnotation(XProperty member, ConfigContext context) {
Annotation idAnnotation = null;
// check for explicit DocumentId
DocumentId documentIdAnn = member.getAnnotation( DocumentId.class );
if ( documentIdAnn != null ) {
idAnnotation = documentIdAnn;
documentIdAnnotatedMember = member;
}
// check for JPA @Id
if ( context.isJpaPresent() ) {
Annotation jpaId;
try {
@SuppressWarnings("unchecked")
Class<? extends Annotation> jpaIdClass =
ClassLoaderHelper.classForName( "javax.persistence.Id", ConfigContext.class.getClassLoader() );
jpaId = member.getAnnotation( jpaIdClass );
}
catch ( ClassNotFoundException e ) {
throw new SearchException( "Unable to load @Id.class even though it should be present ?!" );
}
if ( jpaId != null ) {
jpaIdAnnotatedMember = member;
if ( documentIdAnn == null ) {
log.debug( "Found JPA id and using it as document id" );
idAnnotation = jpaId;
}
}
}
return idAnnotation;
}
private ProvidedId findProvidedId(XClass clazz, ReflectionManager reflectionManager) {
ProvidedId id = null;
XClass currentClass = clazz;
while ( id == null && ( !reflectionManager.equals( currentClass, Object.class ) ) ) {
id = currentClass.getAnnotation( ProvidedId.class );
currentClass = currentClass.getSuperclass();
}
return id;
}
public void addWorkToQueue(Class<T> entityClass, T entity, Serializable id, boolean delete, boolean add, List<LuceneWork> queue, ConversionContext contextualBridge) {
String idInString = objectToString( idBridge, idKeywordName, id, contextualBridge );
if ( delete && !add ) {
queue.add( new DeleteLuceneWork( id, idInString, entityClass ) );
}
else if ( add && !delete) {
queue.add( createAddWork( entityClass, entity, id, idInString, this.instanceInitializer, contextualBridge ) );
}
else if ( add && delete ) {
queue.add( createUpdateWork( entityClass, entity, id, idInString, this.instanceInitializer, contextualBridge ) );
}
}
private String objectToString(TwoWayFieldBridge bridge, String fieldName, Object value, ConversionContext conversionContext) {
conversionContext.pushProperty( fieldName );
String stringValue;
try {
stringValue = conversionContext
.setClass( getBeanClass() )
.twoWayConversionContext( bridge )
.objectToString( value );
}
finally {
conversionContext.popProperty();
}
return stringValue;
}
private String objectToString(StringBridge bridge, String fieldName, Object value, ConversionContext conversionContext) {
conversionContext.pushProperty( fieldName );
String stringValue;
try {
stringValue = conversionContext
.setClass( getBeanClass() )
.stringConversionContext( bridge )
.objectToString( value );
}
finally {
conversionContext.popProperty();
}
return stringValue;
}
public AddLuceneWork createAddWork(Class<T> entityClass, T entity, Serializable id, String idInString, InstanceInitializer sessionInitializer, ConversionContext conversionContext) {
Map<String, String> fieldToAnalyzerMap = new HashMap<String, String>();
Document doc = getDocument( entity, id, fieldToAnalyzerMap, sessionInitializer, conversionContext );
final AddLuceneWork addWork;
if ( fieldToAnalyzerMap.isEmpty() ) {
addWork = new AddLuceneWork( id, idInString, entityClass, doc );
}
else {
addWork = new AddLuceneWork( id, idInString, entityClass, doc, fieldToAnalyzerMap );
}
return addWork;
}
public UpdateLuceneWork createUpdateWork(Class<T> entityClass, T entity, Serializable id, String idInString, InstanceInitializer sessionInitializer, ConversionContext contextualBridge) {
Map<String, String> fieldToAnalyzerMap = new HashMap<String, String>();
Document doc = getDocument( entity, id, fieldToAnalyzerMap, sessionInitializer, contextualBridge );
final UpdateLuceneWork addWork;
if ( fieldToAnalyzerMap.isEmpty() ) {
addWork = new UpdateLuceneWork( id, idInString, entityClass, doc );
}
else {
addWork = new UpdateLuceneWork( id, idInString, entityClass, doc, fieldToAnalyzerMap );
}
return addWork;
}
/**
* Builds the Lucene <code>Document</code> for a given entity <code>instance</code> and its <code>id</code>.
*
* @param instance The entity for which to build the matching Lucene <code>Document</code>
* @param id the entity id.
* @param fieldToAnalyzerMap this maps gets populated while generating the <code>Document</code>.
* It allows to specify for any document field a named analyzer to use. This parameter cannot be <code>null</code>.
* @param objectInitializer used to ensure that all objects are initalized
* @param conversionContext a {@link org.hibernate.search.bridge.spi.ConversionContext} object.
* @return The Lucene <code>Document</code> for the specified entity.
*/
public Document getDocument(T instance, Serializable id, Map<String, String> fieldToAnalyzerMap, InstanceInitializer objectInitializer, ConversionContext conversionContext) {
if ( fieldToAnalyzerMap == null ) {
throw new IllegalArgumentException( "fieldToAnalyzerMap cannot be null" );
}
Document doc = new Document();
this.instanceInitializer.getClass( instance );
final Class<?> entityType = objectInitializer.getClass( instance );
doc.setBoost( getMetadata().getClassBoost( instance ) );
// add the class name of the entity to the document
Field classField =
new Field(
ProjectionConstants.OBJECT_CLASS,
entityType.getName(),
Field.Store.YES,
Field.Index.NOT_ANALYZED_NO_NORMS,
Field.TermVector.NO
);
doc.add( classField );
// now add the entity id to the document
LuceneOptions luceneOptions = new LuceneOptionsImpl(
Store.YES,
Field.Index.NOT_ANALYZED_NO_NORMS,
Field.TermVector.NO,
idBoost
);
final FieldBridge contextualizedBridge = conversionContext.oneWayConversionContext( idBridge );
conversionContext.setClass( entityType );
conversionContext.pushProperty( idKeywordName );
try {
contextualizedBridge.set( idKeywordName, id, doc, luceneOptions );
}
finally {
conversionContext.popProperty();
}
// finally add all other document fields
Set<String> processedFieldNames = new HashSet<String>();
buildDocumentFields( instance, doc, getMetadata(), fieldToAnalyzerMap, processedFieldNames, conversionContext, objectInitializer );
return doc;
}
private void buildDocumentFields(Object instance,
Document doc,
PropertiesMetadata propertiesMetadata,
Map<String, String> fieldToAnalyzerMap,
Set<String> processedFieldNames,
ConversionContext conversionContext,
InstanceInitializer objectInitializer) {
// needed for field access: I cannot work in the proxied version
Object unproxiedInstance = unproxy( instance, objectInitializer );
// process the class bridges
for ( int i = 0; i < propertiesMetadata.classBridges.size(); i++ ) {
FieldBridge fb = propertiesMetadata.classBridges.get( i );
final String fieldName = propertiesMetadata.classNames.get( i );
final FieldBridge oneWayConversionContext = conversionContext.oneWayConversionContext( fb );
conversionContext.pushProperty( fieldName );
try {
oneWayConversionContext.set(
fieldName, unproxiedInstance,
doc, propertiesMetadata.getClassLuceneOptions( i )
);
}
finally {
conversionContext.popProperty();
}
}
// process the indexed fields
XMember previousMember = null;
Object currentFieldValue = null;
for ( int i = 0; i < propertiesMetadata.fieldNames.size(); i++ ) {
XMember member = propertiesMetadata.fieldGetters.get( i );
if ( previousMember != member ) {
currentFieldValue = unproxy( ReflectionHelper.getMemberValue( unproxiedInstance, member ),
objectInitializer );
previousMember = member;
if ( member.isCollection() ) {
if ( currentFieldValue instanceof Collection ) {
objectInitializer.initializeCollection( (Collection) currentFieldValue );
}
else if ( currentFieldValue instanceof Map ) {
objectInitializer.initializeMap( (Map) currentFieldValue );
}
}
}
final FieldBridge fieldBridge = propertiesMetadata.fieldBridges.get( i );
final String fieldName = propertiesMetadata.fieldNames.get( i );
final FieldBridge oneWayConversionContext = conversionContext.oneWayConversionContext( fieldBridge );
conversionContext.pushProperty( propertiesMetadata.fieldGetterNames.get( i ) );
try {
oneWayConversionContext.set(
fieldName, currentFieldValue, doc,
propertiesMetadata.getFieldLuceneOptions( i, currentFieldValue )
);
}
finally {
conversionContext.popProperty();
}
}
// allow analyzer override for the fields added by the class and field bridges
allowAnalyzerDiscriminatorOverride(
doc, propertiesMetadata, fieldToAnalyzerMap, processedFieldNames, unproxiedInstance
);
// recursively process embedded objects
for ( int i = 0; i < propertiesMetadata.embeddedGetters.size(); i++ ) {
XMember member = propertiesMetadata.embeddedGetters.get( i );
conversionContext.pushProperty( propertiesMetadata.embeddedFieldNames.get( i ) );
try {
Object value = ReflectionHelper.getMemberValue( unproxiedInstance, member );
//TODO handle boost at embedded level: already stored in propertiesMedatada.boost
if ( value == null ) {
processEmbeddedNullValue( doc, propertiesMetadata, conversionContext, i, member );
continue;
}
PropertiesMetadata embeddedMetadata = propertiesMetadata.embeddedPropertiesMetadata.get( i );
switch ( propertiesMetadata.embeddedContainers.get( i ) ) {
case ARRAY:
Object[] array = objectInitializer.initializeArray( (Object[]) value );
for ( Object arrayValue : array ) {
buildDocumentFields(
arrayValue,
doc,
embeddedMetadata,
fieldToAnalyzerMap,
processedFieldNames,
conversionContext,
objectInitializer
);
}
break;
case COLLECTION:
Collection collection = objectInitializer.initializeCollection( (Collection) value );
for ( Object collectionValue : collection ) {
buildDocumentFields(
collectionValue,
doc,
embeddedMetadata,
fieldToAnalyzerMap,
processedFieldNames,
conversionContext,
objectInitializer
);
}
break;
case MAP:
Map map = objectInitializer.initializeMap( (Map) value );
for ( Object collectionValue : map.values() ) {
buildDocumentFields(
collectionValue,
doc,
embeddedMetadata,
fieldToAnalyzerMap,
processedFieldNames,
conversionContext,
objectInitializer
);
}
break;
case OBJECT:
buildDocumentFields(
value,
doc,
embeddedMetadata,
fieldToAnalyzerMap,
processedFieldNames,
conversionContext,
objectInitializer
);
break;
default:
throw new AssertionFailure(
"Unknown embedded container: "
+ propertiesMetadata.embeddedContainers.get( i )
);
}
}
finally {
conversionContext.popProperty();
}
}
}
private void processEmbeddedNullValue(Document doc, PropertiesMetadata propertiesMetadata, ConversionContext conversionContext, int i, XMember member) {
final String nullMarker = propertiesMetadata.embeddedNullTokens.get( i );
if ( nullMarker != null ) {
String fieldName = propertiesMetadata.embeddedNullFields.get( i );
FieldBridge fieldBridge = propertiesMetadata.embeddedNullFieldBridges.get( i );
final FieldBridge contextualizedBridge = conversionContext.oneWayConversionContext( fieldBridge );
conversionContext.pushProperty( fieldName );
try {
contextualizedBridge.set( fieldName, null, doc, NULL_EMBEDDED_MARKER_OPTIONS );
}
finally {
conversionContext.popProperty();
}
}
}
private Object unproxy(Object instance, InstanceInitializer objectInitializer) {
if ( instance == null )
return null;
return objectInitializer.unproxy( instance );
}
/**
* Allows a analyzer discriminator to override the analyzer used for any field in the Lucene document.
*
* @param doc The Lucene <code>Document</code> which shall be indexed.
* @param propertiesMetadata The metadata for the entity we currently add to the document.
* @param fieldToAnalyzerMap This map contains the actual override data. It is a map between document fields names and
* analyzer definition names. This map will be added to the <code>Work</code> instance and processed at actual indexing time.
* @param processedFieldNames A list of field names we have already processed.
* @param unproxiedInstance The entity we currently "add" to the document.
*/
private void allowAnalyzerDiscriminatorOverride(Document doc, PropertiesMetadata propertiesMetadata, Map<String, String> fieldToAnalyzerMap, Set<String> processedFieldNames, Object unproxiedInstance) {
Discriminator discriminator = propertiesMetadata.discriminator;
if ( discriminator == null ) {
return;
}
Object value = null;
if ( propertiesMetadata.discriminatorGetter != null ) {
value = ReflectionHelper.getMemberValue( unproxiedInstance, propertiesMetadata.discriminatorGetter );
}
// now we give the discriminator the opportunity to specify a analyzer per field level
for ( Object o : doc.getFields() ) {
Fieldable field = (Fieldable) o;
if ( !processedFieldNames.contains( field.name() ) ) {
String analyzerName = discriminator.getAnalyzerDefinitionName( value, unproxiedInstance, field.name() );
if ( analyzerName != null ) {
fieldToAnalyzerMap.put( field.name(), analyzerName );
}
processedFieldNames.add( field.name() );
}
}
}
public String getIdentifierName() {
return identifierName;
}
public boolean allowFieldSelectionInProjection() {
return allowFieldSelectionInProjection;
}
public Set<org.hibernate.search.annotations.FieldCacheType> getFieldCacheOption() {
return fieldCacheUsage;
}
@Deprecated //with no replacement: too expensive to create the conversionContext each time this was needed
public Term getTerm(Serializable id) {
final ConversionContext conversionContext = new ContextualExceptionBridgeHelper();
return new Term( idKeywordName, objectToString( idBridge, idKeywordName, id, conversionContext ) );
}
public TwoWayFieldBridge getIdBridge() {
return idBridge;
}
public String getIdKeywordName() {
return idKeywordName;
}
/**
* Return the id used for indexing if possible
* An IllegalStateException otherwise
* <p/>
* If the id is provided, we can't extract it from the entity
*/
@Override
public Serializable getId(Object entity) {
if ( entity == null || idGetter == null || idProvided ) {
throw new IllegalStateException( "Cannot guess id from entity" );
}
Object unproxiedEntity = this.instanceInitializer.unproxy( entity );
return (Serializable) ReflectionHelper.getMemberValue( unproxiedEntity, idGetter );
}
public String objectToString(String fieldName, Object value, ConversionContext conversionContext) {
if ( fieldName == null ) {
throw new AssertionFailure( "Field name should not be null" );
}
if ( fieldName.equals( idKeywordName ) ) {
return objectToString( idBridge, idKeywordName, value, conversionContext );
}
else {
FieldBridge bridge = getBridge( getMetadata(), fieldName );
if ( bridge != null ) {
final Class<? extends FieldBridge> bridgeClass = bridge.getClass();
if ( TwoWayFieldBridge.class.isAssignableFrom( bridgeClass ) ) {
return objectToString( (TwoWayFieldBridge) bridge, fieldName, value, conversionContext );
}
else if ( StringBridge.class.isAssignableFrom( bridgeClass ) ) {
return objectToString( (StringBridge) bridge, fieldName, value, conversionContext );
}
throw log.fieldBridgeNotTwoWay( bridgeClass, fieldName, getBeanXClass() );
}
}
throw new SearchException( "Unable to find field " + fieldName + " in " + getBeanXClass() );
}
private FieldBridge getBridge(List<String> names, List<FieldBridge> bridges, String fieldName) {
int index = names.indexOf( fieldName );
if ( index != -1 ) {
return bridges.get( index );
}
else {
return null;
}
}
public FieldBridge getBridge(String fieldName) {
return getBridge( getMetadata(), fieldName );
}
private FieldBridge getBridge(PropertiesMetadata metadata, String fieldName) {
//process base fields
FieldBridge fieldBridge = getBridge( metadata.fieldNames, metadata.fieldBridges, fieldName );
if ( fieldBridge != null ) {
return fieldBridge;
}
//process fields of embedded
final int nbrOfEmbeddedObjects = metadata.embeddedPropertiesMetadata.size();
for ( int index = 0; index < nbrOfEmbeddedObjects; index++ ) {
fieldBridge = getBridge( metadata.embeddedPropertiesMetadata.get( index ), fieldName );
if ( fieldBridge != null ) {
return fieldBridge;
}
}
// Process null embedded fields
fieldBridge = getBridge( metadata.embeddedNullFields, metadata.embeddedNullFieldBridges, fieldName );
if ( fieldBridge != null ) {
return fieldBridge;
}
//process class bridges
fieldBridge = getBridge( metadata.classNames, metadata.classBridges, fieldName );
if ( fieldBridge != null ) {
return fieldBridge;
}
return null;
}
/**
* Checks whether all involved bridges are two way string bridges. If so we can optimize document retrieval
* by using <code>FieldSelector</code>. See HSEARCH-213.
*/
private void checkAllowFieldSelection() {
allowFieldSelectionInProjection = true;
if ( !( idBridge instanceof TwoWayStringBridge
|| idBridge instanceof TwoWayString2FieldBridgeAdaptor
|| idBridge instanceof NumericFieldBridge ) ) {
allowFieldSelectionInProjection = false;
return;
}
for ( FieldBridge bridge : getMetadata().fieldBridges ) {
if ( !( bridge instanceof TwoWayStringBridge
|| bridge instanceof TwoWayString2FieldBridgeAdaptor
|| bridge instanceof NumericFieldBridge ) ) {
allowFieldSelectionInProjection = false;
return;
}
}
for ( FieldBridge bridge : getMetadata().classBridges ) {
if ( !( bridge instanceof TwoWayStringBridge
|| bridge instanceof TwoWayString2FieldBridgeAdaptor
|| bridge instanceof NumericFieldBridge ) ) {
allowFieldSelectionInProjection = false;
return;
}
}
}
/**
* Determines the property name for the document id. It is either the name of the property itself or the
* value of the name attribute of the <code>idAnnotation</code>.
*
* @param member the property used as id property.
* @param idAnnotation the id annotation
*
* @return property name to be used as document id.
*/
private String getIdAttributeName(XProperty member, Annotation idAnnotation) {
String name = null;
try {
Method m = idAnnotation.getClass().getMethod( "name" );
name = (String) m.invoke( idAnnotation );
}
catch ( Exception e ) {
// ignore
}
return ReflectionHelper.getAttributeName( member, name );
}
/**
* To be removed, see org.hibernate.search.engine.DocumentBuilderIndexedEntity.isIdMatchingJpaId()
*/
@Override
public boolean requiresProvidedId() {
return this.idProvided;
}
/**
* FIXME remove the need for such a method, we should always be able to rely on Work.id,
* but to respect @DocumentId which is being processed in the DocumentBuilder currently
* finding out which id we need is tricky, and requires helpers method like this one.
*/
@Override
public boolean isIdMatchingJpaId() {
return ( ! idProvided &&
( documentIdAnnotatedMember == null || documentIdAnnotatedMember.equals( jpaIdAnnotatedMember ) )
);
}
}