Preparations for JSQLParser 5.0, renaming Enities

[manticore-projects]

I have started working on a massiv JSQLParser 5.0 re-write and got rid of a lot of redundant classes and productions. The API is much leaner and simpler now.

The remaining eye sore is about:

• abstract Select --> Query
• PlainSelect --> rename to Select (implementing Query)
• SetOperationList --> rename to QuerySet (implementing Query), we could also call it SelectSet but that violated VALUES(...) UNION VALUES(...)
• RelObjectName --> rename Identifier
• SelectItem --> rename to AliasedExpression (because it has an Expression and an Alias and is used outside of a Select)

Any objections or better ideas please?

Further I would like to suggest to remove the GitHub Wiki which is superseded by the Web Page. Contradicting information would be irritating.

[manticore-projects]

Striving for a more consistent and pleasant API, I would like to implement a simple Class scanner checking the following rules:

1. each (not final) field shall have a Getter/Setter/Fluent Setter (based on Name, Return Type, Parameter)
2. any case of Collection<Expression> should be avoided (as it is very likely an ExpressionList)
3. maybe: constructor for all the fields (I am not sure if this was good or harmful)
4. maybe: any case of "bracket" (indicating that brackets maybe used or not, typically pointing out a flawed grammar)

Since I did not find any similar Scanner/Tool on the internet, I have written a very simple prototype which finds a lot of exceptions. It can be amended on demand (better filter, more rules).

I would like to clean up the API once before 5.0 and then enforce the rules (using a Unit Test).

Any objections or better ideas please?

Sample Output:

expression.AnalyticExpression ignoreNullsOutside: [Fluent Setter] missing.
expression.AnalyticExpression funcOrderBy: [Fluent Setter] missing.
expression.AnalyticExpression windowName: [Fluent Setter] missing.
expression.AnalyticExpression windowDef: [Getter] [Setter] [Fluent Setter] missing.
expression.ArrayConstructor expressions: [Fluent Setter] missing.
expression.ArrayConstructor arrayKeyword: [Fluent Setter] missing.
expression.ArrayExpression startIndexExpression: [Fluent Setter] missing.
expression.ArrayExpression stopIndexExpression: [Fluent Setter] missing.
expression.CastExpression keyword: [Getter] [Setter] [Fluent Setter] missing.

[manticore-projects]

Special attention to the Boolean fields.

