AssignmentDetector (EASy-Producer Documentation API)

java.lang.Object
- de.uni_hildesheim.sse.translation.AssignmentDetector

All Implemented Interfaces:

IConstraintTreeVisitor
```
public class AssignmentDetector
extends java.lang.Object
implements IConstraintTreeVisitor
```
Implements a visitor which searches for assignments. Instances of this class may be reused by calling clear() after use.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`isAssignment`
`private int`	`level`
`static int`	`LEVEL_UNLIMITED` The level specification to be used if traversal shall not be limited.
`private int`	`maxLevel`
`static int`	`NO_DEEP_TRAVERSAL` The level specification to be used if no deep traversal shall happen (just the top level).

Constructor Summary

Constructors
Constructor and Description

AssignmentDetector()

Constructors
Constructor and Description
`AssignmentDetector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears this visitor for reuse.
`private boolean`	`continueTraversal()` Returns whether the traversal of the given constraint shall be continued in case of nested trees.
`boolean`	`isAssignment()` Returns whether the expression is an assignment at maximum at the given level.
`void`	`setMaxLevel(int level)` Defines the maximum search level.
`void`	`visitAnnotationVariable(AttributeVariable variable)` Visits a `AttributeVariable`.
`void`	`visitBlockExpression(BlockExpression block)` Visits the block.
`void`	`visitComment(Comment comment)` Visits a comment.
`void`	`visitCompoundAccess(CompoundAccess access)` Visits a compound access node.
`void`	`visitCompoundInitializer(CompoundInitializer initializer)` Visits a compound initializer.
`void`	`visitConstantValue(ConstantValue value)` Visits a constant value.
`void`	`visitContainerInitializer(ContainerInitializer initializer)` Visits a container initializer.
`void`	`visitContainerOperationCall(ContainerOperationCall call)` Visits a container operation call (e.g. quantors, iterators).
`void`	`visitIfThen(IfThen ifThen)` Visits an if-then-else expression.
`void`	`visitLet(Let let)` Visits a let expression.
`void`	`visitMultiAndExpression(MultiAndExpression expression)` Visits a multi-and expression.
`void`	`visitOclFeatureCall(OCLFeatureCall call)` Visits an OCL feature call.
`void`	`visitParenthesis(Parenthesis parenthesis)` Visits a parenthesis.
`void`	`visitSelf(Self self)` Visits self.
`void`	`visitUnresolvedExpression(UnresolvedExpression expression)` Visits an unresolved expression.
`void`	`visitVariable(Variable variable)` Visits a variable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LEVEL_UNLIMITED
```
public static final int LEVEL_UNLIMITED
```
    The level specification to be used if traversal shall not be limited.
    
    See Also:
    
    Constant Field Values
  - NO_DEEP_TRAVERSAL
```
public static final int NO_DEEP_TRAVERSAL
```
    The level specification to be used if no deep traversal shall happen (just the top level).
    
    See Also:
    
    Constant Field Values
  - isAssignment
```
private boolean isAssignment
```
  - maxLevel
```
private int maxLevel
```
  - level
```
private int level
```
- Constructor Detail
  - AssignmentDetector
```
public AssignmentDetector()
```
- Method Detail
  - setMaxLevel
```
public void setMaxLevel(int level)
```
    Defines the maximum search level.
    
    Parameters:
    
    level - the maximum search level, may be LEVEL_UNLIMITED in order to avoid any level limitation or NO_DEEP_TRAVERSAL in order to avoid
  - isAssignment
```
public boolean isAssignment()
```
    Returns whether the expression is an assignment at maximum at the given level.
    
    Returns:
    
    true if it is an assignment, false else
  - clear
```
public void clear()
```
    Clears this visitor for reuse.
  - visitConstantValue
```
public void visitConstantValue(ConstantValue value)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a constant value.
    
    Specified by:
    
    visitConstantValue in interface IConstraintTreeVisitor
    
    Parameters:
    
    value - the value which should be visited
  - visitVariable
```
public void visitVariable(Variable variable)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a variable.
    
    Specified by:
    
    visitVariable in interface IConstraintTreeVisitor
    
    Parameters:
    
    variable - the variable which should be visited
  - visitAnnotationVariable
```
public void visitAnnotationVariable(AttributeVariable variable)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a AttributeVariable.
    
    Specified by:
    
    visitAnnotationVariable in interface IConstraintTreeVisitor
    
    Parameters:
    
    variable - the attribute variable which should be visited
  - continueTraversal
