aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime-localsearch/src/main/java/tools/refinery/viatra/runtime/localsearch/plan/IPlanDescriptor.java
blob: 987996c91b5b2b91b6472cbd8dc25fdd40ee4850 (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
/*******************************************************************************
 * Copyright (c) 2010-2016, Grill Balázs, 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.localsearch.plan;

import java.util.Collection;
import java.util.Set;

import tools.refinery.viatra.runtime.matchers.context.IInputKey;
import tools.refinery.viatra.runtime.matchers.psystem.queries.PParameter;
import tools.refinery.viatra.runtime.matchers.psystem.queries.PQuery;

/**
 * Denotes an executable plan
 * 
 * @author Grill Balázs
 * @since 1.4
 *
 */
public interface IPlanDescriptor {

    /**
     * The query which this plan implements
     */
    public PQuery getQuery();
    
    /**
     * The executable search plans for each body in the query
     * @since 2.0
     */
    public Collection<SearchPlanForBody> getPlan();
    
    /**
     * The set of parameters this plan assumes to be bound
     */
    public Set<PParameter> getAdornment();
    
    /**
     * The collection of {@link IInputKey}s which needs to be iterated during the execution of this plan. For optimal
     * performance, instances of these keys might be indexed.
     */
    public Set<IInputKey> getIteratedKeys();
    
}