org.kie.pmml.compiler.commons.utils

Class CommonCodegenUtils

java.lang.Object

org.kie.pmml.compiler.commons.utils.CommonCodegenUtils

public class CommonCodegenUtils
extends Object

Class meant to provide helper methods to all code-generating classes

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTIONAL_FILTERED_KIEPMMLNAMEVALUE_NAME

Method Summary

Modifier and Type	Method and Description
static void	addMapPopulation(Map<String,com.github.javaparser.ast.body.MethodDeclaration> toAdd, com.github.javaparser.ast.stmt.BlockStmt body, String mapName) For every entry in the given map, add (mapName).put(entry_key, this::entry_value_ref>); e.g.
static com.github.javaparser.ast.body.MethodDeclaration	addMethod(com.github.javaparser.ast.body.MethodDeclaration methodTemplate, com.github.javaparser.ast.body.ClassOrInterfaceDeclaration tableTemplate, String methodName) Add a MethodDeclaration to the class
static Optional<com.github.javaparser.ast.expr.AssignExpr>	getAssignExpression(com.github.javaparser.ast.stmt.BlockStmt body, String assignExpressionName) Return an Optional<AssignExpr> with the given assignExpressionName from the given BlockStmt
static Optional<com.github.javaparser.ast.expr.NameExpr>	getExplicitConstructorInvocationParameter(com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt constructorInvocationStmt, String parameterName) Return an Optional<NameExpr> from the given ExplicitConstructorInvocationStmt
static Optional<com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt>	getExplicitConstructorInvocationStmt(com.github.javaparser.ast.stmt.BlockStmt body) Return an Optional<ExplicitConstructorInvocationStmt> from the given BlockStmt
static com.github.javaparser.ast.stmt.ExpressionStmt	getFilteredKiePMMLNameValueExpression(String kiePMMLNameValueListParam, String fieldNameToRef, boolean stringLiteralComparison) Returns Optional kiePMMLNameValue = (kiePMMLNameValueListParam) .stream() .filter((KiePMMLNameValue kpmmlnv) -> Objects.equals("(fieldNameToRef)", kpmmlnv.getName())) .findFirst(); expression, where kiePMMLNameValueListParam is the name of the List<KiePMMLNameValue> parameter, and fieldNameToRef is the name of the field to find, in the containing method
static Optional<com.github.javaparser.ast.body.MethodDeclaration>	getMethodDeclaration(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classOrInterfaceDeclaration, String methodName) Return an Optional<MethodDeclaration> with the first method methodName from the given ClassOrInterfaceDeclaration
static com.github.javaparser.ast.body.MethodDeclaration	getMethodDeclaration(String methodName) Returns empty (methodName)() { } A no-parameter MethodDeclaration whose name is derived from given methodName and methodArity
static com.github.javaparser.ast.body.MethodDeclaration	getMethodDeclaration(String methodName, Map<String,com.github.javaparser.ast.type.ClassOrInterfaceType> parameterNameTypeMap) Returns empty (methodName)((list of parameterType parameter name)) { } a multi-parameters MethodDeclaration whose names are the keys of the given Map and methodArity, and whose parameters types are the values The
static com.github.javaparser.ast.stmt.ReturnStmt	getReturnStmt(String returnedVariableName) Returns return (returnedVariableName); e.g return varOne;
static com.github.javaparser.ast.type.ClassOrInterfaceType	getTypedClassOrInterfaceType(String className, List<String> typesName) Returns (className)<(comma-separated list of types)> e.g CLASS_NAME a typed ClassOrInterfaceType
static Optional<com.github.javaparser.ast.body.VariableDeclarator>	getVariableDeclarator(com.github.javaparser.ast.stmt.BlockStmt body, String variableName) Return an Optional<VariableDeclarator> with the first variable variableName from the given BlockStmt
static void	populateMethodDeclarations(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration toPopulate, Collection<com.github.javaparser.ast.body.MethodDeclaration> methodDeclarations) Populate the ClassOrInterfaceDeclaration with the provided MethodDeclarations
static void	setAssignExpressionValue(com.github.javaparser.ast.stmt.BlockStmt body, String assignExpressionName, com.github.javaparser.ast.expr.Expression value) Set the value of the variable with the given assignExpressionName in the given BlockStmt It throws KiePMMLException if variable is not found
static void	setExplicitConstructorInvocationArgument(com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt constructorInvocationStmt, String parameterName, String value) Return an Optional<NameExpr> from the given ExplicitConstructorInvocationStmt

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONAL_FILTERED_KIEPMMLNAMEVALUE_NAME

