aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/logic/src/main/java/tools/refinery/logic/term/DataVariable.java
blob: 7ef69d05350f4e25b0155cd7d21494aedc94d2c6 (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
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.logic.term;

import org.jetbrains.annotations.Nullable;
import tools.refinery.logic.InvalidQueryException;
import tools.refinery.logic.equality.LiteralEqualityHelper;
import tools.refinery.logic.equality.LiteralHashCodeHelper;
import tools.refinery.logic.literal.EquivalenceLiteral;
import tools.refinery.logic.literal.Literal;
import tools.refinery.logic.substitution.Substitution;
import tools.refinery.logic.valuation.Valuation;

import java.util.Objects;

public final class DataVariable<T> extends AnyDataVariable implements Term<T> {
	private final Class<T> type;

	DataVariable(String name, Class<T> type) {
		super(name);
		this.type = type;
	}

	@Override
	public Class<T> getType() {
		return type;
	}

	@Override
	public DataVariable<T> renew(@Nullable String name) {
		return new DataVariable<>(name, type);
	}

	@Override
	public DataVariable<T> renew() {
		return renew(getExplicitName());
	}

	@Override
	public <U> DataVariable<U> asDataVariable(Class<U> newType) {
		if (!getType().equals(newType)) {
			throw new InvalidQueryException("%s is not of type %s but of type %s"
					.formatted(this, newType.getName(), getType().getName()));
		}
		@SuppressWarnings("unchecked")
		var result = (DataVariable<U>) this;
		return result;
	}

	@Override
	public T evaluate(Valuation valuation) {
		return valuation.getValue(this);
	}

	@Override
	public Term<T> substitute(Substitution substitution) {
		return substitution.getTypeSafeSubstitute(this);
	}

	@Override
	public boolean equalsWithSubstitution(LiteralEqualityHelper helper, AnyTerm other) {
		return other instanceof DataVariable<?> dataVariable && helper.variableEqual(this, dataVariable);
	}

	@Override
	public int hashCodeWithSubstitution(LiteralHashCodeHelper helper) {
		return helper.getVariableHashCode(this);
	}

	@Override
	public int hashCodeWithSubstitution(int sequenceNumber) {
		return Objects.hash(type, sequenceNumber);
	}

	public Literal assign(AssignedValue<T> value) {
		return value.toLiteral(this);
	}

	@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;
		DataVariable<?> that = (DataVariable<?>) o;
		return type.equals(that.type);
	}

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

	public EquivalenceLiteral isEquivalent(DataVariable<T> other) {
		return new EquivalenceLiteral(true, this, other);
	}

	public EquivalenceLiteral notEquivalent(DataVariable<T> other) {
		return new EquivalenceLiteral(false, this, other);
	}
}