|
| 1 | +package com.linkedin.metadata.utils.elasticsearch; |
| 2 | + |
| 3 | +import com.google.common.collect.ImmutableList; |
| 4 | +import com.linkedin.data.template.StringArray; |
| 5 | +import com.linkedin.metadata.query.filter.Condition; |
| 6 | +import com.linkedin.metadata.query.filter.ConjunctiveCriterion; |
| 7 | +import com.linkedin.metadata.query.filter.ConjunctiveCriterionArray; |
| 8 | +import com.linkedin.metadata.query.filter.Criterion; |
| 9 | +import com.linkedin.metadata.query.filter.CriterionArray; |
| 10 | +import com.linkedin.metadata.query.filter.Filter; |
| 11 | +import com.linkedin.metadata.utils.CriterionUtils; |
| 12 | +import java.util.ArrayList; |
| 13 | +import java.util.Collections; |
| 14 | +import java.util.List; |
| 15 | +import javax.annotation.Nonnull; |
| 16 | +import javax.annotation.Nullable; |
| 17 | + |
| 18 | +public class FilterUtils { |
| 19 | + |
| 20 | + /** |
| 21 | + * Combines two {@link Filter} instances in a conjunction and returns a new instance of {@link |
| 22 | + * Filter} in disjunctive normal form. |
| 23 | + * |
| 24 | + * @param baseFilter the filter to apply the view to |
| 25 | + * @param viewFilter the view filter, null if it doesn't exist |
| 26 | + * @return a new instance of {@link Filter} representing the applied view. |
| 27 | + */ |
| 28 | + @Nonnull |
| 29 | + public static Filter combineFilters( |
| 30 | + @Nullable final Filter baseFilter, @Nonnull final Filter viewFilter) { |
| 31 | + final Filter finalBaseFilter = |
| 32 | + baseFilter == null |
| 33 | + ? new Filter().setOr(new ConjunctiveCriterionArray(Collections.emptyList())) |
| 34 | + : baseFilter; |
| 35 | + |
| 36 | + // Join the filter conditions in Disjunctive Normal Form. |
| 37 | + return combineFiltersInConjunction(finalBaseFilter, viewFilter); |
| 38 | + } |
| 39 | + |
| 40 | + /** |
| 41 | + * Joins two filters in conjunction by reducing to Disjunctive Normal Form. |
| 42 | + * |
| 43 | + * @param filter1 the first filter in the pair |
| 44 | + * @param filter2 the second filter in the pair |
| 45 | + * <p>This method supports either Filter format, where the "or" field is used, instead of |
| 46 | + * criteria. If the criteria filter is used, then it will be converted into an "OR" before |
| 47 | + * returning the new filter. |
| 48 | + * @return the result of joining the 2 filters in a conjunction (AND) |
| 49 | + * <p>How does it work? It basically cross-products the conjunctions inside of each Filter |
| 50 | + * clause. |
| 51 | + * <p>Example Inputs: filter1 -> { or: [ { and: [ { field: tags, condition: EQUAL, values: |
| 52 | + * ["urn:li:tag:tag"] } ] }, { and: [ { field: glossaryTerms, condition: EQUAL, values: |
| 53 | + * ["urn:li:glossaryTerm:term"] } ] } ] } filter2 -> { or: [ { and: [ { field: domain, |
| 54 | + * condition: EQUAL, values: ["urn:li:domain:domain"] }, ] }, { and: [ { field: glossaryTerms, |
| 55 | + * condition: EQUAL, values: ["urn:li:glossaryTerm:term2"] } ] } ] } Example Output: { or: [ { |
| 56 | + * and: [ { field: tags, condition: EQUAL, values: ["urn:li:tag:tag"] }, { field: domain, |
| 57 | + * condition: EQUAL, values: ["urn:li:domain:domain"] } ] }, { and: [ { field: tags, |
| 58 | + * condition: EQUAL, values: ["urn:li:tag:tag"] }, { field: glossaryTerms, condition: EQUAL, |
| 59 | + * values: ["urn:li:glosaryTerm:term2"] } ] }, { and: [ { field: glossaryTerm, condition: |
| 60 | + * EQUAL, values: ["urn:li:glossaryTerm:term"] }, { field: domain, condition: EQUAL, values: |
| 61 | + * ["urn:li:domain:domain"] } ] }, { and: [ { field: glossaryTerm, condition: EQUAL, values: |
| 62 | + * ["urn:li:glossaryTerm:term"] }, { field: glossaryTerms, condition: EQUAL, values: |
| 63 | + * ["urn:li:glosaryTerm:term2"] } ] }, ] } |
| 64 | + */ |
| 65 | + @Nonnull |
| 66 | + private static Filter combineFiltersInConjunction( |
| 67 | + @Nonnull final Filter filter1, @Nonnull final Filter filter2) { |
| 68 | + |
| 69 | + final Filter finalFilter1 = convertToV2Filter(filter1); |
| 70 | + final Filter finalFilter2 = convertToV2Filter(filter2); |
| 71 | + |
| 72 | + // If either filter is empty, simply return the other filter. |
| 73 | + if (!finalFilter1.hasOr() || finalFilter1.getOr().size() == 0) { |
| 74 | + return finalFilter2; |
| 75 | + } |
| 76 | + if (!finalFilter2.hasOr() || finalFilter2.getOr().size() == 0) { |
| 77 | + return finalFilter1; |
| 78 | + } |
| 79 | + |
| 80 | + // Iterate through the base filter, then cross-product with filter 2 conditions. |
| 81 | + final Filter result = new Filter(); |
| 82 | + final List<ConjunctiveCriterion> newDisjunction = new ArrayList<>(); |
| 83 | + for (ConjunctiveCriterion conjunction1 : finalFilter1.getOr()) { |
| 84 | + for (ConjunctiveCriterion conjunction2 : finalFilter2.getOr()) { |
| 85 | + final List<Criterion> joinedCriterion = new ArrayList<>(conjunction1.getAnd()); |
| 86 | + joinedCriterion.addAll(conjunction2.getAnd()); |
| 87 | + ConjunctiveCriterion newConjunction = |
| 88 | + new ConjunctiveCriterion().setAnd(new CriterionArray(joinedCriterion)); |
| 89 | + newDisjunction.add(newConjunction); |
| 90 | + } |
| 91 | + } |
| 92 | + result.setOr(new ConjunctiveCriterionArray(newDisjunction)); |
| 93 | + return result; |
| 94 | + } |
| 95 | + |
| 96 | + @Nonnull |
| 97 | + private static Filter convertToV2Filter(@Nonnull Filter filter) { |
| 98 | + if (filter.hasOr()) { |
| 99 | + return filter; |
| 100 | + } else if (filter.hasCriteria()) { |
| 101 | + // Convert criteria to an OR |
| 102 | + return new Filter() |
| 103 | + .setOr( |
| 104 | + new ConjunctiveCriterionArray( |
| 105 | + ImmutableList.of(new ConjunctiveCriterion().setAnd(filter.getCriteria())))); |
| 106 | + } |
| 107 | + throw new IllegalArgumentException( |
| 108 | + String.format( |
| 109 | + "Illegal filter provided! Neither 'or' nor 'criteria' fields were populated for filter %s", |
| 110 | + filter)); |
| 111 | + } |
| 112 | + |
| 113 | + @Nonnull |
| 114 | + public static Filter createValuesFilter( |
| 115 | + @Nonnull final String fieldName, @Nonnull final List<String> values) { |
| 116 | + Filter filter = new Filter(); |
| 117 | + CriterionArray criterionArray = new CriterionArray(); |
| 118 | + |
| 119 | + StringArray valuesArray = new StringArray(); |
| 120 | + valuesArray.addAll(values); |
| 121 | + Criterion criterion = CriterionUtils.buildCriterion(fieldName, Condition.EQUAL, valuesArray); |
| 122 | + |
| 123 | + criterionArray.add(criterion); |
| 124 | + filter.setOr( |
| 125 | + new ConjunctiveCriterionArray( |
| 126 | + ImmutableList.of(new ConjunctiveCriterion().setAnd(criterionArray)))); |
| 127 | + |
| 128 | + return filter; |
| 129 | + } |
| 130 | +} |
0 commit comments