public static String OPTIONAL_FILTERED_KIEPMMLNAMEVALUE_NAME

Method Detail

populateMethodDeclarations

public static void populateMethodDeclarations(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration toPopulate,
                                              Collection<com.github.javaparser.ast.body.MethodDeclaration> methodDeclarations)

Populate the ClassOrInterfaceDeclaration with the provided MethodDeclarations

Parameters:

toPopulate -

methodDeclarations -

getFilteredKiePMMLNameValueExpression

public static com.github.javaparser.ast.stmt.ExpressionStmt getFilteredKiePMMLNameValueExpression(String kiePMMLNameValueListParam,
                                                                                                  String fieldNameToRef,
                                                                                                  boolean stringLiteralComparison)

Returns

  Optional kiePMMLNameValue = (kiePMMLNameValueListParam)
      .stream()
      .filter((KiePMMLNameValue kpmmlnv) -> Objects.equals("(fieldNameToRef)", kpmmlnv.getName()))
      .findFirst();
 

expression, where kiePMMLNameValueListParam is the name of the List<KiePMMLNameValue> parameter, and fieldNameToRef is the name of the field to find, in the containing method

Parameters:

kiePMMLNameValueListParam -

fieldNameToRef -

stringLiteralComparison - if true, equals comparison is made on the String, e.g Objects.equals("(fieldNameToRef)", kpmmlnv.getName())), otherwise, is done on object reference, e.g Objects.equals((fieldNameToRef), kpmmlnv.getName())). In this latter case, a fieldNameToRef variable is expected to exists

Returns:

addMapPopulation

public static void addMapPopulation(Map<String,com.github.javaparser.ast.body.MethodDeclaration> toAdd,
                                    com.github.javaparser.ast.stmt.BlockStmt body,
                                    String mapName)

For every entry in the given map, add

     (mapName).put(entry_key, this::entry_value_ref>);
 

e.g.

     MAP_NAME.put("KEY_0", this::METHOD_015);
     MAP_NAME.put("KEY_3", this::METHOD_33);
     MAP_NAME.put("KEY_2", this::METHOD_219);
     MAP_NAME.put("KEY_4", this::METHOD_46);
 

inside the given BlockStmt

Parameters:

toAdd -

body -

mapName -

getMethodDeclaration

public static com.github.javaparser.ast.body.MethodDeclaration getMethodDeclaration(String methodName,
                                                                                    Map<String,com.github.javaparser.ast.type.ClassOrInterfaceType> parameterNameTypeMap)

Returns

     empty (methodName)((list of parameterType parameter name)) {
 }
 

a multi-parameters MethodDeclaration whose names are the keys of the given Map and methodArity, and whose parameters types are the values The

Parameters:

methodName -

parameterNameTypeMap - expecting an ordered map here, since parameters order matter for caller code

Returns:

getMethodDeclaration

public static com.github.javaparser.ast.body.MethodDeclaration getMethodDeclaration(String methodName)

Returns

     empty (methodName)() {
     }
 

A no-parameter MethodDeclaration whose name is derived from given methodName and methodArity

Parameters:

methodName -

Returns:

getReturnStmt

public static com.github.javaparser.ast.stmt.ReturnStmt getReturnStmt(String returnedVariableName)

Returns

     return (returnedVariableName);
 

e.g

     return varOne;
 

Parameters:

