org.eclipse.incquery.runtime.localsearch.operations

Interface ISearchOperation

All Known Implementing Classes:

BinaryTransitiveClosureCheck, CheckConstant, CheckOperation, ContainmentCheck, CountCheck, CountOperation, ExpressionCheck, ExpressionEval, ExtendConstant, ExtendOperation, ExtendToEStructuralFeatureSource, ExtendToEStructuralFeatureSource, ExtendToEStructuralFeatureTarget, ExtendToEStructuralFeatureTarget, InequalityCheck, InstanceOfClassCheck, InstanceOfDataTypeCheck, IterateOverChildren, IterateOverContainers, IterateOverEClassInstances, IterateOverEClassInstances, IterateOverEDatatypeInstances, IterateOverEDatatypeInstances, IterateOverEStructuralFeatureInstances, IterateOverEStructuralFeatureInstances, NACOperation, ScopeCheck, StructuralFeatureCheck

public interface ISearchOperation

Author:

Zoltan Ujhelyi

Method Summary

Modifier and Type	Method and Description
boolean	execute(MatchingFrame frame, ISearchContext context)
java.util.List<java.lang.Integer>	getVariablePositions()
void	onBacktrack(MatchingFrame frame, ISearchContext context) After the execution of the operation failed and execute(MatchingFrame, ISearchContext) returns false, the onBacktrack callback is evaluated.
void	onInitialize(MatchingFrame frame, ISearchContext context) During the execution of the corresponding plan, the onInitialize callback is evaluated before the execution of the operation may begin.

Method Detail

onInitialize

void onInitialize(MatchingFrame frame,
                  ISearchContext context)
           throws LocalSearchException

During the execution of the corresponding plan, the onInitialize callback is evaluated before the execution of the operation may begin. Operations may use this method to initialize its internal data structures.

Parameters:

frame -

context -

Throws:

LocalSearchException

onBacktrack

void onBacktrack(MatchingFrame frame,
                 ISearchContext context)
          throws LocalSearchException

After the execution of the operation failed and execute(MatchingFrame, ISearchContext) returns false, the onBacktrack callback is evaluated. Operations may use this method to clean up any temporary structures, and make the operation ready for a new execution.

Parameters:

frame -

context -

Throws:

LocalSearchException

execute

boolean execute(MatchingFrame frame,
                ISearchContext context)
         throws LocalSearchException

Parameters:

frame -

context -

Returns:

true if successful, or false if backtracking needed

Throws:

LocalSearchException

getVariablePositions

java.util.List<java.lang.Integer> getVariablePositions()

Returns:

the ordered list of the variable numbers that are affected by the search operation