org.eclipse.ocl.pivot.utilities

Class PivotHelper

java.lang.Object

org.eclipse.ocl.pivot.utilities.PivotHelper

public class PivotHelper
extends java.lang.Object

PivotHelper provides helper routines to assist creation of Pivot model elements.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field and Description
protected EnvironmentFactory	environmentFactory
protected StandardLibrary	standardLibrary

Constructor Summary

Constructors

Constructor and Description
PivotHelper(EnvironmentFactory environmentFactory)

Method Summary

Modifier and Type	Method and Description
BooleanLiteralExp	createBooleanLiteralExp(boolean booleanSymbol)
CollectionItem	createCollectionItem(OCLExpression asItem)
CollectionLiteralExp	createCollectionLiteralExp(CollectionType asType, java.lang.Iterable<CollectionLiteralPart> asParts)
CollectionRange	createCollectionRange(OCLExpression asFirst, OCLExpression asLast)
Comment	createComment(java.lang.String comment)
IfExp	createIfExp(OCLExpression asCondition, OCLExpression asThen, OCLExpression asElse)
Import	createImport(java.lang.String name, Namespace namespace)
IntegerLiteralExp	createIntegerLiteralExp(java.lang.Number integerSymbol)
InvalidLiteralExp	createInvalidExpression()
IterateExp	createIterateExp(OCLExpression asSource, Iteration asIteration, java.util.List<? extends Variable> asIterators, Variable asResult, OCLExpression asBody)
IteratorExp	createIteratorExp(OCLExpression asSource, Iteration asIteration, java.util.List<? extends Variable> asIterators, OCLExpression asBody)
IteratorVariable	createIteratorVariable(java.lang.String name, Type asType, boolean isRequired)
LetExp	createLetExp(Variable asVariable, OCLExpression asInExpression)
LetVariable	createLetVariable(java.lang.String name, OCLExpression asInitExpression)
LetVariable	createLetVariable(java.lang.String name, Type asType, boolean isRequired)
LetVariable	createLetVariable(java.lang.String name, Type asType, boolean isRequired, OCLExpression asInitExpression)
OCLExpression	createMapLiteralExp(MapType asType, java.lang.Iterable<MapLiteralPart> asParts)
MapLiteralPart	createMapLiteralPart(OCLExpression asKey, OCLExpression asValue)
NavigationCallExp	createNavigationCallExp(OCLExpression asSourceExpression, Property asProperty)
NullLiteralExp	createNullLiteralExp()
OperationCallExp	createOperationCallExp(OCLExpression asSourceExpression, Operation asOperation, java.util.List<OCLExpression> asArguments)
OperationCallExp	createOperationCallExp(OCLExpression asSourceExpression, java.lang.String opName, OCLExpression... asArguments)
Package	createPackage(java.lang.String name, java.lang.String nsPrefix, java.lang.String nsURI)
Parameter	createParameter(TypedElement typedElement)
ParameterVariable	createParameterVariable(java.lang.String name, Type asType, boolean isRequired)
RealLiteralExp	createRealLiteralExp(java.lang.Number realSymbol)
ResultVariable	createResultVariable(java.lang.String name, Type asType, boolean isRequired, OCLExpression asInitExpression)
OCLExpression	createShadowExp(Class asClass, java.lang.Iterable<ShadowPart> asParts)
ShadowPart	createShadowPart(Property asProperty, OCLExpression asValue)
StringLiteralExp	createStringLiteralExp(java.lang.String stringSymbol)
TupleLiteralExp	createTupleLiteralExp(TupleType asType, java.lang.Iterable<TupleLiteralPart> asParts)
TupleLiteralPart	createTupleLiteralPart(java.lang.String name, Type asType, boolean isRequired, OCLExpression asValue)
TypeExp	createTypeExp(Type type)
UnlimitedNaturalLiteralExp	createUnlimitedNaturalLiteralExp(java.lang.Number unlimitedNaturalSymbol)
Variable	createVariable(java.lang.String name, OCLExpression asInitExpression) Deprecated. Use appropriate derived Variable
Variable	createVariable(java.lang.String name, Type asType, boolean isRequired, OCLExpression asInitExpression) Deprecated. Use appropriate derived Variable
Variable	createVariable(TypedElement typedElement) Deprecated. Use appropriate derived Variable
VariableExp	createVariableExp(VariableDeclaration asVariable)
Class	getDataTypeClass()
Property	getDataTypeValueProperty()
EnvironmentFactory	getEnvironmentFactory()
protected PivotMetamodelManager	getMetamodelManager()
StandardLibrary	getStandardLibrary()
void	rewriteSafeNavigations(Element asTree) Rewrite asTree and all its descendants to replace all "?." and "?->" navigations by their safe counterparts.
void	setType(OCLExpression asExpression, Type type, boolean isRequired, Type typeValue)
void	setType(TypedElement asTypedElement, Type type, boolean isRequired)

