blob: 97a17f0e3d709b8e9130eb45a361687222e9cf8d (
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
|
/*******************************************************************************
* Copyright (c) 2010-2016, Abel Hegedus, IncQuery Labs Ltd.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-v20.html.
*
* SPDX-License-Identifier: EPL-2.0
*******************************************************************************/
package tools.refinery.viatra.runtime.registry;
/**
* The query specification registry is used to manage query specifications provided by multiple connectors which can
* dynamically add and remove specifications. Users can read the contents of the registry through views that are also
* dynamically updated when the registry is changed by the connectors.
*
* @author Abel Hegedus
* @since 1.3
*
*/
public interface IQuerySpecificationRegistry {
/**
* Cannot register connectors with the same identifier twice. No change occurs if the identifier is already used.
*
* @param connector
* cannot be null
* @return false if a connector with the given identifier has already been added, true otherwise
*/
boolean addSource(IRegistrySourceConnector connector);
/**
* Removes the connector if it was registered. No change occurs if the identifier of the connector was not used
* before.
*
* @param connector
* cannot be null
* @return false if a registered connector with the given identifier was not found, true if it was successfully
* removed
*/
boolean removeSource(IRegistrySourceConnector connector);
/**
* Returns a default view instance that contains query specification entries that indicate their inclusion in
* default views. If there are entries with the same FQN, only the last added will be included in the view to avoid
* duplicate FQNs.
*
* @return the default view instance
*/
IDefaultRegistryView getDefaultView();
/**
* Creates a view which contains query specification entries that indicate their inclusion in default views. This
* view will also be incrementally updated on registry changes and accepts listeners to notify on changes.
*
* @return a new view instance
*/
IRegistryView createView();
/**
* Creates a view which contains registered query specifications that are considered relevant by the passed filter.
* This view will also be incrementally updated on registry changes and accepts listeners to notify on changes.
*
* @return a new filtered view instance
*/
IRegistryView createView(IRegistryViewFilter filter);
/**
* Creates a view which is instantiated by the factory and is connected to the registry. This
* view will also be incrementally updated on registry changes and accepts listeners to notify on changes.
*
* @return a new view instance
*/
IRegistryView createView(IRegistryViewFactory factory);
}
|