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

Class StringResolver<I extends VariableDeclaration,R extends Resolver<I>,E extends ExpressionStatement>

java.lang.Object

net.ssehub.easy.instantiation.core.model.expressions.StringParser<CompositeExpression,I,R>

net.ssehub.easy.instantiation.core.model.expressions.StringResolver<I,R,E>

Type Parameters:

I - the actual variable declaration type

R - the actual resolver type

E - the actual expression statement type

All Implemented Interfaces:

IMessageReceiver

public class StringResolver<I extends VariableDeclaration,R extends Resolver<I>,E extends ExpressionStatement>
extends StringParser<CompositeExpression,I,R>
implements IMessageReceiver

StringResolver to resolve variables and expressions on compiling. Use the StringReplacer if you need to replace expressions or variables on runtime.

Author:

Sass, Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StringResolver.IExpressionTranslator<I extends VariableDeclaration,R extends Resolver<I>>	The general interface of an expression translator.

Nested classes/interfaces inherited from class net.ssehub.easy.instantiation.core.model.expressions.StringParser

StringParser.State

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<Expression>	expressions
private StringResolver.IExpressionTranslator<I,R>	translator
private java.lang.StringBuilder	warnings

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StringResolver(java.lang.String text, R resolver, StringResolver.IExpressionTranslator<I,R> translator, java.lang.StringBuilder warnings, IStringParserFactory<I> factory)	Creates a replacer instance.

Method Summary

Modifier and Type	Method	Description
private void	appendWarning(java.lang.String message)	Appends message as a warning.
static void	appendWarning(java.lang.StringBuilder warnings, java.lang.String message)	Appends message as a warning.
void	collect(IMessage message, org.eclipse.emf.ecore.EObject cause, org.eclipse.emf.ecore.EStructuralFeature causeFeature, int code)	Receives an EASy message.
protected CompositeExpression	createParseResult()	Creates the result of parsing a string.
void	error(java.lang.String message, org.eclipse.emf.ecore.EObject cause, org.eclipse.emf.ecore.EStructuralFeature causeFeature, int code)	Receives an error message.
private void	handleConstant(int curStart, int position)	Handle constant placeholder from curStart until position.
private java.util.List<Expression>	handleConstant(java.lang.String text)	Handle constant for a given text.
protected int	handleEndOfText(int curStart, int pos, StringParser.State state)	Handles the very end of text at so far unhandled state.
protected int	handleExpression(int curStart, int pos)	Handle an expression placeholder.
protected void	handleQuote(int pos)	Called to handle a quote character at pos (beginning) of the internal parse buffer.
protected void	handleTextEnd(int curStart, int pos)	Handles the end of the text if there is no variable/expression.
protected int	handleVariable(int curStart, int pos)	Handle a variable placeholder.
protected int	handleVariableStartExpression(int curStart, int pos)	Handles the transition from state StringParser.State.VARIABLE_START to StringParser.State.EXPRESSION.
protected int	handleVariableStartVariable(int curStart, int pos)	Handles the transition from state StringParser.State.VARIABLE_START to StringParser.State.VARIABLE.
protected Expression	parseExpressionImpl(java.lang.String expressionString)	Parses an expression from expressionString.
protected CompositeExpression	resolveVariable(java.lang.String text)	Handle variable.
static <I extends VariableDeclaration,R extends Resolver<I>,E extends ExpressionStatement> Expression	substitute(java.lang.String text, R resolver, StringResolver.IExpressionTranslator<I,R> translator, java.lang.StringBuilder warnings, IStringParserFactory<I> factory)	Substitutes a given text and returns a CompositeExpression.
void	warning(java.lang.String message, org.eclipse.emf.ecore.EObject cause, org.eclipse.emf.ecore.EStructuralFeature causeFeature, int code)	Receives a warning message.

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