Methods inherited from class java.lang.Object

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

Field Detail

environmentFactory

@NonNull
protected final EnvironmentFactory environmentFactory

standardLibrary

@NonNull
protected final StandardLibrary standardLibrary

Constructor Detail

PivotHelper

public PivotHelper(@NonNull
                   EnvironmentFactory environmentFactory)

Method Detail

createBooleanLiteralExp

@NonNull
public BooleanLiteralExp createBooleanLiteralExp(boolean booleanSymbol)

createCollectionItem

@NonNull
public CollectionItem createCollectionItem(@NonNull
                                                     OCLExpression asItem)

createCollectionLiteralExp

@NonNull
public CollectionLiteralExp createCollectionLiteralExp(@NonNull
                                                                 CollectionType asType,
                                                                 @NonNull
                                                                 java.lang.Iterable<CollectionLiteralPart> asParts)

createCollectionRange

@NonNull
public CollectionRange createCollectionRange(@NonNull
                                                       OCLExpression asFirst,
                                                       @NonNull
                                                       OCLExpression asLast)

createComment

@NonNull
public Comment createComment(@NonNull
                                       java.lang.String comment)

createIfExp

@NonNull
public IfExp createIfExp(@NonNull
                                   OCLExpression asCondition,
                                   @NonNull
                                   OCLExpression asThen,
                                   @NonNull
                                   OCLExpression asElse)

createImport

@NonNull
public Import createImport(@Nullable
                                     java.lang.String name,
                                     @NonNull
                                     Namespace namespace)

createIntegerLiteralExp

@NonNull
public IntegerLiteralExp createIntegerLiteralExp(@NonNull
                                                           java.lang.Number integerSymbol)

createInvalidExpression

@NonNull
public InvalidLiteralExp createInvalidExpression()

createIterateExp

@NonNull
public IterateExp createIterateExp(@NonNull
                                             OCLExpression asSource,
                                             @NonNull
                                             Iteration asIteration,
                                             @NonNull
                                             java.util.List<? extends Variable> asIterators,
                                             @NonNull
                                             Variable asResult,
                                             @NonNull
                                             OCLExpression asBody)

createIteratorExp

@NonNull
public IteratorExp createIteratorExp(@NonNull
                                               OCLExpression asSource,
                                               @NonNull
                                               Iteration asIteration,
                                               @NonNull
                                               java.util.List<? extends Variable> asIterators,
                                               @NonNull
                                               OCLExpression asBody)

createIteratorVariable

@NonNull
public IteratorVariable createIteratorVariable(@NonNull
                                                         java.lang.String name,
                                                         @NonNull
                                                         Type asType,
                                                         boolean isRequired)

createLetExp

@NonNull
public LetExp createLetExp(@NonNull
                                     Variable asVariable,
                                     @NonNull
                                     OCLExpression asInExpression)

createLetVariable

@NonNull
public LetVariable createLetVariable(@NonNull
                                               java.lang.String name,
                                               @NonNull
                                               OCLExpression asInitExpression)

createLetVariable

@NonNull
public LetVariable createLetVariable(@NonNull
                                               java.lang.String name,
                                               @NonNull
                                               Type asType,
                                               boolean isRequired)

createLetVariable

@NonNull
public LetVariable createLetVariable(@NonNull
                                               java.lang.String name,
                                               @NonNull
                                               Type asType,
                                               boolean isRequired,
                                               @NonNull
                                               OCLExpression asInitExpression)

createMapLiteralExp

@NonNull
public OCLExpression createMapLiteralExp(@NonNull
                                                   MapType asType,
                                                   @NonNull
                                                   java.lang.Iterable<MapLiteralPart> asParts)

createMapLiteralPart

@NonNull
public MapLiteralPart createMapLiteralPart(@NonNull
                                                     OCLExpression asKey,
                                                     @NonNull
                                                     OCLExpression asValue)

createNavigationCallExp

@NonNull
public NavigationCallExp createNavigationCallExp(@NonNull
                                                           OCLExpression asSourceExpression,
                                                           @NonNull
                                                           Property asProperty)

createNullLiteralExp

@NonNull
public NullLiteralExp createNullLiteralExp()

createOperationCallExp

