aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/store-query/src/main/java/tools/refinery/store/query/literal/AggregationLiteral.java
blob: 93e59291cae9c44a05dcbdf711a5f3a444538a8f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.store.query.literal;

import tools.refinery.store.query.Constraint;
import tools.refinery.store.query.equality.LiteralEqualityHelper;
import tools.refinery.store.query.substitution.Substitution;
import tools.refinery.store.query.term.Aggregator;
import tools.refinery.store.query.term.DataVariable;
import tools.refinery.store.query.term.Variable;

import java.util.List;
import java.util.Objects;
import java.util.Set;

public class AggregationLiteral<R, T> extends AbstractCallLiteral {
	private final DataVariable<R> resultVariable;
	private final DataVariable<T> inputVariable;
	private final Aggregator<R, T> aggregator;

	public AggregationLiteral(DataVariable<R> resultVariable, Aggregator<R, T> aggregator,
							  DataVariable<T> inputVariable, Constraint target, List<Variable> arguments) {
		super(target, arguments);
		if (!inputVariable.getType().equals(aggregator.getInputType())) {
			throw new IllegalArgumentException("Input variable %s must of type %s, got %s instead".formatted(
					inputVariable, aggregator.getInputType().getName(), inputVariable.getType().getName()));
		}
		if (!resultVariable.getType().equals(aggregator.getResultType())) {
			throw new IllegalArgumentException("Result variable %s must of type %s, got %s instead".formatted(
					resultVariable, aggregator.getResultType().getName(), resultVariable.getType().getName()));
		}
		if (!arguments.contains(inputVariable)) {
			throw new IllegalArgumentException("Input variable %s must appear in the argument list".formatted(
					inputVariable));
		}
		if (arguments.contains(resultVariable)) {
			throw new IllegalArgumentException("Result variable %s must not appear in the argument list".formatted(
					resultVariable));
		}
		this.resultVariable = resultVariable;
		this.inputVariable = inputVariable;
		this.aggregator = aggregator;
	}

	public DataVariable<R> getResultVariable() {
		return resultVariable;
	}

	public DataVariable<T> getInputVariable() {
		return inputVariable;
	}

	public Aggregator<R, T> getAggregator() {
		return aggregator;
	}

	@Override
	public Set<Variable> getBoundVariables() {
		return Set.of(resultVariable);
	}

	@Override
	protected Literal doSubstitute(Substitution substitution, List<Variable> substitutedArguments) {
		return new AggregationLiteral<>(substitution.getTypeSafeSubstitute(resultVariable), aggregator,
				substitution.getTypeSafeSubstitute(inputVariable), getTarget(), substitutedArguments);
	}

	@Override
	public boolean equalsWithSubstitution(LiteralEqualityHelper helper, Literal other) {
		if (!super.equalsWithSubstitution(helper, other)) {
			return false;
		}
		var otherAggregationLiteral = (AggregationLiteral<?, ?>) other;
		return helper.variableEqual(resultVariable, otherAggregationLiteral.resultVariable) &&
				aggregator.equals(otherAggregationLiteral.aggregator) &&
				helper.variableEqual(inputVariable, otherAggregationLiteral.inputVariable);
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (o == null || getClass() != o.getClass()) return false;
		if (!super.equals(o)) return false;
		AggregationLiteral<?, ?> that = (AggregationLiteral<?, ?>) o;
		return resultVariable.equals(that.resultVariable) && inputVariable.equals(that.inputVariable) &&
				aggregator.equals(that.aggregator);
	}

	@Override
	public int hashCode() {
		return Objects.hash(super.hashCode(), resultVariable, inputVariable, aggregator);
	}

	@Override
	public String toString() {
		var builder = new StringBuilder();
		builder.append(resultVariable);
		builder.append(" is ");
		builder.append(getTarget().toReferenceString());
		builder.append("(");
		var argumentIterator = getArguments().iterator();
		if (argumentIterator.hasNext()) {
			var argument = argumentIterator.next();
			if (inputVariable.equals(argument)) {
				builder.append("@Aggregate(\"").append(aggregator).append("\") ");
			}
			builder.append(argument);
			while (argumentIterator.hasNext()) {
				builder.append(", ").append(argumentIterator.next());
			}
		}
		builder.append(")");
		return builder.toString();
	}
}