Skip to content

Commit

Permalink
HSEARCH-3438 Uniform marker mapping reference annotation
Browse files Browse the repository at this point in the history
  • Loading branch information
fax4ever authored and yrodiere committed Jan 30, 2019
1 parent b46be36 commit 06b879c
Show file tree
Hide file tree
Showing 9 changed files with 71 additions and 52 deletions.
Expand Up @@ -26,7 +26,7 @@
import org.hibernate.search.mapper.pojo.bridge.PropertyBridge;
import org.hibernate.search.mapper.pojo.bridge.binding.PropertyBridgeBindingContext;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeRef;
import org.hibernate.search.mapper.pojo.bridge.mapping.AnnotationMarkerBuilder;
Expand Down Expand Up @@ -256,7 +256,7 @@ public void setText(String text) {

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.FIELD})
@MarkerMapping(builder = @MarkerMappingBuilderReference(type = CustomMarker.Builder.class))
@MarkerMapping(builder = @MarkerMappingRef(builderType = CustomMarker.Builder.class))
private @interface CustomMarkerAnnotation {
}

Expand Down
Expand Up @@ -19,7 +19,7 @@
import org.hibernate.search.mapper.pojo.bridge.PropertyBridge;
import org.hibernate.search.mapper.pojo.bridge.binding.PropertyBridgeBindingContext;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeRef;
import org.hibernate.search.mapper.pojo.bridge.mapping.AnnotationMarkerBuilder;
Expand Down Expand Up @@ -221,7 +221,7 @@ public void setText(String text) {

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.FIELD})
@MarkerMapping(builder = @MarkerMappingBuilderReference(type = CustomMarker.Builder.class))
@MarkerMapping(builder = @MarkerMappingRef(builderType = CustomMarker.Builder.class))
private @interface CustomMarkerAnnotation {
}

Expand Down
Expand Up @@ -23,7 +23,7 @@
import org.hibernate.search.mapper.pojo.bridge.binding.PropertyBridgeBindingContext;
import org.hibernate.search.mapper.pojo.bridge.binding.TypeBridgeBindingContext;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.TypeBridgeMapping;
Expand Down Expand Up @@ -402,7 +402,7 @@ public Integer getId() {

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
@MarkerMapping(builder = @MarkerMappingBuilderReference)
@MarkerMapping(builder = @MarkerMappingRef)
private @interface MarkerAnnotationWithEmptyMarkerMapping {
}

Expand Down
Expand Up @@ -14,15 +14,15 @@

import org.hibernate.search.mapper.pojo.bridge.builtin.spatial.impl.LatitudeMarker;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;

/**
* Mark the property hosting the latitude of a specific spatial coordinate.
* The property must be of type {@code Double} or {@code double}.
*
* @author Nicolas Helleringer
*/
@MarkerMapping(builder = @MarkerMappingBuilderReference(type = LatitudeMarker.Builder.class))
@MarkerMapping(builder = @MarkerMappingRef(builderType = LatitudeMarker.Builder.class))
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD, ElementType.FIELD } )
@Documented
Expand Down
Expand Up @@ -14,15 +14,15 @@

import org.hibernate.search.mapper.pojo.bridge.builtin.spatial.impl.LongitudeMarker;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;

/**
* Mark the property hosting the longitude of a specific spatial coordinate.
* The property must be of type {@code Double} or {@code double}.
*
* @author Nicolas Helleringer
*/
@MarkerMapping(builder = @MarkerMappingBuilderReference(type = LongitudeMarker.Builder.class))
@MarkerMapping(builder = @MarkerMappingRef(builderType = LongitudeMarker.Builder.class))
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD, ElementType.FIELD } )
@Documented
Expand Down
Expand Up @@ -20,6 +20,12 @@
@Retention(RetentionPolicy.RUNTIME)
public @interface MarkerMapping {

MarkerMappingBuilderReference builder();
/**
* Define a marker mapper builder
*
* @see MarkerMappingRef
* @return A reference to the marker mapping builder.
*/
MarkerMappingRef builder();

}

This file was deleted.

@@ -0,0 +1,50 @@
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.mapper.pojo.bridge.declaration;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.hibernate.search.mapper.pojo.bridge.mapping.AnnotationMarkerBuilder;
import org.hibernate.search.mapper.pojo.bridge.mapping.MarkerBuilder;

/**
* Reference a marker mapping builder in a {@link MarkerMapping}.
* <p>
* Reference can be obtained using either a name or a type.
* <p>
* Each time the mapped annotation is encountered, an instance of the marker mapping builder will be created.
* The builder will be passed the annotation through its {@link AnnotationMarkerBuilder#initialize(Annotation)} method,
* and then the marker will be retrieved by calling {@link MarkerBuilder#build(org.hibernate.search.mapper.pojo.bridge.mapping.MarkerBuildContext)}.
* <p>
* Marker mapped this way can be parameterized:
* the marker mapping will be able to take any attribute of the mapped annotation into account
* in its {@link AnnotationMarkerBuilder#initialize(Annotation)} method.
*
* @author Yoann Rodiere
*/
@Documented
@Target({}) // Only used as a component in other annotations
@Retention(RetentionPolicy.RUNTIME)
public @interface MarkerMappingRef {

String builderName() default "";

Class<? extends AnnotationMarkerBuilder<?>> builderType() default UndefinedBuilderImplementationType.class;

/**
* Class used as a marker for the default value of the {@link #builderType()} attribute.
*/
abstract class UndefinedBuilderImplementationType implements AnnotationMarkerBuilder<Annotation> {
private UndefinedBuilderImplementationType() {
}
}
}

Expand Up @@ -20,7 +20,7 @@
import org.hibernate.search.mapper.pojo.bridge.TypeBridge;
import org.hibernate.search.mapper.pojo.bridge.ValueBridge;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingBuilderReference;
import org.hibernate.search.mapper.pojo.bridge.declaration.MarkerMappingRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeMapping;
import org.hibernate.search.mapper.pojo.bridge.declaration.PropertyBridgeRef;
import org.hibernate.search.mapper.pojo.bridge.declaration.RoutingKeyBridgeMapping;
Expand Down Expand Up @@ -113,13 +113,13 @@ else if ( extractors.length == 1 && ContainerExtractorRef.UndefinedContainerExtr

<A extends Annotation> MarkerBuilder createMarkerBuilder(A annotation) {
MarkerMapping markerMapping = annotation.annotationType().getAnnotation( MarkerMapping.class );
MarkerMappingBuilderReference markerBuilderReferenceAnnotation = markerMapping.builder();
MarkerMappingRef markerBuilderReferenceAnnotation = markerMapping.builder();

return new AnnotationInitializingBeanDelegatingMarkerBuilder<>(
toBeanReference(
AnnotationMarkerBuilder.class,
MarkerMappingBuilderReference.UndefinedImplementationType.class,
markerBuilderReferenceAnnotation.type(), markerBuilderReferenceAnnotation.name()
MarkerMappingRef.UndefinedBuilderImplementationType.class,
markerBuilderReferenceAnnotation.builderType(), markerBuilderReferenceAnnotation.builderName()
)
.orElseThrow( () -> log.missingBuilderReferenceInMarkerMapping(
MarkerMapping.class, annotation.annotationType()
Expand Down

0 comments on commit 06b879c

Please sign in to comment.