aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime-base/src/main/java/tools/refinery/viatra/runtime/base/api/filters/IBaseIndexFeatureFilter.java
blob: 8929b2ab68e5a67720cb4a4233a4b5308a5b949a (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
/**
 * Copyright (c) 2010-2016, Peter Lunk, 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.base.api.filters;

import org.eclipse.emf.ecore.EStructuralFeature;

/**
 * 
 * Defines if an {@link EStructuralFeature} should not be indexed by VIATRA Base. This filtering 
 * method should only be used if the input metamodel has certain features, that the base indexer 
 * cannot handle. If the filtered feature is a containment feature, the whole sub-tree accessible 
 * through the said feature will be filtered.
 *
 * Note: This API feature is for advanced users only. Usage of this feature is not encouraged, 
 * unless the filtering task is impossible via using the more straightforward 
 * {@link IBaseIndexResourceFilter} or {@link IBaseIndexObjectFilter}.   
 * 
 * @author Peter Lunk
 * @since 1.5
 * 
 */
public interface IBaseIndexFeatureFilter {

    /**
     * Decides whether the selected {@link EStructuralFeature} is filtered.
     * 
     * @param feature
     * @return true, if the feature should not be indexed
     */
    boolean isFiltered(EStructuralFeature feature);

}