addExpression, charAt, clearStatementStack, consume, consumeJavaIdentifierPart, consumeWhitespaces, createConstantStringExpression, delete, deleteCharAt, getCurrentInPlaceCommand, getFactory, getLogger, getResolver, handleInPlaceCommands, isNonEmptyCommandStack, join, length, notifyBracketsClosed, notifyEndInPlaceCommand, notifyStartInPlaceCommand, parse, parseExpression, popFromCommandStack, removePrefix, replace, setPos, substring, toText, warnParsingIgnoring

Methods inherited from class java.lang.Object

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

Field Detail

translator

private StringResolver.IExpressionTranslator<I extends VariableDeclaration,R extends Resolver<I>> translator

warnings

private java.lang.StringBuilder warnings

expressions

private java.util.List<Expression> expressions

Constructor Detail

StringResolver

private StringResolver(java.lang.String text,
                       R resolver,
                       StringResolver.IExpressionTranslator<I,R> translator,
                       java.lang.StringBuilder warnings,
                       IStringParserFactory<I> factory)

Creates a replacer instance.

Parameters:

text - the text to be analyzed

translator - the translator to be used

resolver - the resolver to be used

warnings - to collect warnings (may be null)

factory - a factory turning in-place commands into language-specific expressions (may be null, then in-place commands are not resolved but remain as string expressions)

Method Detail

substitute

public static <I extends VariableDeclaration,R extends Resolver<I>,E extends ExpressionStatement> Expression substitute(java.lang.String text,
                                                                                                                                    R resolver,
                                                                                                                                    StringResolver.IExpressionTranslator<I,R> translator,
                                                                                                                                    java.lang.StringBuilder warnings,
                                                                                                                                    IStringParserFactory<I> factory)
                                                                                                                             throws VilException

Substitutes a given text and returns a CompositeExpression.

Type Parameters:

I - the variable declaration type

R - the resolver type

E - the expression statement type

Parameters:

text - the text to be analyzed

resolver - the resolver to be used.

translator - the translator to be used.

