To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fluent builder for a JoinTable, which combines rows from two other registered tables on a matching key column. Obtained by calling joinTableBuilder (for example on Queries or ControllerMappingList), configured with id, description, leftTable, rightTable and addField, then turned into the finished table with build, or by passing it to addJoinTable to register it.
Group: Builders
Properties
| Property | Returns | Description |
|---|---|---|
| desc | String | The description configured for the finished join table. |
| fields | List<JoinTableFieldBuilder> | The output column builders added so far via addField, in the order they will appear in the finished table. |
| id | String | The id configured for the finished join table. |
| leftTable | JoinFieldDefBuilder | The field definition builder for the left side of the join, if leftTable has been called. |
| rightTable | JoinFieldDefBuilder | The field definition builder for the right side of the join, if rightTable has been called. |
Methods
id(String s) · description(String s) · leftTable() · rightTable() · addField() · build() · getId() · getDesc() · getFields() · getLeftTable() · getRightTable()
id(String s)
Returns: JoinTableBuilder
Sets the id the finished join table is registered and looked up under.
| Parameter | Description |
|---|---|
s | the table id |
description(String s)
Returns: JoinTableBuilder
Sets the human readable description shown for the finished join table.
| Parameter | Description |
|---|---|
s | the description |
leftTable()
Returns: JoinFieldDefBuilder
The builder for the left side of the join, creating it on first use. Configure it with the id of the table to join from and the column to join on.
rightTable()
Returns: JoinFieldDefBuilder
The builder for the right side of the join, creating it on first use. Configure it with the id of the table to join to and the column to join on. Leave this unconfigured for a join with no right hand side.
addField()
Returns: JoinTableFieldBuilder
Adds and returns a builder for one output column of the finished join table, sourced from either the left or right table.
build()
Returns: JoinTable
Builds the immutable JoinTable described by this builder's current configuration.
getId()
Returns: String
The id configured for the finished join table.
getDesc()
Returns: String
The description configured for the finished join table.
getFields()
Returns: List<JoinTableFieldBuilder>
The output column builders added so far via addField, in the order they will appear in the finished table.
getLeftTable()
Returns: JoinFieldDefBuilder
The field definition builder for the left side of the join, if leftTable has been called.
getRightTable()
Returns: JoinFieldDefBuilder
The field definition builder for the right side of the join, if rightTable has been called.
© 2025 Kademi Ltd