aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/store/src/main/java/tools/refinery/store/model/internal/VersionedInterpretation.java
blob: dcf0ad08b05d198a6f1709367e21890a7b42de5b (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.store.model.internal;

import tools.refinery.store.map.*;
import tools.refinery.store.model.Interpretation;
import tools.refinery.store.model.InterpretationListener;
import tools.refinery.store.model.Model;
import tools.refinery.store.representation.AnySymbol;
import tools.refinery.store.representation.Symbol;
import tools.refinery.store.tuple.Tuple;

import java.util.ArrayList;
import java.util.List;

public abstract class VersionedInterpretation<T> implements Interpretation<T> {
	private final ModelImpl model;
	private final Symbol<T> symbol;
	private final VersionedMap<Tuple, T> map;
	private final List<InterpretationListener<T>> listeners = new ArrayList<>();
	private final List<InterpretationListener<T>> restoreListeners = new ArrayList<>();

	protected VersionedInterpretation(ModelImpl model, Symbol<T> symbol, VersionedMap<Tuple, T> map) {
		this.model = model;
		this.symbol = symbol;
		this.map = map;
	}

	@Override
	public Model getModel() {
		return model;
	}

	@Override
	public Symbol<T> getSymbol() {
		return symbol;
	}

	@Override
	public long getSize() {
		return map.getSize();
	}

	private void checkKey(Tuple key) {
		if (key == null || key.getSize() != symbol.arity()) {
			throw new IllegalArgumentException("Key for %s must be a tuple with arity %s"
					.formatted(symbol, symbol.arity()));
		}
	}

	@Override
	public T get(Tuple key) {
		checkKey(key);
		return map.get(key);
	}

	@Override
	public Cursor<Tuple, T> getAll() {
		return map.getAll();
	}

	protected void valueChanged(Tuple key, T fromValue, T toValue, boolean restoring) {
		var listenerList = restoring ? restoreListeners : listeners;
		int listenerCount = listenerList.size();
		// Use a for loop instead of a for-each loop to avoid <code>Iterator</code> allocation overhead.
		//noinspection ForLoopReplaceableByForEach
		for (int i = 0; i < listenerCount; i++) {
			listenerList.get(i).put(key, fromValue, toValue, restoring);
		}
	}

	@Override
	public T put(Tuple key, T value) {
		checkKey(key);
		model.checkCancelled();
		model.markAsChanged();
		var oldValue = map.put(key, value);
		valueChanged(key, oldValue, value, false);
		return oldValue;
	}

	@Override
	public void putAll(Cursor<Tuple, T> cursor) {
		model.markAsChanged();
		if (cursor.getDependingMaps().contains(map)) {
			List<Tuple> keys = new ArrayList<>();
			List<T> values = new ArrayList<>();
			while (cursor.move()) {
				model.checkCancelled();
				keys.add(cursor.getKey());
				values.add(cursor.getValue());
			}
			var keyIterator = keys.iterator();
			var valueIterator = values.iterator();
			while (keyIterator.hasNext()) {
				put(keyIterator.next(), valueIterator.next());
			}
		} else {
			while (cursor.move()) {
				put(cursor.getKey(), cursor.getValue());
			}
		}
	}

	@Override
	public DiffCursor<Tuple, T> getDiffCursor(Version to) {
		return map.getDiffCursor(to);
	}

	Version commit() {
		return map.commit();
	}

	protected boolean shouldNotifyRestoreListeners() {
		return !restoreListeners.isEmpty();
	}

	public void restore(Version state) {
		if (shouldNotifyRestoreListeners()) {
			var diffCursor = getDiffCursor(state);
			while (diffCursor.move()) {
				valueChanged(diffCursor.getKey(), diffCursor.getFromValue(), diffCursor.getToValue(), true);
			}
		}
		map.restore(state);
	}

	@Override
	public void addListener(InterpretationListener<T> listener, boolean alsoWhenRestoring) {
		listeners.add(listener);
		if (alsoWhenRestoring) {
			restoreListeners.add(listener);
		}
	}

	@Override
	public void removeListener(InterpretationListener<T> listener) {
		listeners.remove(listener);
		restoreListeners.remove(listener);
	}

	static <T> VersionedInterpretation<T> of(ModelImpl model, AnySymbol symbol, VersionedMapStore<Tuple, T> store) {
		@SuppressWarnings("unchecked")
		var typedSymbol = (Symbol<T>) symbol;
		var map = store.createMap();
		return of(model, typedSymbol, map);
	}

	static <T> VersionedInterpretation<T> of(ModelImpl model, AnySymbol symbol, VersionedMapStore<Tuple, T> store,
											 Version state) {
		@SuppressWarnings("unchecked")
		var typedSymbol = (Symbol<T>) symbol;
		var map = store.createMap(state);
		return of(model, typedSymbol, map);
	}

	private static <T> VersionedInterpretation<T> of(ModelImpl model, Symbol<T> typedSymbol,
													 VersionedMap<Tuple, T> map) {
		return switch (typedSymbol.arity()) {
			case 0 -> new NullaryVersionedInterpretation<>(model, typedSymbol, map);
			case 1 -> new UnaryVersionedInterpretation<>(model, typedSymbol, map);
			default -> new IndexedVersionedInterpretation<>(model, typedSymbol, map);
		};
	}
}