returnedVariableName -

Returns:

getTypedClassOrInterfaceType

public static com.github.javaparser.ast.type.ClassOrInterfaceType getTypedClassOrInterfaceType(String className,
                                                                                               List<String> typesName)

Returns

     (className)<(comma-separated list of types)>
 

e.g

     CLASS_NAME
 

a typed ClassOrInterfaceType

Parameters:

className -

typesName -

Returns:

setAssignExpressionValue

public static void setAssignExpressionValue(com.github.javaparser.ast.stmt.BlockStmt body,
                                            String assignExpressionName,
                                            com.github.javaparser.ast.expr.Expression value)

Set the value of the variable with the given assignExpressionName in the given BlockStmt It throws KiePMMLException if variable is not found

Parameters:

body -

assignExpressionName -

value -

Throws:

KiePMMLException - if AssignExpr with given assignExpressionName is not found

getAssignExpression

public static Optional<com.github.javaparser.ast.expr.AssignExpr> getAssignExpression(com.github.javaparser.ast.stmt.BlockStmt body,
                                                                                      String assignExpressionName)

Return an Optional<AssignExpr> with the given assignExpressionName from the given BlockStmt

Parameters:

body -

assignExpressionName -

Returns:

Optional<AssignExpr> with the found AssignExpr, or Optional.empty() if no match has been found

getExplicitConstructorInvocationStmt

public static Optional<com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt> getExplicitConstructorInvocationStmt(com.github.javaparser.ast.stmt.BlockStmt body)

Return an Optional<ExplicitConstructorInvocationStmt> from the given BlockStmt

Parameters:

body -

Returns:

Optional<ExplicitConstructorInvocationStmt> with the found ExplicitConstructorInvocationStmt, or Optional.empty() if none is found

setExplicitConstructorInvocationArgument

public static void setExplicitConstructorInvocationArgument(com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt constructorInvocationStmt,
                                                            String parameterName,
                                                            String value)

Return an Optional<NameExpr> from the given ExplicitConstructorInvocationStmt

Parameters:

constructorInvocationStmt -

parameterName -

value -

getExplicitConstructorInvocationParameter

public static Optional<com.github.javaparser.ast.expr.NameExpr> getExplicitConstructorInvocationParameter(com.github.javaparser.ast.stmt.ExplicitConstructorInvocationStmt constructorInvocationStmt,
                                                                                                          String parameterName)

Return an Optional<NameExpr> from the given ExplicitConstructorInvocationStmt

Parameters:

constructorInvocationStmt -

parameterName -

Returns:

Optional<NameExpr> with the found NameExpr, or Optional.empty() if none is found

getMethodDeclaration

public static Optional<com.github.javaparser.ast.body.MethodDeclaration> getMethodDeclaration(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration classOrInterfaceDeclaration,
                                                                                              String methodName)

Return an Optional<MethodDeclaration> with the first method methodName from the given ClassOrInterfaceDeclaration

Parameters:

classOrInterfaceDeclaration -

methodName -

Returns:

Optional<MethodDeclaration> with the first found MethodDeclaration, or Optional.empty() if no match has been found

addMethod

public static com.github.javaparser.ast.body.MethodDeclaration addMethod(com.github.javaparser.ast.body.MethodDeclaration methodTemplate,
                                                                         com.github.javaparser.ast.body.ClassOrInterfaceDeclaration tableTemplate,
                                                                         String methodName)

Add a MethodDeclaration to the class

Parameters:

methodTemplate -

tableTemplate -

methodName -

Returns:

getVariableDeclarator

public static Optional<com.github.javaparser.ast.body.VariableDeclarator> getVariableDeclarator(com.github.javaparser.ast.stmt.BlockStmt body,
                                                                                                String variableName)

Return an Optional<VariableDeclarator> with the first variable variableName from the given BlockStmt

Parameters:

body -

variableName -

Returns:

Optional<VariableDeclarator> with the first found VariableDeclarator, or Optional.empty() if no match has been found