```
private boolean continueTraversal()
```
    Returns whether the traversal of the given constraint shall be continued in case of nested trees. Continuation is not needed if already an assignment has been found or the maximum level is exceeded.
    
    Returns:
    
    true if the traversal shall be continued, false else
  - visitParenthesis
```
public void visitParenthesis(Parenthesis parenthesis)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a parenthesis.
    
    Specified by:
    
    visitParenthesis in interface IConstraintTreeVisitor
    
    Parameters:
    
    parenthesis - the parenthesis which should be visited
  - visitComment
```
public void visitComment(Comment comment)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a comment.
    
    Specified by:
    
    visitComment in interface IConstraintTreeVisitor
    
    Parameters:
    
    comment - the comment node which should be visited
  - visitOclFeatureCall
```
public void visitOclFeatureCall(OCLFeatureCall call)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits an OCL feature call.
    
    Specified by:
    
    visitOclFeatureCall in interface IConstraintTreeVisitor
    
    Parameters:
    
    call - the feature call which should be visited
  - visitMultiAndExpression
```
public void visitMultiAndExpression(MultiAndExpression expression)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a multi-and expression.
    
    Specified by:
    
    visitMultiAndExpression in interface IConstraintTreeVisitor
    
    Parameters:
    
    expression - the expression to be visited
  - visitLet
```
public void visitLet(Let let)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a let expression.
    
    Specified by:
    
    visitLet in interface IConstraintTreeVisitor
    
    Parameters:
    
    let - the let expression which should be visited
  - visitIfThen
```
public void visitIfThen(IfThen ifThen)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits an if-then-else expression.
    
    Specified by:
    
    visitIfThen in interface IConstraintTreeVisitor
    
    Parameters:
    
    ifThen - the if-then-else expression which should be visited
  - visitContainerOperationCall
```
public void visitContainerOperationCall(ContainerOperationCall call)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a container operation call (e.g. quantors, iterators).
    
    Specified by:
    
    visitContainerOperationCall in interface IConstraintTreeVisitor
    
    Parameters:
    
    call - the container operation call
  - visitCompoundAccess
```
public void visitCompoundAccess(CompoundAccess access)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a compound access node.
    
    Specified by:
    
    visitCompoundAccess in interface IConstraintTreeVisitor
    
    Parameters:
    
    access - the compound access node
  - visitUnresolvedExpression
```
public void visitUnresolvedExpression(UnresolvedExpression expression)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits an unresolved expression. Please note that an unresolved expression may represent a leaf as well as an inner tree node. Typically, visitors shall continue visiting transparently at UnresolvedExpression.getActualExpression().
    
    Specified by:
    
    visitUnresolvedExpression in interface IConstraintTreeVisitor
    
    Parameters:
    
    expression - the expression
  - visitCompoundInitializer
```
public void visitCompoundInitializer(CompoundInitializer initializer)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a compound initializer.
    
    Specified by:
    
    visitCompoundInitializer in interface IConstraintTreeVisitor
    
    Parameters:
    
    initializer - the compound initializer node
  - visitContainerInitializer
```
public void visitContainerInitializer(ContainerInitializer initializer)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits a container initializer.
    
    Specified by:
    
    visitContainerInitializer in interface IConstraintTreeVisitor
    
    Parameters:
    
    initializer - the container initializer node
  - visitSelf
```
public void visitSelf(Self self)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits self.
    
    Specified by:
    
    visitSelf in interface IConstraintTreeVisitor
    
    Parameters:
    
    self - the self object to visit
  - visitBlockExpression
```
public void visitBlockExpression(BlockExpression block)
```
    Description copied from interface: IConstraintTreeVisitor
    
    Visits the block.
    
    Specified by:
    
    visitBlockExpression in interface IConstraintTreeVisitor
    
    Parameters:
    
    block - the block to be visited

Class AssignmentDetector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEVEL_UNLIMITED

NO_DEEP_TRAVERSAL

isAssignment

maxLevel

level

Constructor Detail

AssignmentDetector

Method Detail

setMaxLevel

isAssignment

clear

visitConstantValue

visitVariable

visitAnnotationVariable

continueTraversal

visitParenthesis

visitComment

visitOclFeatureCall

visitMultiAndExpression

visitLet

visitIfThen

visitContainerOperationCall

visitCompoundAccess

visitUnresolvedExpression

visitCompoundInitializer

visitContainerInitializer

visitSelf

visitBlockExpression