blob: 86058be0c37233541d2a3893eea7c625b4e2e5cf (
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
|
/*******************************************************************************
* Copyright (c) 2010-2016, Grill Balázs, IncQueryLabs 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.localsearch.matcher.integration;
import java.util.Collections;
import java.util.Set;
import tools.refinery.viatra.runtime.matchers.backend.QueryEvaluationHint;
import tools.refinery.viatra.runtime.matchers.backend.QueryEvaluationHint.BackendRequirement;
import tools.refinery.viatra.runtime.matchers.psystem.queries.PParameter;
import tools.refinery.viatra.runtime.matchers.psystem.queries.PQuery;
/**
* An adornment provider is used to define the adornments the pattern matcher should prepare for.
*
* <p>A default implementation is available in {@link AllValidAdornments} that describes all
* adornments fulfilling the parameter direction declarations;
* another default option (with better performance but restricted applicability) is {@link LazyPlanningAdornments}.
*
* <br><br>
*
* Users may implement this interface to limit the number of prepared plans based on some runtime information:
*
* <pre>
* class SomeAdornments{
*
* public Iterable<Set<{@link PParameter}>> getAdornments({@link PQuery} query){
* if (SomeGeneratedQuerySpecification.instance().getInternalQueryRepresentation().equals(query)){
* return Collections.singleton(Sets.filter(Sets.newHashSet(query.getParameters()), new Predicate<PParameter>() {
*
* @Override
* public boolean apply(PParameter input) {
* // Decide whether this particular parameter will be bound
* return false;
* }
* }));
* }
* // Returning an empty iterable is safe for unknown queries
* return Collections.emptySet();
* }
*
* }
* </pre>
*
* @author Grill Balázs
* @since 1.5
*
*/
public interface IAdornmentProvider {
/**
* The bound parameter sets
*/
public Iterable<Set<PParameter>> getAdornments(PQuery query);
/**
* @return a simple hint that only overrides the adornment provider
* @since 2.1
*/
public static QueryEvaluationHint toHint(IAdornmentProvider adornmentProvider) {
return new QueryEvaluationHint(
Collections.singletonMap(LocalSearchHintOptions.ADORNMENT_PROVIDER, adornmentProvider),
BackendRequirement.UNSPECIFIED);
}
}
|
