org.eclipse.ocl.parser

Class OCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

java.lang.Object

org.eclipse.ocl.lpg.AbstractAnalyzer

org.eclipse.ocl.parser.AbstractOCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

org.eclipse.ocl.parser.OCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Direct Known Subclasses:

OCLAnalyzer

public class OCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>
extends AbstractOCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

The OCLAnalyzer performs semantic analysis on a CST produced by an OCLParser to create the OCL AST. It is necessary that syntactic parsing and semantic analysis are performed in two steps because LPG is a bottom up parser and cannot provide enough contextual information to create the AST on the first pass.

Field Summary

Fields inherited from class org.eclipse.ocl.parser.AbstractOCLAnalyzer

IMPLICIT_SET_CONVERSION, OCL_ANNOTATIONS_URI

Constructor Summary

Constructors

Constructor and Description
OCLAnalyzer(AbstractOCLParser parser) Construct an OCL semantic analyzer that will use a given parser to perform syntactic and lexical analysis.
OCLAnalyzer(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> environment) Construct an OCL semantic analyzer with default syntactic and lexical parsers all operating within a given environment.
OCLAnalyzer(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> environment, String text) Construct an OCL semantic analyzer with default syntactic and lexical parsers all operating within a given environment.
OCLAnalyzer(OCLParser parser) Construct an OCL semantic analyzer that will use a given parser to perform syntactic and lexical analysis.

Method Summary

Modifier and Type	Method and Description
void	ERROR(List<?> problemObjects, String rule, String problemMessage)
void	ERROR(Object problemObject, String rule, String problemMessage)
void	ERROR(String problemMessage)
OCLParser	getParser() Deprecated. Use the AbstractOCLAnalyzer.getAbstractParser() method, instead
OCLExpression<C>	parseAST(OCLExpressionCS cst, ConstraintKind constraintType) Parses the specified concrete syntax model to an abstract syntax model.
CSTNode	parseConcreteSyntax() Performs a concrete-syntax parser and throws ParserException if any parse errors are encountered.
CT	parseInitOrDerValueCS() Parses the input as an InitOrDerValueCS.
CT	parseInvOrDefCS() Parses the input as an InvOrDefCS.
List<CT>	parseOCLDocument(List<CT> constraints) Parses the input as an OCLDocumentCS.
List<CT>	parsePackageDeclarationCS(List<CT> constraints) Parses the input as a PackageDeclarationCS.
CT	parsePrePostOrBodyDeclCS() Parses the input as a PrePostOrBodyDeclCS.
Variable<C,PM>	parseVariableDeclarationCS(boolean addToEnvironment) Parses the input as a VariableDeclarationCS.

Methods inherited from class org.eclipse.ocl.parser.AbstractOCLAnalyzer

createSequenceOfNames, equalName, getAbstractParser, getOCLEnvironment, isEscaped, isIdentifierOrKeyword, unescape

Methods inherited from class org.eclipse.ocl.lpg.AbstractAnalyzer

computeInputString, dumpTokens, formatClass, formatEClassName, formatName, formatPath, formatPath, formatQualifiedName, formatString, formatType, getCharOffset, getEnvironment, getFormatter, getLexer, getTraceFlag, initialize, initialize, reset, reset, setCharacterOffset, setFileName, setTab, setTraceFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

OCLAnalyzer

public OCLAnalyzer(AbstractOCLParser parser)

Construct an OCL semantic analyzer that will use a given parser to perform syntactic and lexical analysis.

Parameters:

parser - the syntactic (and lexical) parser

Since:

1.3

OCLAnalyzer

public OCLAnalyzer(OCLParser parser)

Construct an OCL semantic analyzer that will use a given parser to perform syntactic and lexical analysis.

Parameters:

parser - the syntactic (and lexical) parser

OCLAnalyzer

public OCLAnalyzer(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> environment)

Construct an OCL semantic analyzer with default syntactic and lexical parsers all operating within a given environment.

Parameters:

environment - the symbolic and problem handling environment

OCLAnalyzer

public OCLAnalyzer(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> environment,
                   String text)

Construct an OCL semantic analyzer with default syntactic and lexical parsers all operating within a given environment. Then prime the analyzer by performing keyword and lexical parsing of the given source text.

Parameters:

environment - the symbolic and problem handling environment

text - the source text for analysis

Method Detail

getParser

@Deprecated
public OCLParser getParser()

Deprecated. Use the AbstractOCLAnalyzer.getAbstractParser() method, instead

Description copied from class: AbstractAnalyzer

Obtains my parser.

Overrides:

getParser in class AbstractOCLAnalyzer<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Returns:

my parser

parseConcreteSyntax

public CSTNode parseConcreteSyntax()

Performs a concrete-syntax parser and throws ParserException if any parse errors are encountered.

Returns:

the parsed CST, or null if it could not be parsed

parseAST

public OCLExpression<C> parseAST(OCLExpressionCS cst,
                                 ConstraintKind constraintType)

Parses the specified concrete syntax model to an abstract syntax model. The result is contained by an Constraint, so care must be taken when the result is no longer needed to dispose of the entire tree rooted in the Constraint.

Parameters:

cst - the OCL concrete syntax model

constraintType - the kind of constraint to parse

Returns:

the OCL expression, if it successfully parsed

parseOCLDocument

public List<CT> parseOCLDocument(List<CT> constraints)

Parses the input as an OCLDocumentCS.

Parameters:

constraints - the constraints list to populate

Returns:

the parsed constraints (as many as could be parsed)

Since:

1.3

parsePackageDeclarationCS

public List<CT> parsePackageDeclarationCS(List<CT> constraints)

Parses the input as a PackageDeclarationCS.

Parameters:

constraints -

Returns:

the parsed constraints (as many as could be parsed)

parseInvOrDefCS

public CT parseInvOrDefCS()

Parses the input as an InvOrDefCS.

Returns:

the parsed OCL constraint, or null if it could not be parsed

parsePrePostOrBodyDeclCS

public CT parsePrePostOrBodyDeclCS()

Parses the input as a PrePostOrBodyDeclCS.

Returns:

the parsed OCL constraint, or null if it could not be parsed

parseInitOrDerValueCS

public CT parseInitOrDerValueCS()

Parses the input as an InitOrDerValueCS.

Returns:

the parsed OCL constraint, or null if it could not be parsed

parseVariableDeclarationCS

public Variable<C,PM> parseVariableDeclarationCS(boolean addToEnvironment)

Parses the input as a VariableDeclarationCS.

Parameters:

addToEnvironment - boolean whether or not to add the the parsed variable to the environment

Returns:

the parsed variable declaration, or null if it could not be parsed

ERROR

public void ERROR(List<?> problemObjects,
                  String rule,
                  String problemMessage)

Overrides:

ERROR in class AbstractAnalyzer

ERROR

public void ERROR(Object problemObject,
                  String rule,
                  String problemMessage)

Overrides:

ERROR in class AbstractAnalyzer

ERROR

public void ERROR(String problemMessage)

Overrides:

ERROR in class AbstractAnalyzer