org.eclipse.viatra.cep.core.engine.compiler

Class EquivalentStatesMatch

java.lang.Object

org.eclipse.viatra.query.runtime.api.impl.BasePatternMatch

org.eclipse.viatra.cep.core.engine.compiler.EquivalentStatesMatch

All Implemented Interfaces:

java.lang.Cloneable, IPatternMatch

public abstract class EquivalentStatesMatch
extends BasePatternMatch

Pattern-specific match representation of the org.eclipse.viatra.cep.core.engine.compiler.equivalentStates pattern, to be used in conjunction with EquivalentStatesMatcher.

Class fields correspond to parameters of the pattern. Fields with value null are considered unassigned. Each instance is a (possibly partial) substitution of pattern parameters, usable to represent a match of the pattern in the result of a query, or to specify the bound (fixed) input parameters when issuing a query.

See Also:

EquivalentStatesMatcher, EquivalentStatesProcessor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Object	get(java.lang.String parameterName) Returns the value of the parameter with the given name, or null if name is invalid.
State	getPostState1()
State	getPostState2()
State	getPreState()
TypedTransition	getTransition1()
TypedTransition	getTransition2()
int	hashCode()
static EquivalentStatesMatch	newEmptyMatch() Returns an empty, mutable match.
static EquivalentStatesMatch	newMatch(TypedTransition pTransition1, TypedTransition pTransition2, State pPreState, State pPostState1, State pPostState2) Returns a new (partial) match.
static EquivalentStatesMatch	newMutableMatch(TypedTransition pTransition1, TypedTransition pTransition2, State pPreState, State pPostState1, State pPostState2) Returns a mutable (partial) match.
java.util.List<java.lang.String>	parameterNames() Returns the list of symbolic parameter names.
java.lang.String	patternName() Identifies the name of the pattern for which this is a match.
java.lang.String	prettyPrint() Prints the list of parameter-value pairs.
boolean	set(java.lang.String parameterName, java.lang.Object newValue) Sets the parameter with the given name to the given value.
void	setPostState1(State pPostState1)
void	setPostState2(State pPostState2)
void	setPreState(State pPreState)
void	setTransition1(TypedTransition pTransition1)
void	setTransition2(TypedTransition pTransition2)
EquivalentStatesQuerySpecification	specification()
java.lang.Object[]	toArray() Converts the match to an array representation, with each pattern parameter at their respective position.
EquivalentStatesMatch	toImmutable() Takes an immutable snapshot of this match.

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BasePatternMatch

get, isCompatibleWith, makeImmutableList, prettyPrintFeature, prettyPrintValue, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.viatra.query.runtime.api.IPatternMatch

isMutable

Method Detail

get

public java.lang.Object get(java.lang.String parameterName)

Description copied from interface: IPatternMatch

Returns the value of the parameter with the given name, or null if name is invalid.

getTransition1

public TypedTransition getTransition1()

getTransition2

public TypedTransition getTransition2()

getPreState

public State getPreState()

getPostState1

public State getPostState1()

getPostState2

public State getPostState2()

set

public boolean set(java.lang.String parameterName,
                   java.lang.Object newValue)

Description copied from interface: IPatternMatch

Sets the parameter with the given name to the given value.

Works only if match is mutable. See IPatternMatch.isMutable().

setTransition1

public void setTransition1(TypedTransition pTransition1)

setTransition2

public void setTransition2(TypedTransition pTransition2)

setPreState

public void setPreState(State pPreState)

setPostState1

public void setPostState1(State pPostState1)

setPostState2

public void setPostState2(State pPostState2)

patternName

public java.lang.String patternName()

Description copied from interface: IPatternMatch

Identifies the name of the pattern for which this is a match.

Specified by:

patternName in interface IPatternMatch

Overrides:

patternName in class BasePatternMatch

parameterNames

public java.util.List<java.lang.String> parameterNames()

Description copied from interface: IPatternMatch

Returns the list of symbolic parameter names.

Specified by:

parameterNames in interface IPatternMatch

Overrides:

parameterNames in class BasePatternMatch

toArray

public java.lang.Object[] toArray()

Description copied from interface: IPatternMatch

Converts the match to an array representation, with each pattern parameter at their respective position. In case of a partial match, unsubstituted parameters will be represented as null elements in the array.

Returns:

a newly constructed array containing each parameter substitution of the match in order.

toImmutable

public EquivalentStatesMatch toImmutable()

Description copied from interface: IPatternMatch

Takes an immutable snapshot of this match.

Returns:

the match itself in case of immutable matches, an immutable copy in case of mutable ones.

prettyPrint

public java.lang.String prettyPrint()

Description copied from interface: IPatternMatch

Prints the list of parameter-value pairs.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

specification

public EquivalentStatesQuerySpecification specification()

Returns:

the pattern for which this is a match.

newEmptyMatch

public static EquivalentStatesMatch newEmptyMatch()

Returns an empty, mutable match. Fields of the mutable match can be filled to create a partial match, usable as matcher input.

Returns:

the empty match.

newMutableMatch

public static EquivalentStatesMatch newMutableMatch(TypedTransition pTransition1,
                                                    TypedTransition pTransition2,
                                                    State pPreState,
                                                    State pPostState1,
                                                    State pPostState2)

Returns a mutable (partial) match. Fields of the mutable match can be filled to create a partial match, usable as matcher input.

Parameters:

pTransition1 - the fixed value of pattern parameter transition1, or null if not bound.

pTransition2 - the fixed value of pattern parameter transition2, or null if not bound.

pPreState - the fixed value of pattern parameter preState, or null if not bound.

pPostState1 - the fixed value of pattern parameter postState1, or null if not bound.

pPostState2 - the fixed value of pattern parameter postState2, or null if not bound.

Returns:

the new, mutable (partial) match object.

newMatch

public static EquivalentStatesMatch newMatch(TypedTransition pTransition1,
                                             TypedTransition pTransition2,
                                             State pPreState,
                                             State pPostState1,
                                             State pPostState2)

Returns a new (partial) match. This can be used e.g. to call the matcher with a partial match.

The returned match will be immutable. Use newEmptyMatch() to obtain a mutable match object.

Parameters:

pTransition1 - the fixed value of pattern parameter transition1, or null if not bound.

pTransition2 - the fixed value of pattern parameter transition2, or null if not bound.

pPreState - the fixed value of pattern parameter preState, or null if not bound.

pPostState1 - the fixed value of pattern parameter postState1, or null if not bound.

pPostState2 - the fixed value of pattern parameter postState2, or null if not bound.

Returns:

the (partial) match object.