@NonNull
public OperationCallExp createOperationCallExp(@NonNull
                                                         OCLExpression asSourceExpression,
                                                         @NonNull
                                                         java.lang.String opName,
                                                         @NonNull
                                                         OCLExpression... asArguments)

createOperationCallExp

@NonNull
public OperationCallExp createOperationCallExp(@Nullable
                                                         OCLExpression asSourceExpression,
                                                         @NonNull
                                                         Operation asOperation,
                                                         @Nullable
                                                         java.util.List<OCLExpression> asArguments)

createPackage

public Package createPackage(@NonNull
                             java.lang.String name,
                             @Nullable
                             java.lang.String nsPrefix,
                             @Nullable
                             java.lang.String nsURI)

createParameter

@NonNull
public Parameter createParameter(@NonNull
                                           TypedElement typedElement)

createParameterVariable

@NonNull
public ParameterVariable createParameterVariable(@NonNull
                                                           java.lang.String name,
                                                           @NonNull
                                                           Type asType,
                                                           boolean isRequired)

createRealLiteralExp

@NonNull
public RealLiteralExp createRealLiteralExp(@NonNull
                                                     java.lang.Number realSymbol)

createResultVariable

@NonNull
public ResultVariable createResultVariable(@NonNull
                                                     java.lang.String name,
                                                     @NonNull
                                                     Type asType,
                                                     boolean isRequired,
                                                     @NonNull
                                                     OCLExpression asInitExpression)

createShadowExp

@NonNull
public OCLExpression createShadowExp(Class asClass,
                                               @NonNull
                                               java.lang.Iterable<ShadowPart> asParts)

createShadowPart

@NonNull
public ShadowPart createShadowPart(@NonNull
                                             Property asProperty,
                                             @NonNull
                                             OCLExpression asValue)

createStringLiteralExp

@NonNull
public StringLiteralExp createStringLiteralExp(@NonNull
                                                         java.lang.String stringSymbol)

createTupleLiteralExp

@NonNull
public TupleLiteralExp createTupleLiteralExp(@NonNull
                                                       TupleType asType,
                                                       @NonNull
                                                       java.lang.Iterable<TupleLiteralPart> asParts)

createTupleLiteralPart

@NonNull
public TupleLiteralPart createTupleLiteralPart(@NonNull
                                                         java.lang.String name,
                                                         @NonNull
                                                         Type asType,
                                                         boolean isRequired,
                                                         @NonNull
                                                         OCLExpression asValue)

createTypeExp

@NonNull
public TypeExp createTypeExp(@NonNull
                                       Type type)

createUnlimitedNaturalLiteralExp

@NonNull
public UnlimitedNaturalLiteralExp createUnlimitedNaturalLiteralExp(@NonNull
                                                                             java.lang.Number unlimitedNaturalSymbol)

createVariable

@Deprecated
 @NonNull
public Variable createVariable(@NonNull
                                                       java.lang.String name,
                                                       @NonNull
                                                       OCLExpression asInitExpression)

Deprecated. Use appropriate derived Variable

createVariable

@Deprecated
 @NonNull
public Variable createVariable(@NonNull
                                                       java.lang.String name,
                                                       @NonNull
                                                       Type asType,
                                                       boolean isRequired,
                                                       @Nullable
                                                       OCLExpression asInitExpression)

Deprecated. Use appropriate derived Variable

createVariable

@Deprecated
 @NonNull
public Variable createVariable(@NonNull
                                                       TypedElement typedElement)

Deprecated. Use appropriate derived Variable

createVariableExp

@NonNull
public VariableExp createVariableExp(@NonNull
                                               VariableDeclaration asVariable)

getDataTypeClass

public Class getDataTypeClass()

getDataTypeValueProperty

@NonNull
public Property getDataTypeValueProperty()

getEnvironmentFactory

@NonNull
public EnvironmentFactory getEnvironmentFactory()

getMetamodelManager

@NonNull
protected PivotMetamodelManager getMetamodelManager()

getStandardLibrary

@NonNull
public StandardLibrary getStandardLibrary()

rewriteSafeNavigations

public void rewriteSafeNavigations(@NonNull
                                   Element asTree)

Rewrite asTree and all its descendants to replace all "?." and "?->" navigations by their safe counterparts.

Since:

1.3

setType

public void setType(@NonNull
                    OCLExpression asExpression,
                    Type type,
                    boolean isRequired,
                    @Nullable
                    Type typeValue)

setType

public void setType(@NonNull
                    TypedElement asTypedElement,
                    Type type,
                    boolean isRequired)