[hibernate-commits] Hibernate SVN: r15092 - in search/trunk: src/java/org/hibernate/search/bridge and 1 other directories.

Author: navssurtani Date: 2008-08-18 08:28:57 -0400 (Mon, 18 Aug 2008) New Revision: 15092 Modified: search/trunk/doc/reference/en/modules/mapping.xml search/trunk/src/java/org/hibernate/search/bridge/BridgeFactory.java search/trunk/src/java/org/hibernate/search/engine/DocumentBuilder.java Log: Finished @ProvidedId documentation in mapping.xml and @ProvidedId can now be set on superclass Modified: search/trunk/doc/reference/en/modules/mapping.xml =================================================================== --- search/trunk/doc/reference/en/modules/mapping.xml 2008-08-15 21:20:15 UTC (rev 15091) +++ search/trunk/doc/reference/en/modules/mapping.xml 2008-08-18 12:28:57 UTC (rev 15092) @@ -1136,4 +1136,35 @@ </section> </section> </section> + + <section id="provided-id"> + <title>Providing your own id</title> + + <para>You can provide your own id for Hibernate Search if you are extending the internals. You will have to generate a unique value so it can be given to Lucene to + be indexed. This will have to be given to Hibernate Search when you create an org.hibernate.search.Work object - the document id is required in the constructor. + </para> + + <section id="@ProvidedId"> + <title>The @ProvidedId annotation</title> + + <para>Unlike conventional Hibernate Search API and @DocumentId, this annotation is used on the class and not a field. You also can provide your own bridge implementation when you put in this annotation by calling the bridge() which is on @ProvidedId. Also, if you annotate a class with @ProvidedId, your subclasses will also get the annotation - but it is not done by using the java.lang.annotations.@Inherited. Be sure however, to <emphasis>not</emphasis> use this annotation with @DocumentId as your system will break. + </para> + + <programlisting> + + @ProvidedId (bridge = org.my.own.package.MyCustomBridge) + @Indexed + public class MyClass{ + + @Field + String MyString; + + ... + + } + + + </programlisting> + </section> + </section> </chapter> \ No newline at end of file Modified: search/trunk/src/java/org/hibernate/search/bridge/BridgeFactory.java =================================================================== --- search/trunk/src/java/org/hibernate/search/bridge/BridgeFactory.java 2008-08-15 21:20:15 UTC (rev 15091) +++ search/trunk/src/java/org/hibernate/search/bridge/BridgeFactory.java 2008-08-18 12:28:57 UTC (rev 15092) @@ -293,11 +293,11 @@ } } catch (Exception e) { - throw new HibernateException( "Unable to instantiate FieldBridge for " + ClassBridge.class.getName(), e ); + throw new HibernateException( "Unable to instantiate FieldBridge for " + org.hibernate.search.annotations.FieldBridge.class.getName(), e ); } } } - if ( bridge == null ) throw new SearchException( "Unable to guess FieldBridge for " + ClassBridge.class.getName() ); + if ( bridge == null ) throw new SearchException( "Unable to guess FieldBridge for " + org.hibernate.search.annotations.FieldBridge.class.getName() ); return bridge; } Modified: search/trunk/src/java/org/hibernate/search/engine/DocumentBuilder.java =================================================================== --- search/trunk/src/java/org/hibernate/search/engine/DocumentBuilder.java 2008-08-15 21:20:15 UTC (rev 15091) +++ search/trunk/src/java/org/hibernate/search/engine/DocumentBuilder.java 2008-08-18 12:28:57 UTC (rev 15092) @@ -67,808 +67,832 @@ * @author Richard Hallier * @author Hardy Ferentschik */ -@SuppressWarnings( "unchecked" ) +@SuppressWarnings("unchecked") public class DocumentBuilder<T> { - private static final Logger log = LoggerFactory.getLogger( DocumentBuilder.class ); + private static final Logger log = LoggerFactory.getLogger(DocumentBuilder.class); - private final PropertiesMetadata rootPropertiesMetadata = new PropertiesMetadata(); - private final XClass beanClass; - private final DirectoryProvider[] directoryProviders; - private final IndexShardingStrategy shardingStrategy; - private String idKeywordName; - private XMember idGetter; - private Float idBoost; - public static final String CLASS_FIELDNAME = "_hibernate_class"; - private TwoWayFieldBridge idBridge; - private Set<Class> mappedSubclasses = new HashSet<Class>(); - private ReflectionManager reflectionManager; - private int level = 0; - private int maxLevel = Integer.MAX_VALUE; - private final ScopedAnalyzer analyzer = new ScopedAnalyzer(); - private Similarity similarity; - private boolean isRoot; - //if composite id, use of (a, b) in ((1,2), (3,4)) fails on most database - private boolean safeFromTupleId; - private boolean idProvided = false; + private final PropertiesMetadata rootPropertiesMetadata = new PropertiesMetadata(); + private final XClass beanClass; + private final DirectoryProvider[] directoryProviders; + private final IndexShardingStrategy shardingStrategy; + private String idKeywordName; + private XMember idGetter; + private Float idBoost; + public static final String CLASS_FIELDNAME = "_hibernate_class"; + private TwoWayFieldBridge idBridge; + private Set<Class> mappedSubclasses = new HashSet<Class>(); + private ReflectionManager reflectionManager; + private int level = 0; + private int maxLevel = Integer.MAX_VALUE; + private final ScopedAnalyzer analyzer = new ScopedAnalyzer(); + private Similarity similarity; + private boolean isRoot; + //if composite id, use of (a, b) in ((1,2), (3,4)) fails on most database + private boolean safeFromTupleId; + private boolean idProvided = false; - public boolean isRoot() { - return isRoot; - } + public boolean isRoot() { + return isRoot; + } - public DocumentBuilder(XClass clazz, InitContext context, DirectoryProvider[] directoryProviders, - IndexShardingStrategy shardingStrategy, ReflectionManager reflectionManager) { - this.beanClass = clazz; - this.directoryProviders = directoryProviders; - this.shardingStrategy = shardingStrategy; - //FIXME get rid of it when boost is stored? - this.reflectionManager = reflectionManager; - this.similarity = context.getDefaultSimilarity(); + public DocumentBuilder(XClass clazz, InitContext context, DirectoryProvider[] directoryProviders, + IndexShardingStrategy shardingStrategy, ReflectionManager reflectionManager) { + this.beanClass = clazz; + this.directoryProviders = directoryProviders; + this.shardingStrategy = shardingStrategy; + //FIXME get rid of it when boost is stored? + this.reflectionManager = reflectionManager; + this.similarity = context.getDefaultSimilarity(); - if ( clazz == null ) throw new AssertionFailure( "Unable to build a DocumentBuilder with a null class" ); - rootPropertiesMetadata.boost = getBoost( clazz ); - rootPropertiesMetadata.analyzer = context.getDefaultAnalyzer(); - Set<XClass> processedClasses = new HashSet<XClass>(); - processedClasses.add( clazz ); - initializeMembers( clazz, rootPropertiesMetadata, true, "", processedClasses, context ); - //processedClasses.remove( clazz ); for the sake of completness - this.analyzer.setGlobalAnalyzer( rootPropertiesMetadata.analyzer ); - if ( idKeywordName == null ) { - // if no DocumentId then check if we have a ProvidedId instead - ProvidedId provided = clazz.getAnnotation( org.hibernate.search.annotations.ProvidedId.class ); - if ( provided == null ) throw new SearchException( "No document id in: " + clazz.getName() ); + if (clazz == null) throw new AssertionFailure("Unable to build a DocumentBuilder with a null class"); + rootPropertiesMetadata.boost = getBoost(clazz); + rootPropertiesMetadata.analyzer = context.getDefaultAnalyzer(); + Set<XClass> processedClasses = new HashSet<XClass>(); + processedClasses.add(clazz); + initializeMembers(clazz, rootPropertiesMetadata, true, "", processedClasses, context); + //processedClasses.remove( clazz ); for the sake of completness + this.analyzer.setGlobalAnalyzer(rootPropertiesMetadata.analyzer); + if (idKeywordName == null) { + // if no DocumentId then check if we have a ProvidedId instead + ProvidedId provided = findProvidedId(clazz); + if (provided == null) throw new SearchException("No document id in: " + clazz.getName()); - idBridge = BridgeFactory.extractTwoWayType(provided.bridge()); - idKeywordName = provided.name(); - } - //if composite id, use of (a, b) in ((1,2)TwoWayString2FieldBridgeAdaptor, (3,4)) fails on most database - //a TwoWayString2FieldBridgeAdaptor is never a composite id - safeFromTupleId = TwoWayString2FieldBridgeAdaptor.class.isAssignableFrom( idBridge.getClass() ); - } + idBridge = BridgeFactory.extractTwoWayType(provided.bridge()); + idKeywordName = provided.name(); + } + //if composite id, use of (a, b) in ((1,2)TwoWayString2FieldBridgeAdaptor, (3,4)) fails on most database + //a TwoWayString2FieldBridgeAdaptor is never a composite id + safeFromTupleId = TwoWayString2FieldBridgeAdaptor.class.isAssignableFrom(idBridge.getClass()); + } - private Analyzer getAnalyzer(XAnnotatedElement annotatedElement, InitContext context) { - org.hibernate.search.annotations.Analyzer analyzerAnn = - annotatedElement.getAnnotation( org.hibernate.search.annotations.Analyzer.class ); - return getAnalyzer( analyzerAnn, context ); - } + private ProvidedId findProvidedId(XClass clazz) { + ProvidedId id = clazz.getAnnotation(ProvidedId.class); + if (id == null) { + if (clazz.getClass().equals(Object.class)) { + // no superclass! + return null; + } + else { + // look at superclass + return findProvidedId(clazz.getSuperclass()); + } + } + else { + return id; + } + } - private Analyzer getAnalyzer(org.hibernate.search.annotations.Analyzer analyzerAnn, InitContext context) { - Class analyzerClass = analyzerAnn == null ? void.class : analyzerAnn.impl(); - if ( analyzerClass == void.class ) { - String definition = analyzerAnn == null ? "" : analyzerAnn.definition(); - if ( StringHelper.isEmpty( definition ) ) { - return null; - } - else { + private Analyzer getAnalyzer(XAnnotatedElement annotatedElement, InitContext context) { + org.hibernate.search.annotations.Analyzer analyzerAnn = + annotatedElement.getAnnotation(org.hibernate.search.annotations.Analyzer.class); + return getAnalyzer(analyzerAnn, context); + } - return context.buildLazyAnalyzer( definition ); - } - } - else { - try { - return (Analyzer) analyzerClass.newInstance(); - } - catch (ClassCastException e) { - throw new SearchException( - "Lucene analyzer does not implement " + Analyzer.class.getName() + ": " + analyzerClass.getName(), e - ); - } - catch (Exception e) { - throw new SearchException( "Failed to instantiate lucene analyzer with type " + analyzerClass.getName(), e ); - } - } - } + private Analyzer getAnalyzer(org.hibernate.search.annotations.Analyzer analyzerAnn, InitContext context) { + Class analyzerClass = analyzerAnn == null ? void.class : analyzerAnn.impl(); + if (analyzerClass == void.class) { + String definition = analyzerAnn == null ? "" : analyzerAnn.definition(); + if (StringHelper.isEmpty(definition)) { + return null; + } + else { - private void initializeMembers(XClass clazz, PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, - Set<XClass> processedClasses, InitContext context) { - List<XClass> hierarchy = new ArrayList<XClass>(); - for (XClass currClass = clazz; currClass != null; currClass = currClass.getSuperclass()) { - hierarchy.add( currClass ); - } - Class similarityClass = null; - for (int index = hierarchy.size() - 1; index >= 0; index--) { - XClass currClass = hierarchy.get( index ); - /** - * Override the default analyzer for the properties if the class hold one - * That's the reason we go down the hierarchy - */ - Analyzer analyzer = getAnalyzer( currClass, context ); + return context.buildLazyAnalyzer(definition); + } + } + else { + try { + return (Analyzer) analyzerClass.newInstance(); + } + catch (ClassCastException e) { + throw new SearchException( + "Lucene analyzer does not implement " + Analyzer.class.getName() + ": " + analyzerClass.getName(), e + ); + } + catch (Exception e) { + throw new SearchException("Failed to instantiate lucene analyzer with type " + analyzerClass.getName(), e); + } + } + } - if ( analyzer != null ) { - propertiesMetadata.analyzer = analyzer; - } - getAnalyzerDefs( currClass, context ); - // Check for any ClassBridges annotation. - ClassBridges classBridgesAnn = currClass.getAnnotation( ClassBridges.class ); - if ( classBridgesAnn != null ) { - ClassBridge[] cbs = classBridgesAnn.value(); - for (ClassBridge cb : cbs) { - bindClassAnnotation( prefix, propertiesMetadata, cb, context ); - } - } + private void initializeMembers(XClass clazz, PropertiesMetadata propertiesMetadata, boolean isRoot, String prefix, + Set<XClass> processedClasses, InitContext context) { + List<XClass> hierarchy = new ArrayList<XClass>(); + for (XClass currClass = clazz; currClass != null; currClass = currClass.getSuperclass()) { + hierarchy.add(currClass); + } + Class similarityClass = null; + for (int index = hierarchy.size() - 1; index >= 0; index--) { + XClass currClass = hierarchy.get(index); + /** + * Override the default analyzer for the properties if the class hold one + * That's the reason we go down the hierarchy + */ + Analyzer analyzer = getAnalyzer(currClass, context); - // Check for any ClassBridge style of annotations. - ClassBridge classBridgeAnn = currClass.getAnnotation( ClassBridge.class ); - if ( classBridgeAnn != null ) { - bindClassAnnotation( prefix, propertiesMetadata, classBridgeAnn, context ); - } + if (analyzer != null) { + propertiesMetadata.analyzer = analyzer; + } + getAnalyzerDefs(currClass, context); + // Check for any ClassBridges annotation. + ClassBridges classBridgesAnn = currClass.getAnnotation(ClassBridges.class); + if (classBridgesAnn != null) { + ClassBridge[] cbs = classBridgesAnn.value(); + for (ClassBridge cb : cbs) { + bindClassAnnotation(prefix, propertiesMetadata, cb, context); + } + } - //Get similarity - //TODO: similarity form @IndexedEmbedded are not taken care of. Exception?? - if ( isRoot ) { - org.hibernate.search.annotations.Similarity similarityAnn = currClass.getAnnotation( org.hibernate.search.annotations.Similarity.class ); - if ( similarityAnn != null ) { - if ( similarityClass != null ) { - throw new SearchException( "Multiple Similarities defined in the same class hierarchy: " + beanClass.getName() ); - } - similarityClass = similarityAnn.impl(); - } - } + // Check for any ClassBridge style of annotations. + ClassBridge classBridgeAnn = currClass.getAnnotation(ClassBridge.class); + if (classBridgeAnn != null) { + bindClassAnnotation(prefix, propertiesMetadata, classBridgeAnn, context); + } - //rejecting non properties (ie regular methods) because the object is loaded from Hibernate, - // so indexing a non property does not make sense - List<XProperty> methods = currClass.getDeclaredProperties( XClass.ACCESS_PROPERTY ); - for (XProperty method : methods) { - initializeMember( method, propertiesMetadata, isRoot, prefix, processedClasses, context ); - } + //Get similarity + //TODO: similarity form @IndexedEmbedded are not taken care of. Exception?? + if (isRoot) { + org.hibernate.search.annotations.Similarity similarityAnn = currClass.getAnnotation(org.hibernate.search.annotations.Similarity.class); + if (similarityAnn != null) { + if (similarityClass != null) { + throw new SearchException("Multiple Similarities defined in the same class hierarchy: " + beanClass.getName()); + } + similarityClass = similarityAnn.impl(); + } + } - List<XProperty> fields = currClass.getDeclaredProperties( XClass.ACCESS_FIELD ); - for (XProperty field : fields) { - initializeMember( field, propertiesMetadata, isRoot, prefix, processedClasses, context ); - } - } - if ( isRoot && similarityClass != null ) { - try { - similarity = (Similarity) similarityClass.newInstance(); - } - catch (Exception e) { - log.error( "Exception attempting to instantiate Similarity '{}' set for {}", - similarityClass.getName(), beanClass.getName() ); - } - } - } + //rejecting non properties (ie regular methods) because the object is loaded from Hibernate, + // so indexing a non property does not make sense + List<XProperty> methods = currClass.getDeclaredProperties(XClass.ACCESS_PROPERTY); + for (XProperty method : methods) { + initializeMember(method, propertiesMetadata, isRoot, prefix, processedClasses, context); + } - private void getAnalyzerDefs(XAnnotatedElement annotatedElement, InitContext context) { - AnalyzerDefs defs = annotatedElement.getAnnotation( AnalyzerDefs.class ); - if ( defs != null ) { - for (AnalyzerDef def : defs.value()) { - context.addAnalyzerDef( def ); - } - } - AnalyzerDef def = annotatedElement.getAnnotation( AnalyzerDef.class ); - context.addAnalyzerDef( def ); - } + List<XProperty> fields = currClass.getDeclaredProperties(XClass.ACCESS_FIELD); + for (XProperty field : fields) { + initializeMember(field, propertiesMetadata, isRoot, prefix, processedClasses, context); + } + } + if (isRoot && similarityClass != null) { + try { + similarity = (Similarity) similarityClass.newInstance(); + } + catch (Exception e) { + log.error("Exception attempting to instantiate Similarity '{}' set for {}", + similarityClass.getName(), beanClass.getName()); + } + } + } - public String getIdentifierName() { - return idGetter.getName(); - } + private void getAnalyzerDefs(XAnnotatedElement annotatedElement, InitContext context) { + AnalyzerDefs defs = annotatedElement.getAnnotation(AnalyzerDefs.class); + if (defs != null) { + for (AnalyzerDef def : defs.value()) { + context.addAnalyzerDef(def); + } + } + AnalyzerDef def = annotatedElement.getAnnotation(AnalyzerDef.class); + context.addAnalyzerDef(def); + } - public Similarity getSimilarity() { - return similarity; - } + public String getIdentifierName() { + return idGetter.getName(); + } - private void initializeMember(XProperty member, PropertiesMetadata propertiesMetadata, boolean isRoot, - String prefix, Set<XClass> processedClasses, InitContext context) { + public Similarity getSimilarity() { + return similarity; + } - DocumentId documentIdAnn = member.getAnnotation( DocumentId.class ); - if ( documentIdAnn != null ) { - if ( isRoot ) { - if ( idKeywordName != null ) { - throw new AssertionFailure( "Two document id assigned: " - + idKeywordName + " and " + BinderHelper.getAttributeName( member, documentIdAnn.name() ) ); - } - idKeywordName = prefix + BinderHelper.getAttributeName( member, documentIdAnn.name() ); - FieldBridge fieldBridge = BridgeFactory.guessType( null, member, reflectionManager ); - if ( fieldBridge instanceof TwoWayFieldBridge ) { - idBridge = (TwoWayFieldBridge) fieldBridge; - } - else { - throw new SearchException( - "Bridge for document id does not implement TwoWayFieldBridge: " + member.getName() ); - } - idBoost = getBoost( member ); - setAccessible( member ); - idGetter = member; - } - else { - //component should index their document id - setAccessible( member ); - propertiesMetadata.fieldGetters.add( member ); - String fieldName = prefix + BinderHelper.getAttributeName( member, documentIdAnn.name() ); - propertiesMetadata.fieldNames.add( fieldName ); - propertiesMetadata.fieldStore.add( getStore( Store.YES ) ); - propertiesMetadata.fieldIndex.add( getIndex( Index.UN_TOKENIZED ) ); - propertiesMetadata.fieldTermVectors.add( getTermVector( TermVector.NO ) ); - propertiesMetadata.fieldBridges.add( BridgeFactory.guessType( null, member, reflectionManager ) ); - // property > entity analyzer (no field analyzer) - Analyzer analyzer = getAnalyzer( member, context ); - if ( analyzer == null ) analyzer = propertiesMetadata.analyzer; - if ( analyzer == null ) throw new AssertionFailure( "Analizer should not be undefined" ); - this.analyzer.addScopedAnalyzer( fieldName, analyzer ); - } - } - { - org.hibernate.search.annotations.Field fieldAnn = - member.getAnnotation( org.hibernate.search.annotations.Field.class ); - if ( fieldAnn != null ) { - bindFieldAnnotation( member, propertiesMetadata, prefix, fieldAnn, context ); - } - } - { - org.hibernate.search.annotations.Fields fieldsAnn = - member.getAnnotation( org.hibernate.search.annotations.Fields.class ); - if ( fieldsAnn != null ) { - for (org.hibernate.search.annotations.Field fieldAnn : fieldsAnn.value()) { - bindFieldAnnotation( member, propertiesMetadata, prefix, fieldAnn, context ); - } - } - } - getAnalyzerDefs( member, context ); + private void initializeMember(XProperty member, PropertiesMetadata propertiesMetadata, boolean isRoot, + String prefix, Set<XClass> processedClasses, InitContext context) { - IndexedEmbedded embeddedAnn = member.getAnnotation( IndexedEmbedded.class ); - if ( embeddedAnn != null ) { - int oldMaxLevel = maxLevel; - int potentialLevel = embeddedAnn.depth() + level; - if ( potentialLevel < 0 ) { - potentialLevel = Integer.MAX_VALUE; - } - maxLevel = potentialLevel > maxLevel ? maxLevel : potentialLevel; - level++; + DocumentId documentIdAnn = member.getAnnotation(DocumentId.class); + if (documentIdAnn != null) { + if (isRoot) { + if (idKeywordName != null) { + throw new AssertionFailure("Two document id assigned: " + + idKeywordName + " and " + BinderHelper.getAttributeName(member, documentIdAnn.name())); + } + idKeywordName = prefix + BinderHelper.getAttributeName(member, documentIdAnn.name()); + FieldBridge fieldBridge = BridgeFactory.guessType(null, member, reflectionManager); + if (fieldBridge instanceof TwoWayFieldBridge) { + idBridge = (TwoWayFieldBridge) fieldBridge; + } + else { + throw new SearchException( + "Bridge for document id does not implement TwoWayFieldBridge: " + member.getName()); + } + idBoost = getBoost(member); + setAccessible(member); + idGetter = member; + } + else { + //component should index their document id + setAccessible(member); + propertiesMetadata.fieldGetters.add(member); + String fieldName = prefix + BinderHelper.getAttributeName(member, documentIdAnn.name()); + propertiesMetadata.fieldNames.add(fieldName); + propertiesMetadata.fieldStore.add(getStore(Store.YES)); + propertiesMetadata.fieldIndex.add(getIndex(Index.UN_TOKENIZED)); + propertiesMetadata.fieldTermVectors.add(getTermVector(TermVector.NO)); + propertiesMetadata.fieldBridges.add(BridgeFactory.guessType(null, member, reflectionManager)); + // property > entity analyzer (no field analyzer) + Analyzer analyzer = getAnalyzer(member, context); + if (analyzer == null) analyzer = propertiesMetadata.analyzer; + if (analyzer == null) throw new AssertionFailure("Analizer should not be undefined"); + this.analyzer.addScopedAnalyzer(fieldName, analyzer); + } + } + { + org.hibernate.search.annotations.Field fieldAnn = + member.getAnnotation(org.hibernate.search.annotations.Field.class); + if (fieldAnn != null) { + bindFieldAnnotation(member, propertiesMetadata, prefix, fieldAnn, context); + } + } + { + org.hibernate.search.annotations.Fields fieldsAnn = + member.getAnnotation(org.hibernate.search.annotations.Fields.class); + if (fieldsAnn != null) { + for (org.hibernate.search.annotations.Field fieldAnn : fieldsAnn.value()) { + bindFieldAnnotation(member, propertiesMetadata, prefix, fieldAnn, context); + } + } + } + getAnalyzerDefs(member, context); - XClass elementClass; - if ( void.class == embeddedAnn.targetElement() ) { - elementClass = member.getElementClass(); - } - else { - elementClass = reflectionManager.toXClass( embeddedAnn.targetElement() ); - } - if ( maxLevel == Integer.MAX_VALUE //infinite - && processedClasses.contains( elementClass ) ) { - throw new SearchException( - "Circular reference. Duplicate use of " - + elementClass.getName() - + " in root entity " + beanClass.getName() - + "#" + buildEmbeddedPrefix( prefix, embeddedAnn, member ) - ); - } - if ( level <= maxLevel ) { - processedClasses.add( elementClass ); //push + IndexedEmbedded embeddedAnn = member.getAnnotation(IndexedEmbedded.class); + if (embeddedAnn != null) { + int oldMaxLevel = maxLevel; + int potentialLevel = embeddedAnn.depth() + level; + if (potentialLevel < 0) { + potentialLevel = Integer.MAX_VALUE; + } + maxLevel = potentialLevel > maxLevel ? maxLevel : potentialLevel; + level++; - setAccessible( member ); - propertiesMetadata.embeddedGetters.add( member ); - PropertiesMetadata metadata = new PropertiesMetadata(); - propertiesMetadata.embeddedPropertiesMetadata.add( metadata ); - metadata.boost = getBoost( member ); - //property > entity analyzer - Analyzer analyzer = getAnalyzer( member, context ); - metadata.analyzer = analyzer != null ? analyzer : propertiesMetadata.analyzer; - String localPrefix = buildEmbeddedPrefix( prefix, embeddedAnn, member ); - initializeMembers( elementClass, metadata, false, localPrefix, processedClasses, context ); - /** - * We will only index the "expected" type but that's OK, HQL cannot do downcasting either - */ - if ( member.isArray() ) { - propertiesMetadata.embeddedContainers.add( PropertiesMetadata.Container.ARRAY ); - } - else if ( member.isCollection() ) { - if ( Map.class.equals( member.getCollectionClass() ) ) { - //hum subclasses etc etc?? - propertiesMetadata.embeddedContainers.add( PropertiesMetadata.Container.MAP ); - } - else { - propertiesMetadata.embeddedContainers.add( PropertiesMetadata.Container.COLLECTION ); - } - } - else { - propertiesMetadata.embeddedContainers.add( PropertiesMetadata.Container.OBJECT ); - } + XClass elementClass; + if (void.class == embeddedAnn.targetElement()) { + elementClass = member.getElementClass(); + } + else { + elementClass = reflectionManager.toXClass(embeddedAnn.targetElement()); + } + if (maxLevel == Integer.MAX_VALUE //infinite + && processedClasses.contains(elementClass)) { + throw new SearchException( + "Circular reference. Duplicate use of " + + elementClass.getName() + + " in root entity " + beanClass.getName() + + "#" + buildEmbeddedPrefix(prefix, embeddedAnn, member) + ); + } + if (level <= maxLevel) { + processedClasses.add(elementClass); //push - processedClasses.remove( elementClass ); //pop - } - else if ( log.isTraceEnabled() ) { - String localPrefix = buildEmbeddedPrefix( prefix, embeddedAnn, member ); - log.trace( "depth reached, ignoring {}", localPrefix ); - } + setAccessible(member); + propertiesMetadata.embeddedGetters.add(member); + PropertiesMetadata metadata = new PropertiesMetadata(); + propertiesMetadata.embeddedPropertiesMetadata.add(metadata); + metadata.boost = getBoost(member); + //property > entity analyzer + Analyzer analyzer = getAnalyzer(member, context); + metadata.analyzer = analyzer != null ? analyzer : propertiesMetadata.analyzer; + String localPrefix = buildEmbeddedPrefix(prefix, embeddedAnn, member); + initializeMembers(elementClass, metadata, false, localPrefix, processedClasses, context); + /** + * We will only index the "expected" type but that's OK, HQL cannot do downcasting either + */ + if (member.isArray()) { + propertiesMetadata.embeddedContainers.add(PropertiesMetadata.Container.ARRAY); + } + else + if (member.isCollection()) { + if (Map.class.equals(member.getCollectionClass())) { + //hum subclasses etc etc?? + propertiesMetadata.embeddedContainers.add(PropertiesMetadata.Container.MAP); + } + else { + propertiesMetadata.embeddedContainers.add(PropertiesMetadata.Container.COLLECTION); + } + } + else { + propertiesMetadata.embeddedContainers.add(PropertiesMetadata.Container.OBJECT); + } - level--; - maxLevel = oldMaxLevel; //set back the the old max level - } + processedClasses.remove(elementClass); //pop + } + else + if (log.isTraceEnabled()) { + String localPrefix = buildEmbeddedPrefix(prefix, embeddedAnn, member); + log.trace("depth reached, ignoring {}", localPrefix); + } - ContainedIn containedAnn = member.getAnnotation( ContainedIn.class ); - if ( containedAnn != null ) { - setAccessible( member ); - propertiesMetadata.containedInGetters.add( member ); - } - } + level--; + maxLevel = oldMaxLevel; //set back the the old max level + } - private void bindClassAnnotation(String prefix, PropertiesMetadata propertiesMetadata, ClassBridge ann, InitContext context) { - //FIXME name should be prefixed - String fieldName = prefix + ann.name(); - propertiesMetadata.classNames.add( fieldName ); - propertiesMetadata.classStores.add( getStore( ann.store() ) ); - propertiesMetadata.classIndexes.add( getIndex( ann.index() ) ); - propertiesMetadata.classTermVectors.add( getTermVector( ann.termVector() ) ); - propertiesMetadata.classBridges.add( BridgeFactory.extractType( ann ) ); - propertiesMetadata.classBoosts.add( ann.boost().value() ); + ContainedIn containedAnn = member.getAnnotation(ContainedIn.class); + if (containedAnn != null) { + setAccessible(member); + propertiesMetadata.containedInGetters.add(member); + } + } - Analyzer analyzer = getAnalyzer( ann.analyzer(), context ); - if ( analyzer == null ) analyzer = propertiesMetadata.analyzer; - if ( analyzer == null ) throw new AssertionFailure( "Analyzer should not be undefined" ); - this.analyzer.addScopedAnalyzer( fieldName, analyzer ); - } + private void bindClassAnnotation(String prefix, PropertiesMetadata propertiesMetadata, ClassBridge ann, InitContext context) { + //FIXME name should be prefixed + String fieldName = prefix + ann.name(); + propertiesMetadata.classNames.add(fieldName); + propertiesMetadata.classStores.add(getStore(ann.store())); + propertiesMetadata.classIndexes.add(getIndex(ann.index())); + propertiesMetadata.classTermVectors.add(getTermVector(ann.termVector())); + propertiesMetadata.classBridges.add(BridgeFactory.extractType(ann)); + propertiesMetadata.classBoosts.add(ann.boost().value()); - private void bindFieldAnnotation(XProperty member, PropertiesMetadata propertiesMetadata, String prefix, org.hibernate.search.annotations.Field fieldAnn, InitContext context) { - setAccessible( member ); - propertiesMetadata.fieldGetters.add( member ); - String fieldName = prefix + BinderHelper.getAttributeName( member, fieldAnn.name() ); - propertiesMetadata.fieldNames.add( fieldName ); - propertiesMetadata.fieldStore.add( getStore( fieldAnn.store() ) ); - propertiesMetadata.fieldIndex.add( getIndex( fieldAnn.index() ) ); - propertiesMetadata.fieldTermVectors.add( getTermVector( fieldAnn.termVector() ) ); - propertiesMetadata.fieldBridges.add( BridgeFactory.guessType( fieldAnn, member, reflectionManager ) ); + Analyzer analyzer = getAnalyzer(ann.analyzer(), context); + if (analyzer == null) analyzer = propertiesMetadata.analyzer; + if (analyzer == null) throw new AssertionFailure("Analyzer should not be undefined"); + this.analyzer.addScopedAnalyzer(fieldName, analyzer); + } - // Field > property > entity analyzer - Analyzer analyzer = getAnalyzer( fieldAnn.analyzer(), context ); - if ( analyzer == null ) analyzer = getAnalyzer( member, context ); - if ( analyzer == null ) analyzer = propertiesMetadata.analyzer; - if ( analyzer == null ) throw new AssertionFailure( "Analizer should not be undefined" ); - this.analyzer.addScopedAnalyzer( fieldName, analyzer ); - } + private void bindFieldAnnotation(XProperty member, PropertiesMetadata propertiesMetadata, String prefix, org.hibernate.search.annotations.Field fieldAnn, InitContext context) { + setAccessible(member); + propertiesMetadata.fieldGetters.add(member); + String fieldName = prefix + BinderHelper.getAttributeName(member, fieldAnn.name()); + propertiesMetadata.fieldNames.add(fieldName); + propertiesMetadata.fieldStore.add(getStore(fieldAnn.store())); + propertiesMetadata.fieldIndex.add(getIndex(fieldAnn.index())); + propertiesMetadata.fieldTermVectors.add(getTermVector(fieldAnn.termVector())); + propertiesMetadata.fieldBridges.add(BridgeFactory.guessType(fieldAnn, member, reflectionManager)); - private String buildEmbeddedPrefix(String prefix, IndexedEmbedded embeddedAnn, XProperty member) { - String localPrefix = prefix; - if ( ".".equals( embeddedAnn.prefix() ) ) { - //default to property name - localPrefix += member.getName() + '.'; - } - else { - localPrefix += embeddedAnn.prefix(); - } - return localPrefix; - } + // Field > property > entity analyzer + Analyzer analyzer = getAnalyzer(fieldAnn.analyzer(), context); + if (analyzer == null) analyzer = getAnalyzer(member, context); + if (analyzer == null) analyzer = propertiesMetadata.analyzer; + if (analyzer == null) throw new AssertionFailure("Analizer should not be undefined"); + this.analyzer.addScopedAnalyzer(fieldName, analyzer); + } - private Field.Store getStore(Store store) { - switch ( store ) { - case NO: - return Field.Store.NO; - case YES: - return Field.Store.YES; - case COMPRESS: - return Field.Store.COMPRESS; - default: - throw new AssertionFailure( "Unexpected Store: " + store ); - } - } + private String buildEmbeddedPrefix(String prefix, IndexedEmbedded embeddedAnn, XProperty member) { + String localPrefix = prefix; + if (".".equals(embeddedAnn.prefix())) { + //default to property name + localPrefix += member.getName() + '.'; + } + else { + localPrefix += embeddedAnn.prefix(); + } + return localPrefix; + } - private Field.TermVector getTermVector(TermVector vector) { - switch ( vector ) { - case NO: - return Field.TermVector.NO; - case YES: - return Field.TermVector.YES; - case WITH_OFFSETS: - return Field.TermVector.WITH_OFFSETS; - case WITH_POSITIONS: - return Field.TermVector.WITH_POSITIONS; - case WITH_POSITION_OFFSETS: - return Field.TermVector.WITH_POSITIONS_OFFSETS; - default: - throw new AssertionFailure( "Unexpected TermVector: " + vector ); - } - } + private Field.Store getStore(Store store) { + switch (store) { + case NO: + return Field.Store.NO; + case YES: + return Field.Store.YES; + case COMPRESS: + return Field.Store.COMPRESS; + default: + throw new AssertionFailure("Unexpected Store: " + store); + } + } - private Field.Index getIndex(Index index) { - switch ( index ) { - case NO: - return Field.Index.NO; - case NO_NORMS: - return Field.Index.NO_NORMS; - case TOKENIZED: - return Field.Index.TOKENIZED; - case UN_TOKENIZED: - return Field.Index.UN_TOKENIZED; - default: - throw new AssertionFailure( "Unexpected Index: " + index ); - } - } + private Field.TermVector getTermVector(TermVector vector) { + switch (vector) { + case NO: + return Field.TermVector.NO; + case YES: + return Field.TermVector.YES; + case WITH_OFFSETS: + return Field.TermVector.WITH_OFFSETS; + case WITH_POSITIONS: + return Field.TermVector.WITH_POSITIONS; + case WITH_POSITION_OFFSETS: + return Field.TermVector.WITH_POSITIONS_OFFSETS; + default: + throw new AssertionFailure("Unexpected TermVector: " + vector); + } + } - private Float getBoost(XAnnotatedElement element) { - if ( element == null ) return null; - Boost boost = element.getAnnotation( Boost.class ); - return boost != null ? - boost.value() : - null; - } + private Field.Index getIndex(Index index) { + switch (index) { + case NO: + return Field.Index.NO; + case NO_NORMS: + return Field.Index.NO_NORMS; + case TOKENIZED: + return Field.Index.TOKENIZED; + case UN_TOKENIZED: + return Field.Index.UN_TOKENIZED; + default: + throw new AssertionFailure("Unexpected Index: " + index); + } + } - private Object getMemberValue(Object bean, XMember getter) { - Object value; - try { - value = getter.invoke( bean ); - } - catch (Exception e) { - throw new IllegalStateException( "Could not get property value", e ); - } - return value; - } + private Float getBoost(XAnnotatedElement element) { + if (element == null) return null; + Boost boost = element.getAnnotation(Boost.class); + return boost != null ? + boost.value() : + null; + } - //TODO could we use T instead of EntityClass? - public void addWorkToQueue(Class entityClass, T entity, Serializable id, WorkType workType, List<LuceneWork> queue, SearchFactoryImplementor searchFactoryImplementor) { - //TODO with the caller loop we are in a n^2: optimize it using a HashMap for work recognition - for (LuceneWork luceneWork : queue) { - //any work on the same entity should be ignored - if ( luceneWork.getEntityClass() == entityClass - ) { - Serializable currentId = luceneWork.getId(); - if ( currentId != null && currentId.equals( id ) ) { //find a way to use Type.equals(x,y) - return; - } - //TODO do something to avoid multiple PURGE ALL and OPTIMIZE - } + private Object getMemberValue(Object bean, XMember getter) { + Object value; + try { + value = getter.invoke(bean); + } + catch (Exception e) { + throw new IllegalStateException("Could not get property value", e); + } + return value; + } - } - boolean searchForContainers = false; - String idInString = idBridge.objectToString( id ); - if ( workType == WorkType.ADD ) { - Document doc = getDocument( entity, id ); - queue.add( new AddLuceneWork( id, idInString, entityClass, doc ) ); - searchForContainers = true; - } - else if ( workType == WorkType.DELETE || workType == WorkType.PURGE ) { - queue.add( new DeleteLuceneWork( id, idInString, entityClass ) ); - } - else if ( workType == WorkType.PURGE_ALL ) { - queue.add( new PurgeAllLuceneWork( entityClass ) ); - } - else if ( workType == WorkType.UPDATE || workType == WorkType.COLLECTION ) { - Document doc = getDocument( entity, id ); - /** - * even with Lucene 2.1, use of indexWriter to update is not an option - * We can only delete by term, and the index doesn't have a term that - * uniquely identify the entry. - * But essentially the optimization we are doing is the same Lucene is doing, the only extra cost is the - * double file opening. - */ - queue.add( new DeleteLuceneWork( id, idInString, entityClass ) ); - queue.add( new AddLuceneWork( id, idInString, entityClass, doc ) ); - searchForContainers = true; - } - else if ( workType == WorkType.INDEX ) { - Document doc = getDocument( entity, id ); - queue.add( new DeleteLuceneWork( id, idInString, entityClass ) ); - LuceneWork work = new AddLuceneWork( id, idInString, entityClass, doc ); - work.setBatch( true ); - queue.add( work ); - searchForContainers = true; - } + //TODO could we use T instead of EntityClass? + public void addWorkToQueue(Class entityClass, T entity, Serializable id, WorkType workType, List<LuceneWork> queue, SearchFactoryImplementor searchFactoryImplementor) { + //TODO with the caller loop we are in a n^2: optimize it using a HashMap for work recognition + for (LuceneWork luceneWork : queue) { + //any work on the same entity should be ignored + if (luceneWork.getEntityClass() == entityClass + ) { + Serializable currentId = luceneWork.getId(); + if (currentId != null && currentId.equals(id)) { //find a way to use Type.equals(x,y) + return; + } + //TODO do something to avoid multiple PURGE ALL and OPTIMIZE + } - else { - throw new AssertionFailure( "Unknown WorkType: " + workType ); - } + } + boolean searchForContainers = false; + String idInString = idBridge.objectToString(id); + if (workType == WorkType.ADD) { + Document doc = getDocument(entity, id); + queue.add(new AddLuceneWork(id, idInString, entityClass, doc)); + searchForContainers = true; + } + else + if (workType == WorkType.DELETE || workType == WorkType.PURGE) { + queue.add(new DeleteLuceneWork(id, idInString, entityClass)); + } + else + if (workType == WorkType.PURGE_ALL) { + queue.add(new PurgeAllLuceneWork(entityClass)); + } + else + if (workType == WorkType.UPDATE || workType == WorkType.COLLECTION) { + Document doc = getDocument(entity, id); + /** + * even with Lucene 2.1, use of indexWriter to update is not an option + * We can only delete by term, and the index doesn't have a term that + * uniquely identify the entry. + * But essentially the optimization we are doing is the same Lucene is doing, the only extra cost is the + * double file opening. + */ + queue.add(new DeleteLuceneWork(id, idInString, entityClass)); + queue.add(new AddLuceneWork(id, idInString, entityClass, doc)); + searchForContainers = true; + } + else + if (workType == WorkType.INDEX) { + Document doc = getDocument(entity, id); + queue.add(new DeleteLuceneWork(id, idInString, entityClass)); + LuceneWork work = new AddLuceneWork(id, idInString, entityClass, doc); + work.setBatch(true); + queue.add(work); + searchForContainers = true; + } - /** - * When references are changed, either null or another one, we expect dirty checking to be triggered (both sides - * have to be updated) - * When the internal object is changed, we apply the {Add|Update}Work on containedIns - */ - if ( searchForContainers ) { - processContainedIn( entity, queue, rootPropertiesMetadata, searchFactoryImplementor ); - } - } + else { + throw new AssertionFailure("Unknown WorkType: " + workType); + } - private void processContainedIn(Object instance, List<LuceneWork> queue, PropertiesMetadata metadata, SearchFactoryImplementor searchFactoryImplementor) { - for (int i = 0; i < metadata.containedInGetters.size(); i++) { - XMember member = metadata.containedInGetters.get( i ); - Object value = getMemberValue( instance, member ); - if ( value == null ) continue; + /** + * When references are changed, either null or another one, we expect dirty checking to be triggered (both sides + * have to be updated) + * When the internal object is changed, we apply the {Add|Update}Work on containedIns + */ + if (searchForContainers) { + processContainedIn(entity, queue, rootPropertiesMetadata, searchFactoryImplementor); + } + } - if ( member.isArray() ) { - for (Object arrayValue : (Object[]) value) { - //highly inneficient but safe wrt the actual targeted class - Class valueClass = Hibernate.getClass( arrayValue ); - DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get( valueClass ); - if ( builder == null ) continue; - processContainedInValue( arrayValue, queue, valueClass, builder, searchFactoryImplementor ); - } - } - else if ( member.isCollection() ) { - Collection collection; - if ( Map.class.equals( member.getCollectionClass() ) ) { - //hum - collection = ( (Map) value ).values(); - } - else { - collection = (Collection) value; - } - for (Object collectionValue : collection) { - //highly inneficient but safe wrt the actual targeted class - Class valueClass = Hibernate.getClass( collectionValue ); - DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get( valueClass ); - if ( builder == null ) continue; - processContainedInValue( collectionValue, queue, valueClass, builder, searchFactoryImplementor ); - } - } - else { - Class valueClass = Hibernate.getClass( value ); - DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get( valueClass ); - if ( builder == null ) continue; - processContainedInValue( value, queue, valueClass, builder, searchFactoryImplementor ); - } - } - //an embedded cannot have a useful @ContainedIn (no shared reference) - //do not walk through them - } + private void processContainedIn(Object instance, List<LuceneWork> queue, PropertiesMetadata metadata, SearchFactoryImplementor searchFactoryImplementor) { + for (int i = 0; i < metadata.containedInGetters.size(); i++) { + XMember member = metadata.containedInGetters.get(i); + Object value = getMemberValue(instance, member); + if (value == null) continue; - private void processContainedInValue(Object value, List<LuceneWork> queue, Class valueClass, - DocumentBuilder builder, SearchFactoryImplementor searchFactoryImplementor) { - Serializable id = (Serializable) builder.getMemberValue( value, builder.idGetter ); - builder.addWorkToQueue( valueClass, value, id, WorkType.UPDATE, queue, searchFactoryImplementor ); - } + if (member.isArray()) { + for (Object arrayValue : (Object[]) value) { + //highly inneficient but safe wrt the actual targeted class + Class valueClass = Hibernate.getClass(arrayValue); + DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get(valueClass); + if (builder == null) continue; + processContainedInValue(arrayValue, queue, valueClass, builder, searchFactoryImplementor); + } + } + else + if (member.isCollection()) { + Collection collection; + if (Map.class.equals(member.getCollectionClass())) { + //hum + collection = ((Map) value).values(); + } + else { + collection = (Collection) value; + } + for (Object collectionValue : collection) { + //highly inneficient but safe wrt the actual targeted class + Class valueClass = Hibernate.getClass(collectionValue); + DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get(valueClass); + if (builder == null) continue; + processContainedInValue(collectionValue, queue, valueClass, builder, searchFactoryImplementor); + } + } + else { + Class valueClass = Hibernate.getClass(value); + DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get(valueClass); + if (builder == null) continue; + processContainedInValue(value, queue, valueClass, builder, searchFactoryImplementor); + } + } + //an embedded cannot have a useful @ContainedIn (no shared reference) + //do not walk through them + } - public Document getDocument(T instance, Serializable id) { - Document doc = new Document(); - XClass instanceClass = reflectionManager.toXClass( Hibernate.getClass( instance ) ); - if ( rootPropertiesMetadata.boost != null ) { - doc.setBoost( rootPropertiesMetadata.boost ); - } - { - Field classField = - new Field( CLASS_FIELDNAME, instanceClass.getName(), Field.Store.YES, Field.Index.UN_TOKENIZED, Field.TermVector.NO ); - doc.add( classField ); - LuceneOptions luceneOptions = new LuceneOptions( Field.Store.YES, - Field.Index.UN_TOKENIZED, Field.TermVector.NO, idBoost ); - idBridge.set( idKeywordName, id, doc, luceneOptions ); - } - buildDocumentFields( instance, doc, rootPropertiesMetadata ); - return doc; - } + private void processContainedInValue(Object value, List<LuceneWork> queue, Class valueClass, + DocumentBuilder builder, SearchFactoryImplementor searchFactoryImplementor) { + Serializable id = (Serializable) builder.getMemberValue(value, builder.idGetter); + builder.addWorkToQueue(valueClass, value, id, WorkType.UPDATE, queue, searchFactoryImplementor); + } - private void buildDocumentFields(Object instance, Document doc, PropertiesMetadata propertiesMetadata) { - if ( instance == null ) return; - //needed for field access: I cannot work in the proxied version - Object unproxiedInstance = unproxy( instance ); - for (int i = 0; i < propertiesMetadata.classBridges.size(); i++) { - FieldBridge fb = propertiesMetadata.classBridges.get( i ); - fb.set( propertiesMetadata.classNames.get( i ), unproxiedInstance, - doc, propertiesMetadata.getClassLuceneOptions( i ) ); - } - for (int i = 0; i < propertiesMetadata.fieldNames.size(); i++) { - XMember member = propertiesMetadata.fieldGetters.get( i ); - Object value = getMemberValue( unproxiedInstance, member ); - propertiesMetadata.fieldBridges.get( i ).set( - propertiesMetadata.fieldNames.get( i ), value, doc, - propertiesMetadata.getFieldLuceneOptions( i, getBoost( member ) ) ); - } - for (int i = 0; i < propertiesMetadata.embeddedGetters.size(); i++) { - XMember member = propertiesMetadata.embeddedGetters.get( i ); - Object value = getMemberValue( unproxiedInstance, member ); - //TODO handle boost at embedded level: already stored in propertiesMedatada.boost + public Document getDocument(T instance, Serializable id) { + Document doc = new Document(); + XClass instanceClass = reflectionManager.toXClass(Hibernate.getClass(instance)); + if (rootPropertiesMetadata.boost != null) { + doc.setBoost(rootPropertiesMetadata.boost); + } + { + Field classField = + new Field(CLASS_FIELDNAME, instanceClass.getName(), Field.Store.YES, Field.Index.UN_TOKENIZED, Field.TermVector.NO); + doc.add(classField); + LuceneOptions luceneOptions = new LuceneOptions(Field.Store.YES, + Field.Index.UN_TOKENIZED, Field.TermVector.NO, idBoost); + idBridge.set(idKeywordName, id, doc, luceneOptions); + } + buildDocumentFields(instance, doc, rootPropertiesMetadata); + return doc; + } - if ( value == null ) continue; - PropertiesMetadata embeddedMetadata = propertiesMetadata.embeddedPropertiesMetadata.get( i ); - switch ( propertiesMetadata.embeddedContainers.get( i ) ) { - case ARRAY: - for (Object arrayValue : (Object[]) value) { - buildDocumentFields( arrayValue, doc, embeddedMetadata ); - } - break; - case COLLECTION: - for (Object collectionValue : (Collection) value) { - buildDocumentFields( collectionValue, doc, embeddedMetadata ); - } - break; - case MAP: - for (Object collectionValue : ( (Map) value ).values()) { - buildDocumentFields( collectionValue, doc, embeddedMetadata ); - } - break; - case OBJECT: - buildDocumentFields( value, doc, embeddedMetadata ); - break; - default: - throw new AssertionFailure( "Unknown embedded container: " - + propertiesMetadata.embeddedContainers.get( i ) ); - } - } - } + private void buildDocumentFields(Object instance, Document doc, PropertiesMetadata propertiesMetadata) { + if (instance == null) return; + //needed for field access: I cannot work in the proxied version + Object unproxiedInstance = unproxy(instance); + for (int i = 0; i < propertiesMetadata.classBridges.size(); i++) { + FieldBridge fb = propertiesMetadata.classBridges.get(i); + fb.set(propertiesMetadata.classNames.get(i), unproxiedInstance, + doc, propertiesMetadata.getClassLuceneOptions(i)); + } + for (int i = 0; i < propertiesMetadata.fieldNames.size(); i++) { + XMember member = propertiesMetadata.fieldGetters.get(i); + Object value = getMemberValue(unproxiedInstance, member); + propertiesMetadata.fieldBridges.get(i).set( + propertiesMetadata.fieldNames.get(i), value, doc, + propertiesMetadata.getFieldLuceneOptions(i, getBoost(member))); + } + for (int i = 0; i < propertiesMetadata.embeddedGetters.size(); i++) { + XMember member = propertiesMetadata.embeddedGetters.get(i); + Object value = getMemberValue(unproxiedInstance, member); + //TODO handle boost at embedded level: already stored in propertiesMedatada.boost - private Object unproxy(Object value) { - //FIXME this service should be part of Core? - if ( value instanceof HibernateProxy ) { - // .getImplementation() initializes the data by side effect - value = ( (HibernateProxy) value ).getHibernateLazyInitializer() - .getImplementation(); - } - return value; - } + if (value == null) continue; + PropertiesMetadata embeddedMetadata = propertiesMetadata.embeddedPropertiesMetadata.get(i); + switch (propertiesMetadata.embeddedContainers.get(i)) { + case ARRAY: + for (Object arrayValue : (Object[]) value) { + buildDocumentFields(arrayValue, doc, embeddedMetadata); + } + break; + case COLLECTION: + for (Object collectionValue : (Collection) value) { + buildDocumentFields(collectionValue, doc, embeddedMetadata); + } + break; + case MAP: + for (Object collectionValue : ((Map) value).values()) { + buildDocumentFields(collectionValue, doc, embeddedMetadata); + } + break; + case OBJECT: + buildDocumentFields(value, doc, embeddedMetadata); + break; + default: + throw new AssertionFailure("Unknown embedded container: " + + propertiesMetadata.embeddedContainers.get(i)); + } + } + } - public Term getTerm(Serializable id) { - if ( idProvided ) { - return new Term( idKeywordName, (String) id ); - } + private Object unproxy(Object value) { + //FIXME this service should be part of Core? + if (value instanceof HibernateProxy) { + // .getImplementation() initializes the data by side effect + value = ((HibernateProxy) value).getHibernateLazyInitializer() + .getImplementation(); + } + return value; + } - return new Term( idKeywordName, idBridge.objectToString( id ) ); - } + public Term getTerm(Serializable id) { + if (idProvided) { + return new Term(idKeywordName, (String) id); + } - public DirectoryProvider[] getDirectoryProviders() { - return directoryProviders; - } + return new Term(idKeywordName, idBridge.objectToString(id)); + } - public IndexShardingStrategy getDirectoryProviderSelectionStrategy() { - return shardingStrategy; - } + public DirectoryProvider[] getDirectoryProviders() { + return directoryProviders; + } - public Analyzer getAnalyzer() { - return analyzer; - } + public IndexShardingStrategy getDirectoryProviderSelectionStrategy() { + return shardingStrategy; + } - private static void setAccessible(XMember member) { - if ( !Modifier.isPublic( member.getModifiers() ) ) { - member.setAccessible( true ); - } - } + public Analyzer getAnalyzer() { + return analyzer; + } - public TwoWayFieldBridge getIdBridge() { - return idBridge; - } + private static void setAccessible(XMember member) { + if (!Modifier.isPublic(member.getModifiers())) { + member.setAccessible(true); + } + } - public String getIdKeywordName() { - return idKeywordName; - } + public TwoWayFieldBridge getIdBridge() { + return idBridge; + } - public static Class getDocumentClass(Document document) { - String className = document.get( DocumentBuilder.CLASS_FIELDNAME ); - try { - return ReflectHelper.classForName( className ); - } - catch (ClassNotFoundException e) { - throw new SearchException( "Unable to load indexed class: " + className, e ); - } - } + public String getIdKeywordName() { + return idKeywordName; + } - public static Serializable getDocumentId(SearchFactoryImplementor searchFactoryImplementor, Class clazz, Document document) { - DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get( clazz ); - if ( builder == null ) throw new SearchException( "No Lucene configuration set up for: " + clazz.getName() ); - return (Serializable) builder.getIdBridge().get( builder.getIdKeywordName(), document ); - } + public static Class getDocumentClass(Document document) { + String className = document.get(DocumentBuilder.CLASS_FIELDNAME); + try { + return ReflectHelper.classForName(className); + } + catch (ClassNotFoundException e) { + throw new SearchException("Unable to load indexed class: " + className, e); + } + } - public static Object[] getDocumentFields(SearchFactoryImplementor searchFactoryImplementor, Class clazz, Document document, String[] fields) { - DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get( clazz ); - if ( builder == null ) throw new SearchException( "No Lucene configuration set up for: " + clazz.getName() ); - final int fieldNbr = fields.length; - Object[] result = new Object[fieldNbr]; + public static Serializable getDocumentId(SearchFactoryImplementor searchFactoryImplementor, Class clazz, Document document) { + DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get(clazz); + if (builder == null) throw new SearchException("No Lucene configuration set up for: " + clazz.getName()); + return (Serializable) builder.getIdBridge().get(builder.getIdKeywordName(), document); + } - if ( builder.idKeywordName != null ) { - populateResult( builder.idKeywordName, builder.idBridge, Field.Store.YES, fields, result, document ); - } + public static Object[] getDocumentFields(SearchFactoryImplementor searchFactoryImplementor, Class clazz, Document document, String[] fields) { + DocumentBuilder builder = searchFactoryImplementor.getDocumentBuilders().get(clazz); + if (builder == null) throw new SearchException("No Lucene configuration set up for: " + clazz.getName()); + final int fieldNbr = fields.length; + Object[] result = new Object[fieldNbr]; - final PropertiesMetadata metadata = builder.rootPropertiesMetadata; - processFieldsForProjection( metadata, fields, result, document ); - return result; - } + if (builder.idKeywordName != null) { + populateResult(builder.idKeywordName, builder.idBridge, Field.Store.YES, fields, result, document); + } - private static void processFieldsForProjection(PropertiesMetadata metadata, String[] fields, Object[] result, Document document) { - final int nbrFoEntityFields = metadata.fieldNames.size(); - for (int index = 0; index < nbrFoEntityFields; index++) { - populateResult( metadata.fieldNames.get( index ), - metadata.fieldBridges.get( index ), - metadata.fieldStore.get( index ), - fields, - result, - document - ); - } - final int nbrOfEmbeddedObjects = metadata.embeddedPropertiesMetadata.size(); - for (int index = 0; index < nbrOfEmbeddedObjects; index++) { - //there is nothing we can do for collections - if ( metadata.embeddedContainers.get( index ) == PropertiesMetadata.Container.OBJECT ) { - processFieldsForProjection( metadata.embeddedPropertiesMetadata.get( index ), fields, result, document ); - } - } - } + final PropertiesMetadata metadata = builder.rootPropertiesMetadata; + processFieldsForProjection(metadata, fields, result, document); + return result; + } - private static void populateResult(String fieldName, FieldBridge fieldBridge, Field.Store store, - String[] fields, Object[] result, Document document) { - int matchingPosition = getFieldPosition( fields, fieldName ); - if ( matchingPosition != -1 ) { - //TODO make use of an isTwoWay() method - if ( store != Field.Store.NO && TwoWayFieldBridge.class.isAssignableFrom( fieldBridge.getClass() ) ) { - result[matchingPosition] = ( (TwoWayFieldBridge) fieldBridge ).get( fieldName, document ); - if ( log.isTraceEnabled() ) { - log.trace( "Field {} projected as {}", fieldName, result[matchingPosition] ); - } - } - else { - if ( store == Field.Store.NO ) { - throw new SearchException( "Projecting an unstored field: " + fieldName ); - } - else { - throw new SearchException( "FieldBridge is not a TwoWayFieldBridge: " + fieldBridge.getClass() ); - } - } - } - } + private static void processFieldsForProjection(PropertiesMetadata metadata, String[] fields, Object[] result, Document document) { + final int nbrFoEntityFields = metadata.fieldNames.size(); + for (int index = 0; index < nbrFoEntityFields; index++) { + populateResult(metadata.fieldNames.get(index), + metadata.fieldBridges.get(index), + metadata.fieldStore.get(index), + fields, + result, + document + ); + } + final int nbrOfEmbeddedObjects = metadata.embeddedPropertiesMetadata.size(); + for (int index = 0; index < nbrOfEmbeddedObjects; index++) { + //there is nothing we can do for collections + if (metadata.embeddedContainers.get(index) == PropertiesMetadata.Container.OBJECT) { + processFieldsForProjection(metadata.embeddedPropertiesMetadata.get(index), fields, result, document); + } + } + } - private static int getFieldPosition(String[] fields, String fieldName) { - int fieldNbr = fields.length; - for (int index = 0; index < fieldNbr; index++) { - if ( fieldName.equals( fields[index] ) ) return index; - } - return -1; - } + private static void populateResult(String fieldName, FieldBridge fieldBridge, Field.Store store, + String[] fields, Object[] result, Document document) { + int matchingPosition = getFieldPosition(fields, fieldName); + if (matchingPosition != -1) { + //TODO make use of an isTwoWay() method + if (store != Field.Store.NO && TwoWayFieldBridge.class.isAssignableFrom(fieldBridge.getClass())) { + result[matchingPosition] = ((TwoWayFieldBridge) fieldBridge).get(fieldName, document); + if (log.isTraceEnabled()) { + log.trace("Field {} projected as {}", fieldName, result[matchingPosition]); + } + } + else { + if (store == Field.Store.NO) { + throw new SearchException("Projecting an unstored field: " + fieldName); + } + else { + throw new SearchException("FieldBridge is not a TwoWayFieldBridge: " + fieldBridge.getClass()); + } + } + } + } - public void postInitialize(Set<Class> indexedClasses) { - //this method does not requires synchronization - Class plainClass = reflectionManager.toClass( beanClass ); - Set<Class> tempMappedSubclasses = new HashSet<Class>(); - //together with the caller this creates a o(2), but I think it's still faster than create the up hierarchy for each class - for (Class currentClass : indexedClasses) { - if ( plainClass.isAssignableFrom( currentClass ) ) tempMappedSubclasses.add( currentClass ); - } - this.mappedSubclasses = Collections.unmodifiableSet( tempMappedSubclasses ); - Class superClass = plainClass.getSuperclass(); - this.isRoot = true; - while ( superClass != null ) { - if ( indexedClasses.contains( superClass ) ) { - this.isRoot = false; - break; - } - superClass = superClass.getSuperclass(); - } - } + private static int getFieldPosition(String[] fields, String fieldName) { + int fieldNbr = fields.length; + for (int index = 0; index < fieldNbr; index++) { + if (fieldName.equals(fields[index])) return index; + } + return -1; + } + public void postInitialize(Set<Class> indexedClasses) { + //this method does not requires synchronization + Class plainClass = reflectionManager.toClass(beanClass); + Set<Class> tempMappedSubclasses = new HashSet<Class>(); + //together with the caller this creates a o(2), but I think it's still faster than create the up hierarchy for each class + for (Class currentClass : indexedClasses) { + if (plainClass.isAssignableFrom(currentClass)) tempMappedSubclasses.add(currentClass); + } + this.mappedSubclasses = Collections.unmodifiableSet(tempMappedSubclasses); + Class superClass = plainClass.getSuperclass(); + this.isRoot = true; + while (superClass != null) { + if (indexedClasses.contains(superClass)) { + this.isRoot = false; + break; + } + superClass = superClass.getSuperclass(); + } + } - public Set<Class> getMappedSubclasses() { - return mappedSubclasses; - } - /** - * Make sure to return false if there is a risk of composite id - * if composite id, use of (a, b) in ((1,2), (3,4)) fails on most database - */ - public boolean isSafeFromTupleId() { - return safeFromTupleId; - } + public Set<Class> getMappedSubclasses() { + return mappedSubclasses; + } - /** - * Wrapper class containing all the meta data extracted out of the entities. - */ - private static class PropertiesMetadata { - public Float boost; - public Analyzer analyzer; - public final List<String> fieldNames = new ArrayList<String>(); - public final List<XMember> fieldGetters = new ArrayList<XMember>(); - public final List<FieldBridge> fieldBridges = new ArrayList<FieldBridge>(); - public final List<Field.Store> fieldStore = new ArrayList<Field.Store>(); - public final List<Field.Index> fieldIndex = new ArrayList<Field.Index>(); - public final List<Field.TermVector> fieldTermVectors = new ArrayList<Field.TermVector>(); - public final List<XMember> embeddedGetters = new ArrayList<XMember>(); - public final List<PropertiesMetadata> embeddedPropertiesMetadata = new ArrayList<PropertiesMetadata>(); - public final List<Container> embeddedContainers = new ArrayList<Container>(); - public final List<XMember> containedInGetters = new ArrayList<XMember>(); - public final List<String> classNames = new ArrayList<String>(); - public final List<Field.Store> classStores = new ArrayList<Field.Store>(); - public final List<Field.Index> classIndexes = new ArrayList<Field.Index>(); - public final List<FieldBridge> classBridges = new ArrayList<FieldBridge>(); - public final List<Field.TermVector> classTermVectors = new ArrayList<Field.TermVector>(); - public final List<Float> classBoosts = new ArrayList<Float>(); + /** + * Make sure to return false if there is a risk of composite id + * if composite id, use of (a, b) in ((1,2), (3,4)) fails on most database + */ + public boolean isSafeFromTupleId() { + return safeFromTupleId; + } - public enum Container { - OBJECT, - COLLECTION, - MAP, - ARRAY - } + /** + * Wrapper class containing all the meta data extracted out of the entities. + */ + private static class PropertiesMetadata { + public Float boost; + public Analyzer analyzer; + public final List<String> fieldNames = new ArrayList<String>(); + public final List<XMember> fieldGetters = new ArrayList<XMember>(); + public final List<FieldBridge> fieldBridges = new ArrayList<FieldBridge>(); + public final List<Field.Store> fieldStore = new ArrayList<Field.Store>(); + public final List<Field.Index> fieldIndex = new ArrayList<Field.Index>(); + public final List<Field.TermVector> fieldTermVectors = new ArrayList<Field.TermVector>(); + public final List<XMember> embeddedGetters = new ArrayList<XMember>(); + public final List<PropertiesMetadata> embeddedPropertiesMetadata = new ArrayList<PropertiesMetadata>(); + public final List<Container> embeddedContainers = new ArrayList<Container>(); + public final List<XMember> containedInGetters = new ArrayList<XMember>(); + public final List<String> classNames = new ArrayList<String>(); + public final List<Field.Store> classStores = new ArrayList<Field.Store>(); + public final List<Field.Index> classIndexes = new ArrayList<Field.Index>(); + public final List<FieldBridge> classBridges = new ArrayList<FieldBridge>(); + public final List<Field.TermVector> classTermVectors = new ArrayList<Field.TermVector>(); + public final List<Float> classBoosts = new ArrayList<Float>(); - private LuceneOptions getClassLuceneOptions(int i) { - LuceneOptions options = new LuceneOptions( classStores.get( i ), - classIndexes.get( i ), classTermVectors.get( i ), classBoosts.get( i ) ); - return options; - } + public enum Container { + OBJECT, + COLLECTION, + MAP, + ARRAY + } - private LuceneOptions getFieldLuceneOptions(int i, Float boost) { - LuceneOptions options = new LuceneOptions( fieldStore.get( i ), - fieldIndex.get( i ), fieldTermVectors.get( i ), boost ); - return options; - } - } + private LuceneOptions getClassLuceneOptions(int i) { + LuceneOptions options = new LuceneOptions(classStores.get(i), + classIndexes.get(i), classTermVectors.get(i), classBoosts.get(i)); + return options; + } + + private LuceneOptions getFieldLuceneOptions(int i, Float boost) { + LuceneOptions options = new LuceneOptions(fieldStore.get(i), + fieldIndex.get(i), fieldTermVectors.get(i), boost); + return options; + } + } }