Skip to content

Commit f5e9f53

Browse files
docs: write migration guide
- migration guide - Getters for List Elements - Rename Join `rightItem` to `fromItem`
1 parent 6d2b421 commit f5e9f53

File tree

17 files changed

+524
-61
lines changed

17 files changed

+524
-61
lines changed

src/main/java/net/sf/jsqlparser/statement/select/Join.java

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class Join extends ASTNodeAccessImpl {
3434
private boolean semi = false;
3535
private boolean straight = false;
3636
private boolean apply = false;
37-
private FromItem rightItem;
37+
private FromItem fromItem;
3838
private final LinkedList<Expression> onExpressions = new LinkedList<>();
3939
private final LinkedList<Column> usingColumns = new LinkedList<>();
4040
private KSQLJoinWindow joinWindow;
@@ -279,18 +279,29 @@ public void setCross(boolean cross) {
279279

280280
/**
281281
* Returns the right item of the join
282+
*
282283
*/
283284
public FromItem getRightItem() {
284-
return rightItem;
285+
return fromItem;
285286
}
286287

288+
@Deprecated
287289
public Join withRightItem(FromItem item) {
288-
this.setRightItem(item);
290+
this.setFromItem(item);
289291
return this;
290292
}
291293

292294
public void setRightItem(FromItem item) {
293-
rightItem = item;
295+
fromItem = item;
296+
}
297+
298+
public FromItem getFromItem() {
299+
return fromItem;
300+
}
301+
302+
public Join setFromItem(FromItem fromItem) {
303+
this.fromItem = fromItem;
304+
return this;
294305
}
295306

296307
/**
@@ -376,9 +387,9 @@ public String toString() {
376387
}
377388

378389
if (isSimple() && isOuter()) {
379-
builder.append("OUTER ").append(rightItem);
390+
builder.append("OUTER ").append(fromItem);
380391
} else if (isSimple()) {
381-
builder.append(rightItem);
392+
builder.append(fromItem);
382393
} else {
383394
if (isNatural()) {
384395
builder.append("NATURAL ");
@@ -410,7 +421,7 @@ public String toString() {
410421
builder.append("JOIN ");
411422
}
412423

413-
builder.append(rightItem).append((joinWindow != null) ? " WITHIN " + joinWindow : "");
424+
builder.append(fromItem).append((joinWindow != null) ? " WITHIN " + joinWindow : "");
414425
}
415426

416427
for (Expression onExpression : onExpressions) {

src/main/java/net/sf/jsqlparser/statement/select/ParenthesedFromItem.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ public List<Join> getJoins() {
4141
return joins;
4242
}
4343

44+
public Join getJoin(int index) {
45+
return joins.get(index);
46+
}
47+
4448
public FromItem addJoins(Join... joins) {
4549
List<Join> list = Optional.ofNullable(getJoins()).orElseGet(ArrayList::new);
4650
Collections.addAll(list, joins);

src/main/java/net/sf/jsqlparser/statement/select/ParenthesedSelect.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@ public Select getSelect() {
5454
return select;
5555
}
5656

57+
public Values getValues() {
58+
return (Values) select;
59+
}
60+
61+
public PlainSelect getPlainSelect() {
62+
return (PlainSelect) select;
63+
}
64+
65+
public SetOperationList getSetOperationList() {
66+
return (SetOperationList) select;
67+
}
68+
5769
public void setSelect(Select select) {
5870
this.select = select;
5971
}

src/main/java/net/sf/jsqlparser/statement/select/PlainSelect.java

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ public List<SelectItem<?>> getSelectItems() {
8282
return selectItems;
8383
}
8484

85+
public SelectItem<?> getSelectItem(int index) {
86+
return selectItems.get(index);
87+
}
88+
8589
public Expression getWhere() {
8690
return where;
8791
}
@@ -124,7 +128,7 @@ public PlainSelect addSelectItems(Expression... expressions) {
124128

125129
public PlainSelect addSelectItem(Expression expression, Alias alias) {
126130
selectItems = Optional.ofNullable(selectItems).orElseGet(ArrayList::new);
127-
selectItems.add(new SelectItem(expression, alias));
131+
selectItems.add(new SelectItem<>(expression, alias));
128132
return this;
129133
}
130134

@@ -177,6 +181,10 @@ public List<Join> getJoins() {
177181
return joins;
178182
}
179183

184+
public Join getJoin(int index) {
185+
return joins.get(index);
186+
}
187+
180188
public PlainSelect addJoins(Join... joins) {
181189
List<Join> list = Optional.ofNullable(getJoins()).orElseGet(ArrayList::new);
182190
Collections.addAll(list, joins);

src/main/java/net/sf/jsqlparser/statement/select/SetOperationList.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ public List<Select> getSelects() {
3434
return selects;
3535
}
3636

37+
public Select getSelect(int index) {
38+
return selects.get(index);
39+
}
40+
3741
public void setSelects(List<Select> selects) {
3842
this.selects = selects;
3943
}
@@ -46,7 +50,9 @@ public List<SetOperation> getOperations() {
4650
return operations;
4751
}
4852

49-
53+
public SetOperation getOperation(int index) {
54+
return operations.get(index);
55+
}
5056

5157
public void setOrderByElements(List<OrderByElement> orderByElements) {
5258
this.orderByElements = orderByElements;

src/main/java/net/sf/jsqlparser/statement/update/Update.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ public List<UpdateSet> getUpdateSets() {
6464
return updateSets;
6565
}
6666

67+
public UpdateSet getUpdateSet(int index) {
68+
return updateSets.get(index);
69+
}
70+
6771
public void setUpdateSets(List<UpdateSet> updateSets) {
6872
this.updateSets = updateSets;
6973
}

src/main/java/net/sf/jsqlparser/statement/update/UpdateSet.java

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
public class UpdateSet implements Serializable {
2323
protected ExpressionList<Column> columns = new ExpressionList<>();
24-
protected ExpressionList values = new ExpressionList();
24+
protected ExpressionList<Expression> values = new ExpressionList<>();
2525

2626
public UpdateSet() {
2727

@@ -40,6 +40,10 @@ public ExpressionList<Column> getColumns() {
4040
return columns;
4141
}
4242

43+
public Column getColumn(int index) {
44+
return columns.get(index);
45+
}
46+
4347
public void setColumns(ExpressionList<Column> columns) {
4448
this.columns = Objects.requireNonNull(columns);
4549
}
@@ -48,6 +52,10 @@ public ExpressionList<?> getValues() {
4852
return values;
4953
}
5054

55+
public Expression getValue(int index) {
56+
return values.get(index);
57+
}
58+
5159
public void setValues(ExpressionList values) {
5260
this.values = Objects.requireNonNull(values);
5361
}
@@ -83,8 +91,8 @@ public void add(Expression expression) {
8391
values.add(expression);
8492
}
8593

86-
public void add(ExpressionList expressionList) {
87-
values.addAll(expressionList.getExpressions());
94+
public void add(ExpressionList<?> expressionList) {
95+
values.addAll(expressionList);
8896
}
8997

9098
public final static StringBuilder appendUpdateSetsTo(StringBuilder builder,

src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ public void visit(PlainSelect plainSelect) {
266266

267267
if (plainSelect.getJoins() != null) {
268268
for (Join join : plainSelect.getJoins()) {
269-
join.getRightItem().accept(this);
269+
join.getFromItem().accept(this);
270270
}
271271
}
272272
if (plainSelect.getWhere() != null) {
@@ -732,7 +732,7 @@ public void visit(Delete delete) {
732732

733733
if (delete.getJoins() != null) {
734734
for (Join join : delete.getJoins()) {
735-
join.getRightItem().accept(this);
735+
join.getFromItem().accept(this);
736736
}
737737
}
738738

@@ -746,7 +746,7 @@ public void visit(Update update) {
746746
visit(update.getTable());
747747
if (update.getStartJoins() != null) {
748748
for (Join join : update.getStartJoins()) {
749-
join.getRightItem().accept(this);
749+
join.getFromItem().accept(this);
750750
}
751751
}
752752
if (update.getExpressions() != null) {
@@ -761,7 +761,7 @@ public void visit(Update update) {
761761

762762
if (update.getJoins() != null) {
763763
for (Join join : update.getJoins()) {
764-
join.getRightItem().accept(this);
764+
join.getFromItem().accept(this);
765765
}
766766
}
767767

src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ public void deparseJoin(Join join) {
468468

469469
}
470470

471-
FromItem fromItem = join.getRightItem();
471+
FromItem fromItem = join.getFromItem();
472472
fromItem.accept(this);
473473
if (join.isWindowJoin()) {
474474
buffer.append(" WITHIN ");

src/main/java/net/sf/jsqlparser/util/validation/validator/SelectValidator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ public void validateOptionalJoin(Join join) {
233233
validateOptionalFeature(c, join.getUsingColumns(), Feature.joinUsingColumns);
234234
}
235235

236-
validateOptionalFromItem(join.getRightItem());
236+
validateOptionalFromItem(join.getFromItem());
237237
for (Expression onExpression : join.getOnExpressions()) {
238238
validateOptionalExpression(onExpression);
239239
}

0 commit comments

Comments
 (0)