Package net.ssehub.easy.instantiation.core.model.buildlangModel.ruleMatch

Class AbstractRuleMatchExpression

java.lang.Object

net.ssehub.easy.instantiation.core.model.expressions.Expression

net.ssehub.easy.instantiation.core.model.buildlangModel.ruleMatch.AbstractRuleMatchExpression

Direct Known Subclasses:

AbstractPathRuleMatchExpression, ArtifactMatchExpression, BooleanMatchExpression, CollectionMatchExpression

public abstract class AbstractRuleMatchExpression
extends Expression

Represents a rule pre/post match condition (not a rule call in a pre condition). This class supports iterating over the match results.

Author:

Holger Eichelberger

Constructor Summary

Constructors

Constructor	Description
AbstractRuleMatchExpression()

Method Summary

Modifier and Type	Method	Description
protected abstract java.lang.Object	accept(IMatchVisitor visitor)	Accepts the given visitor for visiting.
java.lang.Object	accept(IExpressionVisitor visitor)	Visits the expression.
abstract boolean	contributesTo(AbstractRuleMatchExpression expression)	Returns whether this rule match expression may contribute to the fulfillment of expression.
abstract java.lang.Object	determineExpected(AbstractRuleMatchExpression rhsExpr, java.lang.Object rhsValue)	Determines the expected value on the left side (represented by this object) based on the actual value for the corresponding right side.
protected static TypeDescriptor<? extends Collection<? extends IArtifact>>	ensureType(TypeDescriptor<?> type)	Ensures a collection type for type.
abstract Collection<?>	evaluate(IExpressionVisitor evaluator)	Evaluates this expression.
abstract TypeDescriptor<?>	getEntryType()	Returns the entry type over which this match expression will be able to iterate.
TypeDescriptor<? extends Collection<? extends IArtifact>>	inferType()	Infers the type of this expression including the type of the contained sub-expressions.

Methods inherited from class net.ssehub.easy.instantiation.core.model.expressions.Expression

replaceEmptyLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRuleMatchExpression

public AbstractRuleMatchExpression()

Method Detail

getEntryType

public abstract TypeDescriptor<?> getEntryType()

Returns the entry type over which this match expression will be able to iterate.

Returns:

the entry type

determineExpected

public abstract java.lang.Object determineExpected(AbstractRuleMatchExpression rhsExpr,
                                                   java.lang.Object rhsValue)
                                            throws VilException

Determines the expected value on the left side (represented by this object) based on the actual value for the corresponding right side.

Parameters:

rhsExpr - the (resolved) RHS expression

rhsValue - the RHS value

Returns:

the expected LHS value (null denotes no expectation)

Throws:

VilException - in case that determining the expected object fails

accept

public java.lang.Object accept(IExpressionVisitor visitor)
                        throws VilException

Description copied from class: Expression

Visits the expression.

Specified by:

accept in class Expression

Parameters:

visitor - the visitor

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

accept

protected abstract java.lang.Object accept(IMatchVisitor visitor)
                                    throws VilException

Accepts the given visitor for visiting.

Parameters:

visitor - the match visitor used for visiting

Returns:

the result of visiting (may be null)

Throws:

VilException - in case of visiting / evaluation errors

contributesTo

public abstract boolean contributesTo(AbstractRuleMatchExpression expression)

Returns whether this rule match expression may contribute to the fulfillment of expression.

Parameters:

expression - the expression to be considered (typically a RHS expression, while this is a LHS expression)

Returns:

true if this rule may contribute, false else

inferType

public TypeDescriptor<? extends Collection<? extends IArtifact>> inferType()
                                                                    throws VilException

Description copied from class: Expression

Infers the type of this expression including the type of the contained sub-expressions.

Specified by:

inferType in class Expression

Returns:

the type of this expression

Throws:

VilException - in case that inferring the type fails

evaluate

public abstract Collection<?> evaluate(IExpressionVisitor evaluator)
                                throws VilException

Evaluates this expression. Some subtypes may define some kind of value resolution, e.g., for match expressions. This must be called before!

Parameters:

evaluator - the expression evaluator (in case that an actual expression must be evaluated as part of this evaluation).

Returns:

the evaluation result

Throws:

VilException - in case that evaluation fails

ensureType

protected static TypeDescriptor<? extends Collection<? extends IArtifact>> ensureType(TypeDescriptor<?> type)
                                                                               throws VilException

Ensures a collection type for type.

Parameters:

type - the type to be checked and ensured

Returns:

the collection type

Throws:

VilException - in case that type cannot be converted into a collection type