Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HSEARCH-5230 Support RAW model type with metric aggregations #4328

Merged
merged 1 commit into from
Oct 7, 2024
Merged

HSEARCH-5230 Support RAW model type with metric aggregations #4328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 120 additions & 40 deletions ...ch/backend/elasticsearch/search/aggregation/impl/ElasticsearchMetricFieldAggregation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
import org.hibernate.search.engine.backend.types.converter.spi.ProjectionConverter;
import org.hibernate.search.engine.search.aggregation.spi.FieldMetricAggregationBuilder;
import org.hibernate.search.engine.search.common.ValueModel;
import org.hibernate.search.util.common.AssertionFailure;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
Expand Down Expand Up @@ -64,15 +63,13 @@ public static <F> ElasticsearchMetricFieldAggregation.Factory<F> avg(Elasticsear
}

private final String absoluteFieldPath;
private final ProjectionConverter<F, ? extends K> fromFieldValueConverter;
private final ElasticsearchFieldCodec<F> codec;
private final AggregationExtractorBuilder<K> metricFieldExtractorCreator;
private final JsonAccessor<JsonObject> operation;

private ElasticsearchMetricFieldAggregation(Builder<F, K> builder) {
super( builder );
this.absoluteFieldPath = builder.field.absolutePath();
this.fromFieldValueConverter = builder.fromFieldValueConverter;
this.codec = builder.codec;
this.metricFieldExtractorCreator = builder.metricFieldExtractorCreator;
this.operation = builder.operation;
}

