aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/registry/IQuerySpecificationRegistryEntry.java
blob: 5009d74b63218250fdd03ace962d3b899cdaa05f (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
/*******************************************************************************
 * 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;

import tools.refinery.viatra.runtime.extensibility.IQuerySpecificationProvider;

/**
 * The query specification registry entry interface can return the identifier of the source that added it to the
 * registry. It is provider based and can delay class loading of the wrapped {@link IQuerySpecification} until needed.
 * 
 * @author Abel Hegedus
 * @since 1.3
 *
 */
public interface IQuerySpecificationRegistryEntry extends IQuerySpecificationProvider {

    /**
     * @return the identifier of the registry source that contributed the specification
     */
    String getSourceIdentifier();
    
    /**
     * Returns whether the query specification was provided by an identifiable project.
     */
    boolean isFromProject();
    
    /**
     * Collects the name of the project that is registered this specification to the registry.
     *  If {@link #getSourceIdentifier()} is false, it returns null.
     */
    String getSourceProjectName();

    /**
     * @return true if the entry should be included in default views (created without any filters)
     */
    boolean includeInDefaultViews();
    
    /**
     * @return the wrapped {@link IQuerySpecificationProvider} or itself
     */
    IQuerySpecificationProvider getProvider();
}