1 files changed, 38 insertions, 0 deletions

diff --git a/subprojects/viatra-runtime-base/src/main/java/tools/refinery/viatra/runtime/base/api/filters/IBaseIndexFeatureFilter.java b/subprojects/viatra-runtime-base/src/main/java/tools/refinery/viatra/runtime/base/api/filters/IBaseIndexFeatureFilter.java
new file mode 100644
index 00000000..8929b2ab
--- /dev/null
+++ b/subprojects/viatra-runtime-base/src/main/java/tools/refinery/viatra/runtime/base/api/filters/IBaseIndexFeatureFilter.java
@@ -0,0 +1,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);
+
+}
\ No newline at end of file