diff options
| author | Zoltan Ujhelyi | 2018-05-25 08:35:24 +0000 |
|---|---|---|
| committer | Zoltan Ujhelyi | 2018-05-25 10:44:36 +0000 |
| commit | d731df70ce45a98b2501801e866510437c0914b0 (patch) | |
| tree | bcac12ea9add06c065d9ff8b02ac8f174aebf1ec | |
| parent | b6714878922eb94cac12df3bd09029d6c4d00805 (diff) | |
| download | org.eclipse.viatra-d731df70ce45a98b2501801e866510437c0914b0.tar.gz org.eclipse.viatra-d731df70ce45a98b2501801e866510437c0914b0.tar.xz org.eclipse.viatra-d731df70ce45a98b2501801e866510437c0914b0.zip | |
[535101][535102] Mark local search adapter as experimental
Given the serious issues we have found with the correct local search
interface, for v2.0 its Javadoc was extended to allow us to update the
interface in future releases.
Change-Id: Ieb89218efd9c7fa18b3b06bfcef93dcfa175a886
Signed-off-by: Zoltan Ujhelyi <zoltan.ujhelyi@incquerylabs.com>
| -rw-r--r-- | query/plugins/org.eclipse.viatra.query.runtime.localsearch/src/org/eclipse/viatra/query/runtime/localsearch/matcher/ILocalSearchAdapter.java | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/query/plugins/org.eclipse.viatra.query.runtime.localsearch/src/org/eclipse/viatra/query/runtime/localsearch/matcher/ILocalSearchAdapter.java b/query/plugins/org.eclipse.viatra.query.runtime.localsearch/src/org/eclipse/viatra/query/runtime/localsearch/matcher/ILocalSearchAdapter.java index 41c3d6c69..88f42612b 100644 --- a/query/plugins/org.eclipse.viatra.query.runtime.localsearch/src/org/eclipse/viatra/query/runtime/localsearch/matcher/ILocalSearchAdapter.java +++ b/query/plugins/org.eclipse.viatra.query.runtime.localsearch/src/org/eclipse/viatra/query/runtime/localsearch/matcher/ILocalSearchAdapter.java @@ -7,18 +7,32 @@ * * Contributors: * Marton Bur - initial API and implementation + * Zoltan Ujhelyi - greatly redesigned version for VIATRA v2.0 *******************************************************************************/ package org.eclipse.viatra.query.runtime.localsearch.matcher; import java.util.Optional; +import org.eclipse.viatra.query.runtime.localsearch.ExecutionLoggerAdapter; import org.eclipse.viatra.query.runtime.localsearch.MatchingFrame; import org.eclipse.viatra.query.runtime.localsearch.operations.ISearchOperation; import org.eclipse.viatra.query.runtime.localsearch.plan.SearchPlan; +import org.eclipse.viatra.query.runtime.localsearch.profiler.LocalSearchProfilerAdapter; /** + * A local search adapter allows external code to follow the internal executions of the local search matcher. Possible + * implementations of the interface include profilers and debuggers. + * <p> + * <strong>EXPERIMENTAL</strong>. A few shortcomings have been found for this interface late during the development + * lifecycle of version 2.0 whose solution might need breaking possible future implementors. Because of this, right now + * it is not recommended to provide implementations outside of VIATRA. If necessary, have a look at the built-in + * adapters that should fulfill most cases in the meantime. See bugs https://bugs.eclipse.org/bugs/show_bug.cgi?id=535101 + * and https://bugs.eclipse.org/bugs/show_bug.cgi?id=535102 for details. + * * @author Marton Bur + * @see ExecutionLoggerAdapter + * @see LocalSearchProfilerAdapter * */ public interface ILocalSearchAdapter { |