summaryrefslogtreecommitdiffstats
path: root/predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java
diff options
context:
space:
mode:
Diffstat (limited to 'predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java')
-rw-r--r--predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java24
1 files changed, 24 insertions, 0 deletions
diff --git a/predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java b/predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java
new file mode 100644
index 00000000000..f6559bb4044
--- /dev/null
+++ b/predicate-search-core/src/main/java/com/yahoo/search/predicate/optimization/PredicateProcessor.java
@@ -0,0 +1,24 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.search.predicate.optimization;
+
+import com.yahoo.document.predicate.Predicate;
+
+/**
+ * A predicate processor takes a predicate, processes it and returns the result.
+ * Predicate optimisers typically implement this interface.
+ * Note that the interface does not give any guarantees if the processor will
+ * modify the predicate in-place or return a new instance.
+ *
+ * @author bjorncs
+ */
+@FunctionalInterface
+public interface PredicateProcessor {
+
+ /**
+ * Processes a predicate.
+ *
+ * @return the processed predicate.
+ */
+ Predicate process(Predicate predicate, PredicateOptions options);
+
+}