warnings - an optional (may be null buffer to collect warnings

factory - a factory turning in-place commands into language-specific expressions (may be null, then in-place commands are not resolved but remain as string expressions)

Returns:

a CompositeExpression

Throws:

VilException - delegates the exception

createParseResult

protected CompositeExpression createParseResult()
                                         throws VilException

Description copied from class: StringParser

Creates the result of parsing a string.

Specified by:

createParseResult in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Returns:

the result

Throws:

VilException - in case of evaluation problems

See Also:

StringParser.parse()

handleQuote

protected void handleQuote(int pos)
                    throws VilException

Description copied from class: StringParser

Called to handle a quote character at pos (beginning) of the internal parse buffer.

Specified by:

handleQuote in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

pos - the position within the parse buffer

Throws:

VilException - in case of evaluation problems

handleTextEnd

protected void handleTextEnd(int curStart,
                             int pos)
                      throws VilException

Description copied from class: StringParser

Handles the end of the text if there is no variable/expression.

Specified by:

handleTextEnd in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the actual position (end of text)

Throws:

VilException - in case of evaluation problems

handleVariableStartExpression

protected int handleVariableStartExpression(int curStart,
                                            int pos)
                                     throws VilException

Description copied from class: StringParser

Handles the transition from state StringParser.State.VARIABLE_START to StringParser.State.EXPRESSION.

Specified by:

handleVariableStartExpression in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the actual position

Returns:

the next start position (typically pos, ignored if negative)

Throws:

VilException - in case of evaluation problems

handleVariableStartVariable

protected int handleVariableStartVariable(int curStart,
                                          int pos)
                                   throws VilException

Description copied from class: StringParser

Handles the transition from state StringParser.State.VARIABLE_START to StringParser.State.VARIABLE.

Specified by:

handleVariableStartVariable in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the actual position

Returns:

the next start position (typically pos, ignored if negative)

Throws:

VilException - in case of evaluation problems

handleEndOfText

protected int handleEndOfText(int curStart,
                              int pos,
                              StringParser.State state)
                       throws VilException

Description copied from class: StringParser

Handles the very end of text at so far unhandled state.

Specified by:

handleEndOfText in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the current position

state - the current state

Returns:

the next start position (typically pos, ignored if negative)

Throws:

VilException - in case of evaluation problems

handleExpression

protected int handleExpression(int curStart,
                               int pos)
                        throws VilException

Description copied from class: StringParser

Handle an expression placeholder. start points to "${", pos to "}". name.

Specified by:

handleExpression in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the actual/end position

Returns:

the next start position (typically pos, ignored if negative)

Throws:

VilException - in case of evaluation problems

See Also:

StringParser.parse()

parseExpressionImpl

protected Expression parseExpressionImpl(java.lang.String expressionString)
                                  throws VilException

Description copied from class: StringParser

Parses an expression from expressionString.

Specified by:

parseExpressionImpl in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

expressionString - the string representation of the expression

Returns:

the parsed expression

Throws:

VilException - in case that parsing/creating the expression fails

handleConstant

private void handleConstant(int curStart,
                            int position)
                     throws VilException

Handle constant placeholder from curStart until position.

Parameters:

curStart - the current start position

position - the actual position in the text.

Throws:

VilException - in case of evaluation problems

handleConstant

private java.util.List<Expression> handleConstant(java.lang.String text)
                                           throws VilException

Handle constant for a given text. Splits the text into constants by seperating the string on whitespaces.

Parameters:

text - to be analyzed

Returns:

List of ConstantExpressions

Throws:

VilException - in case of evaluation problems

resolveVariable

protected CompositeExpression resolveVariable(java.lang.String text)

Handle variable.

Parameters:

text - the variable name

Returns:

CompositeExpression containing the variable

handleVariable

protected int handleVariable(int curStart,
                             int pos)
                      throws VilException

Description copied from class: StringParser

Handle a variable placeholder. start points to "$", pos to the end position of the variable name.

Specified by:

handleVariable in class StringParser<CompositeExpression,I extends VariableDeclaration,R extends Resolver<I>>

Parameters:

curStart - the start position

pos - the actual/end position

Returns:

the next start position (typically pos, ignored if negative)

Throws:

VilException - in case of evaluation problems

See Also:

StringParser.parse()

error

public void error(java.lang.String message,
                  org.eclipse.emf.ecore.EObject cause,
                  org.eclipse.emf.ecore.EStructuralFeature causeFeature,
                  int code)

Description copied from interface: IMessageReceiver

Receives an error message.

Specified by:

error in interface IMessageReceiver

Parameters:

message - the message

cause - the cause (as instance of the EMF grammar model)

causeFeature - the cause of the feature as an appropriate constant from IvmlPackage.Literals

code - a numerical identification of the error

warning

public void warning(java.lang.String message,
                    org.eclipse.emf.ecore.EObject cause,
                    org.eclipse.emf.ecore.EStructuralFeature causeFeature,
                    int code)

Description copied from interface: IMessageReceiver

Receives a warning message.

Specified by:

warning in interface IMessageReceiver

Parameters:

message - the message

cause - the cause (as instance of the EMF grammar model)

causeFeature - the cause of the feature as an appropriate constant from IvmlPackage.Literals

code - a numerical identification of the warning

collect

public void collect(IMessage message,
                    org.eclipse.emf.ecore.EObject cause,
                    org.eclipse.emf.ecore.EStructuralFeature causeFeature,
                    int code)

Description copied from interface: IMessageReceiver

Receives an EASy message. This allows re-directing the message while keeping the relation to the original one, e.g., for cleaning up messages.

Specified by:

collect in interface IMessageReceiver

Parameters:

message - the message

cause - the cause (as instance of the EMF grammar model)

causeFeature - the cause of the feature as an appropriate constant from IvmlPackage.Literals

code - a numerical identification of the error

appendWarning

private void appendWarning(java.lang.String message)

Appends message as a warning.

Parameters:

message - the message to append

appendWarning

public static void appendWarning(java.lang.StringBuilder warnings,
                                 java.lang.String message)

Appends message as a warning.

Parameters:

warnings - the warnings collected so far, nothing will happen if null

message - the message to append