1. I have allowed field names like is..., use... and has...
2. looking for getters like is..., isUsing..., isHaving... ( no isUse... and no isHas...)
3. looking for setters like set..., setUse..., setUsing..., setHas..., setHaving...
4. looking for fluent setters like with..., withUse..., withUsing..., withHas..., withHaving... (although I don't like withUse... or withHas... too much)

This warns about expression.AnalyticExpression ignoreNullsOutside which should be refactored into expression.AnalyticExpression isIgnoringNullsOutside with isIgnoringNullsOutSide() setIgnoringNullsOutSide(boolean isIgnoringNullsOutside) and withIgnoringNullsOutSide(boolean isIgnoringNullsOutside).

Complete exceptions attached, the list is shorter than expected.
naming_exceptions.txt

[manticore-projects]

I have flexed my Reflection Muscles and found 19 fields left, which should be probably converted into ExpressionList:

APISanitation > testExpressionList(Field) > 13 Field java.util.List net.sf.jsqlparser.statement.SetStatement$NameExpr.expressions FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/SetStatement/NameExpr.java:1
APISanitation > testExpressionList(Field) > 248 Field private java.util.ArrayList net.sf.jsqlparser.expression.TimezoneExpression.timezoneExpressions FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/expression/TimezoneExpression.java:20
APISanitation > testExpressionList(Field) > 253 Field private java.util.List net.sf.jsqlparser.expression.ArrayConstructor.expressions FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/expression/ArrayConstructor.java:18
APISanitation > testExpressionList(Field) > 263 Field private java.util.List net.sf.jsqlparser.expression.operators.relational.FullTextSearch._matchColumns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/expression/operators/relational/FullTextSearch.java:28
APISanitation > testExpressionList(Field) > 312 Field private java.util.List net.sf.jsqlparser.statement.insert.Insert.duplicateUpdateColumns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java:43
APISanitation > testExpressionList(Field) > 313 Field private java.util.List net.sf.jsqlparser.statement.insert.Insert.duplicateUpdateExpressionList FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java:44
APISanitation > testExpressionList(Field) > 315 Field private java.util.List net.sf.jsqlparser.statement.insert.Insert.setColumns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java:51
APISanitation > testExpressionList(Field) > 316 Field private java.util.List net.sf.jsqlparser.statement.insert.Insert.setExpressionList FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java:52
APISanitation > testExpressionList(Field) > 320 Field private java.util.List net.sf.jsqlparser.statement.merge.MergeInsert.columns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/merge/MergeInsert.java:24
APISanitation > testExpressionList(Field) > 321 Field private java.util.List net.sf.jsqlparser.statement.merge.MergeInsert.values FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/merge/MergeInsert.java:25
APISanitation > testExpressionList(Field) > 322 Field private java.util.List net.sf.jsqlparser.statement.merge.MergeUpdate.columns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/merge/MergeUpdate.java:23
APISanitation > testExpressionList(Field) > 323 Field private java.util.List net.sf.jsqlparser.statement.merge.MergeUpdate.values FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/merge/MergeUpdate.java:24
APISanitation > testExpressionList(Field) > 326 Field private java.util.List net.sf.jsqlparser.statement.select.Limit.byExpressions FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/select/Limit.java:34
APISanitation > testExpressionList(Field) > 328 Field private java.util.List net.sf.jsqlparser.statement.select.Pivot.forColumns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/select/Pivot.java:25
APISanitation > testExpressionList(Field) > 340 Field private java.util.List net.sf.jsqlparser.statement.select.UnPivot.unpivotClause FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/select/UnPivot.java:22
APISanitation > testExpressionList(Field) > 341 Field private java.util.List net.sf.jsqlparser.statement.select.UnPivot.unpivotForClause FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/select/UnPivot.java:23
APISanitation > testExpressionList(Field) > 350 Field private java.util.List net.sf.jsqlparser.statement.upsert.Upsert.columns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/upsert/Upsert.java:32
APISanitation > testExpressionList(Field) > 351 Field private java.util.List net.sf.jsqlparser.statement.upsert.Upsert.duplicateUpdateColumns FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/upsert/Upsert.java:36
APISanitation > testExpressionList(Field) > 352 Field private java.util.List net.sf.jsqlparser.statement.upsert.Upsert.duplicateUpdateExpressionList FAILED
    net.sf.jsqlparser.util.APISanitation$MethodNamingException at file:/home/are/Documents/src/JSQLFormatter/JSQLParser/src/main/java/net/sf/jsqlparser/statement/upsert/Upsert.java:37
830 tests completed, 19 failed

[manticore-projects]

Please why exactly do we have both void setXXXX(Object o) and Object parent withXXXX(Object o)?
I am all in for builders and fluid, but why exactly was having only Object parent setXXXX(Object o) not sufficient, especially when Object parent withXXXX(Object o)? always calls this.setXXXX(Object o); return this;?

Do we want to clean this up for 5.0 and release a policy about Getters()/Setters()?

[manticore-projects]

The other question I have is: Why exactly do we allow empty Constructors leaving Objects in invalid states? E. g. something like public PlainSelect() should not be allowed and I do not see any good reason for it? In my opinion, only truly optional parameters (like a WHERE clause should be exempted from being part of the constructor?

I would not want to forcefully clean that up in the existing Grammar, but at least I would like to agree on a policy for moving forward and accepting future PRs?

There are of course Constructore which can be empty, like public Values() since SQL Values() indeed is a valid statement (while SELECT only is not).