diff options
Diffstat (limited to 'subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IRegistrySourceConnector.java')
-rw-r--r-- | subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IRegistrySourceConnector.java | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IRegistrySourceConnector.java b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IRegistrySourceConnector.java new file mode 100644 index 00000000..94c68d1b --- /dev/null +++ b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IRegistrySourceConnector.java | |||
@@ -0,0 +1,50 @@ | |||
1 | /******************************************************************************* | ||
2 | * Copyright (c) 2010-2016, Abel Hegedus, IncQuery Labs Ltd. | ||
3 | * This program and the accompanying materials are made available under the | ||
4 | * terms of the Eclipse Public License v. 2.0 which is available at | ||
5 | * http://www.eclipse.org/legal/epl-v20.html. | ||
6 | * | ||
7 | * SPDX-License-Identifier: EPL-2.0 | ||
8 | *******************************************************************************/ | ||
9 | package tools.refinery.viatra.runtime.registry; | ||
10 | |||
11 | /** | ||
12 | * A registry source connector can provide query specifications to listeners (e.g. {@link IQuerySpecificationRegistry}). | ||
13 | * The connector interface does not support direct access to query specifications, instead it sends existing specifications | ||
14 | * to listeners on addition and sends notifications to listeners when a change occurs in the set of specifications. | ||
15 | * | ||
16 | * @author Abel Hegedus | ||
17 | * @since 1.3 | ||
18 | * | ||
19 | */ | ||
20 | public interface IRegistrySourceConnector { | ||
21 | |||
22 | /** | ||
23 | * The connector must return the same identifier every time it is invoked! | ||
24 | * | ||
25 | * @return unique identifier of the connector | ||
26 | */ | ||
27 | String getIdentifier(); | ||
28 | |||
29 | /** | ||
30 | * | ||
31 | * @return true if the specifications of the connector should be included in default views | ||
32 | */ | ||
33 | boolean includeSpecificationsInDefaultViews(); | ||
34 | |||
35 | /** | ||
36 | * Add a listener to get updates on changes in the query specifications available from the connector. When the | ||
37 | * listener is added, the connector is expected to call the listener with each existing query specification. | ||
38 | * | ||
39 | * @param listener that should be added | ||
40 | */ | ||
41 | void addListener(IConnectorListener listener); | ||
42 | |||
43 | /** | ||
44 | * Removes an already registered listener and stops sending updates. The connector is not required to send any | ||
45 | * updates before returning from this method, but should not send any events after this method returns. | ||
46 | * | ||
47 | * @param listener that should be removed | ||
48 | */ | ||
49 | void removeListener(IConnectorListener listener); | ||
50 | } | ||