Expand All @@ -88,7 +85,7 @@ protected final JsonObject doRequest(AggregationRequestContext context) {

@Override
protected Extractor<K> extractor(AggregationRequestContext context) {
return new MetricFieldExtractor( nestedPathHierarchy, filter );
return metricFieldExtractorCreator.extractor( filter );
}

private static class Factory<F>
Expand Down Expand Up @@ -124,72 +121,155 @@ private TypeSelector(ElasticsearchFieldCodec<F> codec,
this.operation = operation;
}

@SuppressWarnings("unchecked")
@Override
public <T> Builder<F, T> type(Class<T> expectedType, ValueModel valueModel) {
ProjectionConverter<F, ? extends T> projectionConverter = null;
if ( useProjectionConverter( expectedType, valueModel ) ) {
projectionConverter = field.type().projectionConverter( valueModel )
.withConvertedType( expectedType, field );
}
return new Builder<>( codec, scope, field,
projectionConverter,
operation
);
}
AggregationExtractorBuilder<T> metricFieldExtractorCreator;

private <T> boolean useProjectionConverter(Class<T> expectedType, ValueModel valueModel) {
if ( !Double.class.isAssignableFrom( expectedType ) ) {
if ( ValueModel.RAW.equals( valueModel ) ) {
throw new AssertionFailure(
"Raw projection converter is not supported with metric aggregations at the moment" );
if ( ValueModel.RAW.equals( valueModel ) ) {
if ( Double.class.isAssignableFrom( expectedType ) ) {
metricFieldExtractorCreator = (AggregationExtractorBuilder<
T>) new DoubleMetricFieldExtractor.Builder( field.nestedPathHierarchy() );
}
else {
var projectionConverter = (ProjectionConverter<JsonElement, ? extends T>) field.type()
.rawProjectionConverter().withConvertedType( expectedType, field );
metricFieldExtractorCreator = (AggregationExtractorBuilder<T>) new RawMetricFieldExtractor.Builder<>(
field.nestedPathHierarchy(),
projectionConverter );
}
return true;
}

// expectedType == Double.class
if ( ValueModel.RAW.equals( valueModel ) ) {
return false;
else {
var projectionConverter = field.type()
.projectionConverter( valueModel ).withConvertedType( expectedType, field );
metricFieldExtractorCreator =
new MetricFieldExtractor.Builder<>( field.nestedPathHierarchy(), projectionConverter, codec );
}
return field.type().projectionConverter( valueModel ).valueType().isAssignableFrom( Double.class );

return new Builder<>( scope, field, metricFieldExtractorCreator, operation );
}
}

private class MetricFieldExtractor extends AbstractExtractor<K> {
protected MetricFieldExtractor(List<String> nestedPathHierarchy, ElasticsearchSearchPredicate filter) {
private static class MetricFieldExtractor<F, K> extends AbstractExtractor<K> {

private final ProjectionConverter<F, ? extends K> fromFieldValueConverter;
private final ElasticsearchFieldCodec<F> codec;

protected MetricFieldExtractor(List<String> nestedPathHierarchy, ElasticsearchSearchPredicate filter,
ProjectionConverter<F, ? extends K> fromFieldValueConverter, ElasticsearchFieldCodec<F> codec) {
super( nestedPathHierarchy, filter );
this.fromFieldValueConverter = fromFieldValueConverter;
this.codec = codec;
}

@Override
@SuppressWarnings("unchecked")
protected K doExtract(JsonObject aggregationResult, AggregationExtractContext context) {
FromDocumentValueConvertContext convertContext = context.fromDocumentValueConvertContext();
Optional<Double> value = VALUE_ACCESSOR.get( aggregationResult );
JsonElement valueAsString = aggregationResult.get( "value_as_string" );

if ( fromFieldValueConverter == null ) {
Double decode = value.orElse( null );
return (K) decode;
}

return fromFieldValueConverter.fromDocumentValue(
codec.decodeAggregationValue( value, valueAsString ),
convertContext
);
}

private static class Builder<F, K> extends AggregationExtractorBuilder<K> {
private final ProjectionConverter<F, ? extends K> fromFieldValueConverter;
private final ElasticsearchFieldCodec<F> codec;

private Builder(List<String> nestedPathHierarchy, ProjectionConverter<F, ? extends K> fromFieldValueConverter,
ElasticsearchFieldCodec<F> codec) {
super( nestedPathHierarchy );
this.fromFieldValueConverter = fromFieldValueConverter;
this.codec = codec;
}

@Override
AbstractExtractor<K> extractor(ElasticsearchSearchPredicate filter) {
return new MetricFieldExtractor<>( nestedPathHierarchy, filter, fromFieldValueConverter, codec );
}
}
}

private static class DoubleMetricFieldExtractor extends AbstractExtractor<Double> {
protected DoubleMetricFieldExtractor(List<String> nestedPathHierarchy, ElasticsearchSearchPredicate filter) {
super( nestedPathHierarchy, filter );
}

@Override
protected Double doExtract(JsonObject aggregationResult, AggregationExtractContext context) {
Optional<Double> value = VALUE_ACCESSOR.get( aggregationResult );
return value.orElse( null );
}

private static class Builder extends AggregationExtractorBuilder<Double> {

private Builder(List<String> nestedPathHierarchy) {
super( nestedPathHierarchy );
}

@Override
AbstractExtractor<Double> extractor(ElasticsearchSearchPredicate filter) {
return new DoubleMetricFieldExtractor( nestedPathHierarchy, filter );
}
}
}

private static class RawMetricFieldExtractor<K> extends AbstractExtractor<K> {

private final ProjectionConverter<JsonElement, K> projectionConverter;

protected RawMetricFieldExtractor(List<String> nestedPathHierarchy, ElasticsearchSearchPredicate filter,
ProjectionConverter<JsonElement, K> projectionConverter) {
super( nestedPathHierarchy, filter );
this.projectionConverter = projectionConverter;
}

@Override
protected K doExtract(JsonObject aggregationResult, AggregationExtractContext context) {
FromDocumentValueConvertContext convertContext = context.fromDocumentValueConvertContext();
return projectionConverter.fromDocumentValue( aggregationResult, convertContext );
}

private static class Builder<K> extends AggregationExtractorBuilder<K> {
private final ProjectionConverter<JsonElement, K> projectionConverter;

private Builder(List<String> nestedPathHierarchy, ProjectionConverter<JsonElement, K> projectionConverter) {
super( nestedPathHierarchy );
this.projectionConverter = projectionConverter;
}

@Override
AbstractExtractor<K> extractor(ElasticsearchSearchPredicate filter) {
return new RawMetricFieldExtractor<>( nestedPathHierarchy, filter, projectionConverter );
}
}
}

private abstract static class AggregationExtractorBuilder<K> {
protected final List<String> nestedPathHierarchy;

protected AggregationExtractorBuilder(List<String> nestedPathHierarchy) {
this.nestedPathHierarchy = nestedPathHierarchy;
}

abstract AbstractExtractor<K> extractor(ElasticsearchSearchPredicate filter);
}

private static class Builder<F, K> extends AbstractBuilder<K>
implements FieldMetricAggregationBuilder<K> {

private final ElasticsearchFieldCodec<F> codec;
private final ProjectionConverter<F, ? extends K> fromFieldValueConverter;
private final AggregationExtractorBuilder<K> metricFieldExtractorCreator;
private final JsonAccessor<JsonObject> operation;

private Builder(ElasticsearchFieldCodec<F> codec, ElasticsearchSearchIndexScope<?> scope,
private Builder(ElasticsearchSearchIndexScope<?> scope,
ElasticsearchSearchIndexValueFieldContext<F> field,
ProjectionConverter<F, ? extends K> fromFieldValueConverter, JsonAccessor<JsonObject> operation) {
AggregationExtractorBuilder<K> metricFieldExtractorCreator,
JsonAccessor<JsonObject> operation) {
super( scope, field );
this.codec = codec;
this.fromFieldValueConverter = fromFieldValueConverter;
this.metricFieldExtractorCreator = metricFieldExtractorCreator;
this.operation = operation;
}

Expand Down
Loading