Package net.ssehub.easy.varModel.model.search

Class PrefixSearchVisitor

java.lang.Object

net.ssehub.easy.varModel.model.AbstractVisitor

net.ssehub.easy.varModel.model.search.PrefixSearchVisitor

All Implemented Interfaces:

IConstraintTreeVisitor, ICustomDatatypeVisitor, IModelVisitor

public class PrefixSearchVisitor
extends AbstractVisitor
implements IConstraintTreeVisitor

Realizes a visitor which searches for a given prefix in a given context and returns all matching model elements.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private SearchContext	context
private DatatypeVisitor	datatypeVisitor
private boolean	inInterface
private java.util.HashSet<java.lang.Object>	inResult
private static java.util.List<PrefixSearchVisitor>	INSTANCES
private java.util.Stack<Project>	nesting
private java.lang.String	prefix
private java.lang.Class<?>[]	restrictions
private java.util.List<SearchResult>	result

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PrefixSearchVisitor()	Constructs an instances.

Method Summary

Modifier and Type	Method	Description
private void	checkName(java.lang.String name, java.lang.Object element)	Checks a name for inclusion.
private void	checkName(ModelElement element)	Checks a model element for inclusion.
private java.lang.String	checkType(IDatatype type, ModelElement element)	Checks a type for inclusion.
void	clear()	Clears the results for reusing this instance.
static PrefixSearchVisitor	getInstance(java.lang.String prefix, DatatypeVisitor datatypeVisitor, SearchContext context, java.lang.Class<?>... restrictions)	Obtains a (pooled) instance.
java.util.List<SearchResult>	getResult()	Returns the collected results.
private void	prepareInstance(java.lang.String prefix, DatatypeVisitor datatypeVisitor, SearchContext context, java.lang.Class<?>... restrictions)	Prepares a (reused) instance.
static void	release(PrefixSearchVisitor visitor)	Releases a given visitor.
private boolean	resultContains(java.lang.Object object)	Returns whether the object is part of the result.
void	visitAnnotationVariable(AttributeVariable variable)	Visits a AttributeVariable.
void	visitAttribute(Attribute attribute)	Method for visiting an attribute.
void	visitAttributeAssignment(AttributeAssignment assignment)	Visits an attribute assignment.
void	visitBlockExpression(BlockExpression block)	Visits the block.
void	visitComment(Comment comment)	Visits a comment.
void	visitComment(Comment comment)	Method for visiting a comment.
void	visitCompound(Compound compound)	Method for visiting a compound.
void	visitCompoundAccess(CompoundAccess access)	Visits a compound access node.
void	visitCompoundAccessStatement(CompoundAccessStatement access)	Visits a compound access statement (may occur in freeze blocks.
void	visitCompoundInitializer(CompoundInitializer init)	Visits a compound initializer.
void	visitConstantValue(ConstantValue value)	Visits a constant value.
void	visitConstraint(Constraint constraint)	Method for visiting a constraint.
void	visitContainerInitializer(ContainerInitializer init)	Visits a container initializer.
void	visitContainerOperationCall(ContainerOperationCall call)	Visits a container operation call (e.g.
void	visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)	This method is used for visiting a decision variable declaration.
void	visitDeferInitExpression(DeferInitExpression expression)	Visits a default init expression.
void	visitDerivedDatatype(DerivedDatatype datatype)	Method for visiting a derived datatype.
void	visitEnum(Enum eenum)	Method for visiting an enum.
void	visitEnumLiteral(EnumLiteral literal)	Method for visiting an enum literal.
void	visitFreezeBlock(FreezeBlock freeze)	Method for visiting a freeze block.
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	visitOperationDefinition(OperationDefinition opdef)	Method for visiting an operation definition.
void	visitOrderedEnum(OrderedEnum eenum)	Method for visiting an ordered enum.
void	visitParenthesis(Parenthesis parenthesis)	Visits a parenthesis.
void	visitPartialEvaluationBlock(PartialEvaluationBlock block)	Method for visiting a partial evaluation block.
void	visitProject(Project project)	Method for visiting a project.
void	visitProjectImport(ProjectImport pImport)	This method is used for visiting a ProjectImport.
void	visitProjectInterface(ProjectInterface iface)	Method for visiting a project interface.
void	visitReference(Reference reference)	Method for visiting a reference.
void	visitSelf(Self self)	Visits self.
void	visitSequence(Sequence sequence)	Method for visiting a sequence.
void	visitSet(Set set)	Method for visiting a set.
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

INSTANCES

private static final java.util.List<PrefixSearchVisitor> INSTANCES

result

private java.util.List<SearchResult> result

inResult

private java.util.HashSet<java.lang.Object> inResult

restrictions

private java.lang.Class<?>[] restrictions

prefix

private java.lang.String prefix

datatypeVisitor

private DatatypeVisitor datatypeVisitor

context

private SearchContext context

nesting

private java.util.Stack<Project> nesting

inInterface

private boolean inInterface

Constructor Detail

PrefixSearchVisitor

private PrefixSearchVisitor()

Constructs an instances. Prevents that instance can be created from outside.

Method Detail

getInstance

public static final PrefixSearchVisitor getInstance(java.lang.String prefix,
                                                    DatatypeVisitor datatypeVisitor,
                                                    SearchContext context,
                                                    java.lang.Class<?>... restrictions)

Obtains a (pooled) instance. The result must be released by release(PrefixSearchVisitor).

Parameters:

prefix - the name search prefix

datatypeVisitor - the visitor for obtaining full type names

context - the search context (may be null)

restrictions - type restrictions on search results (may be null)

Returns:

the visitor

release

public static final void release(PrefixSearchVisitor visitor)

Releases a given visitor. Do not use visitor afterwards.

Parameters:

visitor - the visitor to be released

prepareInstance

private void prepareInstance(java.lang.String prefix,
                             DatatypeVisitor datatypeVisitor,
                             SearchContext context,
                             java.lang.Class<?>... restrictions)

Prepares a (reused) instance.

Parameters:

prefix - the name search prefix

datatypeVisitor - the visitor for obtaining full type names

context - the search context (may be null)

restrictions - type restrictions on search results (may be null)

getResult

public java.util.List<SearchResult> getResult()

Returns the collected results.

Returns:

the results

clear

public void clear()

Clears the results for reusing this instance.

checkName

private void checkName(java.lang.String name,
                       java.lang.Object element)

Checks a name for inclusion.

Parameters:

name - the name to be checked

element - the element associated with name

checkName

private void checkName(ModelElement element)

Checks a model element for inclusion. This method checks the simple and the qualified name of element.

Parameters:

element - the element to be checked

checkType

private java.lang.String checkType(IDatatype type,
                                   ModelElement element)

Checks a type for inclusion.

Parameters:

type - the type to be checked

element - the element which uses or defines type

Returns:

the explicated name of the type using datatypeVisitor

resultContains

private boolean resultContains(java.lang.Object object)

Returns whether the object is part of the result.

Parameters:

object - the object to check for

Returns:

true if object is part of the result, false else

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

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.

Specified by:

visitDecisionVariableDeclaration in interface IModelVisitor

Parameters:

decl - One declaration which should be visited.

visitAttribute

public void visitAttribute(Attribute attribute)

Description copied from interface: IModelVisitor

Method for visiting an attribute.

Specified by:

visitAttribute in interface IModelVisitor

Parameters:

attribute - The attribute which should be visited.

visitConstraint

public void visitConstraint(Constraint constraint)

Description copied from interface: IModelVisitor

Method for visiting a constraint.

Specified by:

visitConstraint in interface IModelVisitor

Parameters:

constraint - The constraint which should be visited.

visitFreezeBlock

public void visitFreezeBlock(FreezeBlock freeze)

Description copied from interface: IModelVisitor

Method for visiting a freeze block.

Specified by:

visitFreezeBlock in interface IModelVisitor

Parameters:

freeze - The freeze block which should be visited.

visitOperationDefinition

public void visitOperationDefinition(OperationDefinition opdef)

Description copied from interface: IModelVisitor

Method for visiting an operation definition.

Specified by:

visitOperationDefinition in interface IModelVisitor

Parameters:

opdef - The operation definition which should be visited.

visitPartialEvaluationBlock

public void visitPartialEvaluationBlock(PartialEvaluationBlock block)

Description copied from interface: IModelVisitor

Method for visiting a partial evaluation block.

Specified by:

visitPartialEvaluationBlock in interface IModelVisitor

Parameters:

block - The partial evaluation block which should be visited.

visitProject

public void visitProject(Project project)

Description copied from interface: IModelVisitor

Method for visiting a project.

Specified by:

visitProject in interface IModelVisitor

Overrides:

visitProject in class AbstractVisitor

Parameters:

project - The project which should be visited.

visitEnum

public void visitEnum(Enum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum.

Specified by:

visitEnum in interface ICustomDatatypeVisitor

Overrides:

visitEnum in class AbstractVisitor

Parameters:

eenum - The enum which should be visited.

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 AbstractVisitor

Parameters:

compound - The compound which should be visited.

visitProjectInterface

public void visitProjectInterface(ProjectInterface iface)

Description copied from interface: IModelVisitor

Method for visiting a project interface.

Specified by:

visitProjectInterface in interface IModelVisitor

Parameters:

iface - The interface which should be visited.

visitOrderedEnum

public void visitOrderedEnum(OrderedEnum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an ordered enum.

Specified by:

visitOrderedEnum in interface ICustomDatatypeVisitor

Overrides:

visitOrderedEnum in class AbstractVisitor

Parameters:

eenum - The enum which should be visited.

visitDerivedDatatype

public void visitDerivedDatatype(DerivedDatatype datatype)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a derived datatype.

Specified by:

visitDerivedDatatype in interface ICustomDatatypeVisitor

Parameters:

datatype - The datatype which should be visited.

visitEnumLiteral

public void visitEnumLiteral(EnumLiteral literal)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum literal.

Specified by:

visitEnumLiteral in interface ICustomDatatypeVisitor

Parameters:

literal - The literal which should be visited.

visitReference

public void visitReference(Reference reference)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a reference.

Specified by:

visitReference in interface ICustomDatatypeVisitor

Parameters:

reference - The reference which should be visited.

visitSequence

public void visitSequence(Sequence sequence)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a sequence.

Specified by:

visitSequence in interface ICustomDatatypeVisitor

Parameters:

sequence - The sequence which should be visited.

visitSet

public void visitSet(Set set)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a set.

Specified by:

visitSet in interface ICustomDatatypeVisitor

Parameters:

set - The set which should be visited.

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

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

visitContainerInitializer

public void visitContainerInitializer(ContainerInitializer init)

Description copied from interface: IConstraintTreeVisitor

Visits a container initializer.

Specified by:

visitContainerInitializer in interface IConstraintTreeVisitor

Parameters:

init - the container initializer node

visitCompoundInitializer

public void visitCompoundInitializer(CompoundInitializer init)

Description copied from interface: IConstraintTreeVisitor

Visits a compound initializer.

Specified by:

visitCompoundInitializer in interface IConstraintTreeVisitor

Parameters:

init - the compound initializer node

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

visitDeferInitExpression

public void visitDeferInitExpression(DeferInitExpression expression)

Description copied from interface: IConstraintTreeVisitor

Visits a default init expression.

Specified by:

visitDeferInitExpression in interface IConstraintTreeVisitor

Parameters:

expression - the expression

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

visitComment

public void visitComment(Comment comment)

Description copied from interface: IModelVisitor

Method for visiting a comment.

Specified by:

visitComment in interface IModelVisitor

Parameters:

comment - the comment to visit

visitAttributeAssignment

public void visitAttributeAssignment(AttributeAssignment assignment)

Description copied from interface: IModelVisitor

Visits an attribute assignment.

Specified by:

visitAttributeAssignment in interface IModelVisitor

Parameters:

assignment - the assignment to visit

visitCompoundAccessStatement

public void visitCompoundAccessStatement(CompoundAccessStatement access)

Description copied from interface: IModelVisitor

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

Specified by:

visitCompoundAccessStatement in interface IModelVisitor

Parameters:

access - the access statement

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