Package net.ssehub.easy.varModel.model.filter

Class DeclarationFinder

java.lang.Object

net.ssehub.easy.varModel.model.AbstractProjectVisitor

net.ssehub.easy.varModel.model.filter.AbstractDeclarationFinder

net.ssehub.easy.varModel.model.filter.DeclarationFinder

All Implemented Interfaces:

ICustomDatatypeVisitor, IModelVisitor

public class DeclarationFinder
extends AbstractDeclarationFinder

This class locates all top-level DecisionVariableDeclaration in a project.

Author:

beck, El-Sharkawy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DeclarationFinder.VisibilityType	Specifies which kind of found declarations shall by returned.

Field Summary

Fields

Modifier and Type	Field	Description
private List<AbstractVariable>	allDeclarations
private List<AbstractVariable>	hiddenDeclarations
private Stack<Set<AbstractVariable>>	interfaces
private boolean	onlyToplevel
private IDatatype	type
private List<AbstractVariable>	visibleDeclarations

Constructor Summary

Constructors

Constructor	Description
DeclarationFinder(Project project, FilterType filterType, IDatatype type)	Constructor for specifying whether search results should be filtered regarding the specified IDatatype.
DeclarationFinder(Project project, FilterType filterType, IDatatype type, boolean onlyToplevel)	Constructor for specifying whether search results should be filtered regarding the specified IDatatype and whether only toplevel variables should be retrieved.

Method Summary

Modifier and Type	Method	Description
private void	addDeclaration(AbstractVariable decl)	Adds a visited AbstractVariable to the correct list of found declarations, depending on whether the variable is visible (no interface or exported by an interface) or is hidden.
List<AbstractVariable>	getVariableDeclarations(DeclarationFinder.VisibilityType type)	Getter for returning all DecisionVariableDeclarations of a Project.
private boolean	isVisible(AbstractVariable decl)	Checks whether a given variables is hidden by an interface or visible.
void	visitAttributeAssignment(AttributeAssignment assignment)	Visits an attribute assignment.
void	visitCompound(Compound compound)	Method for visiting a compound.
void	visitCompoundAccessStatement(CompoundAccessStatement access)	Visits a compound access statement (may occur in freeze blocks.
void	visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)	This method is used for visiting a decision variable declaration.
void	visitProjectImport(ProjectImport pImport)	This method is used for visiting a ProjectImport.

Methods inherited from class net.ssehub.easy.varModel.model.filter.AbstractDeclarationFinder

visitAttribute, visitComment, visitConstraint, visitDerivedDatatype, visitEnum, visitEnumLiteral, visitFreezeBlock, visitOperationDefinition, visitOrderedEnum, visitPartialEvaluationBlock, visitProjectInterface, visitReference, visitSequence, visitSet

Methods inherited from class net.ssehub.easy.varModel.model.AbstractProjectVisitor

clear, getFilterType, getStartingProject, visitProject

Methods inherited from class java.lang.Object

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

Field Details

visibleDeclarations

private List<AbstractVariable> visibleDeclarations

hiddenDeclarations

private List<AbstractVariable> hiddenDeclarations

allDeclarations

private List<AbstractVariable> allDeclarations

type

private IDatatype type

interfaces

private Stack<Set<AbstractVariable>> interfaces

onlyToplevel

private boolean onlyToplevel

Constructor Details

DeclarationFinder

public DeclarationFinder(Project project,
 FilterType filterType,
 IDatatype type)

Constructor for specifying whether search results should be filtered regarding the specified IDatatype. Will only find toplevel declarations.

Parameters:

project - The project where all DecisionVariableDeclarations should be found.

filterType - Specifies whether project imports shall be considered or not.

type - If type is not null only declarations matching the specified type will be found

DeclarationFinder

public DeclarationFinder(Project project,
 FilterType filterType,
 IDatatype type,
 boolean onlyToplevel)

Constructor for specifying whether search results should be filtered regarding the specified IDatatype and whether only toplevel variables should be retrieved.

Parameters:

project - The project where all DecisionVariableDeclarations should be found.

filterType - Specifies whether project imports shall be considered or not.

type - If type is not null only declarations matching the specified type will be found

onlyToplevel - true only toplevel declarations will be found, false will also consider declarations inside compounds.

Method Details

getVariableDeclarations

public List<AbstractVariable> getVariableDeclarations(DeclarationFinder.VisibilityType type)

Getter for returning all DecisionVariableDeclarations of a Project.

Parameters:

type - Specification whether only exported, not exported, or all declarations shall be returned:

• DeclarationFinder.VisibilityType.ONLY_EXPORTED: All variables which are not hidden by an interface will be returned.
• DeclarationFinder.VisibilityType.ONLY_HIDDEN: All variables which are hidden by an interface will be returned.
• DeclarationFinder.VisibilityType.ALL: All variables be returned.

Returns:

A List with all top-level DecisionVariableDeclarations

visitProjectImport

public void visitProjectImport(ProjectImport pImport)

Description copied from interface: IModelVisitor

This method is used for visiting a ProjectImport.

Specified by:

visitProjectImport in interface IModelVisitor

Overrides:

visitProjectImport in class AbstractProjectVisitor

Parameters:

pImport - One ProjectImport which should be visited.

visitDecisionVariableDeclaration

public void visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)

Description copied from interface: IModelVisitor

This method is used for visiting a decision variable declaration.

Parameters:

decl - One declaration which should be visited.

visitAttributeAssignment

public void visitAttributeAssignment(AttributeAssignment assignment)

Description copied from interface: IModelVisitor

Visits an attribute assignment.

Parameters:

assignment - the assignment to visit

isVisible

private boolean isVisible(AbstractVariable decl)

Checks whether a given variables is hidden by an interface or visible.

Parameters:

decl - The AbstractVariable to check.

Returns:

false if the variable is hidden by an interface, true otherwise

addDeclaration

private void addDeclaration(AbstractVariable decl)

Adds a visited AbstractVariable to the correct list of found declarations, depending on whether the variable is visible (no interface or exported by an interface) or is hidden.

Parameters:

decl - A AbstractVariable which shall be added to the list found declarations (getVariableDeclarations(VisibilityType).

See Also:

• isVisible(AbstractVariable)

visitCompoundAccessStatement

public void visitCompoundAccessStatement(CompoundAccessStatement access)

Description copied from interface: IModelVisitor

Visits a compound access statement (may occur in freeze blocks.

Parameters:

access - the access statement

visitCompound

public void visitCompound(Compound compound)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a compound.

Specified by:

visitCompound in interface ICustomDatatypeVisitor

Overrides:

visitCompound in class AbstractDeclarationFinder

Parameters:

compound - The compound which should be visited.