com.speedment.runtime.join.builder

Interface JoinBuilder2<T0,T1>

Type Parameters:

T0 - the first entity type

T1 - the second entity type

All Superinterfaces:

HasDefaultBuild<com.speedment.common.tuple.nullable.Tuple2OfNullables<T0,T1>>, HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>, HasWhere<T1,JoinBuilder2<T0,T1>>

public interface JoinBuilder2<T0,T1>
extends HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>, HasWhere<T1,JoinBuilder2<T0,T1>>, HasDefaultBuild<com.speedment.common.tuple.nullable.Tuple2OfNullables<T0,T1>>

Join Builder stage used when only 2 tables has been specified so far.

Since:

3.1.1

Author:

Per Minborg, Emil Forslund

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JoinBuilder2.AfterJoin<T0,T1,T2>

Method Summary

Modifier and Type	Method and Description
default Join<com.speedment.common.tuple.nullable.Tuple2OfNullables<T0,T1>>	build() Creates and returns a new Join object where elements in the Join object's stream method is of a default Tuple type.
<T> Join<T>	build(BiFunction<T0,T1,T> constructor) Creates and returns a new Join object where elements in the Join object's stream method is created using the provided constructor.
<T2> JoinBuilder3<T0,T1,T2>	crossJoin(TableIdentifier<T2> joinedTable) Adds the provided joinedTable to the collection of joined tables.
<T2> JoinBuilder2.AfterJoin<T0,T1,T2>	innerJoinOn(HasComparableOperators<T2,?> joinedField) Adds the provided joinedField to the collection of joined column/tables.
<T2> JoinBuilder2.AfterJoin<T0,T1,T2>	leftJoinOn(HasComparableOperators<T2,?> joinedField) Adds the provided joinedField to the collection of joined column/tables.
<T2> JoinBuilder2.AfterJoin<T0,T1,T2>	rightJoinOn(HasComparableOperators<T2,?> joinedField) Adds the provided joinedField to the collection of joined column/tables.

Methods inherited from interface com.speedment.runtime.join.trait.HasWhere

where

Method Detail

innerJoinOn

<T2> JoinBuilder2.AfterJoin<T0,T1,T2> innerJoinOn(HasComparableOperators<T2,?> joinedField)

Description copied from interface: HasJoins

Adds the provided joinedField to the collection of joined column/tables. Elements are joined from the table of the provided joinedField using an INNER JOIN whereby rows from two tables are present only if there is a match between the joining columns. Thus, rows that do not have matches in the joining columns will not be present in the result.

Specified by:

innerJoinOn in interface HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>

Type Parameters:

T2 - entity type

Parameters:

joinedField - to add to the current join builder

Returns:

a builder where the provided joinedField is added

leftJoinOn

<T2> JoinBuilder2.AfterJoin<T0,T1,T2> leftJoinOn(HasComparableOperators<T2,?> joinedField)

Description copied from interface: HasJoins

Adds the provided joinedField to the collection of joined column/tables. Elements are joined from the table of the provided joinedField using an LEFT JOIN whereby rows from two tables are present either if there is a match between the joining columns or for each row from previously existing table(s).

Unmatched rows will have entities from the table in the given joinedField set to null

Specified by:

leftJoinOn in interface HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>

Type Parameters:

T2 - entity type

Parameters:

joinedField - to add to the current join builder

Returns:

a builder where the provided joinedField is added

rightJoinOn

<T2> JoinBuilder2.AfterJoin<T0,T1,T2> rightJoinOn(HasComparableOperators<T2,?> joinedField)

Description copied from interface: HasJoins

Adds the provided joinedField to the collection of joined column/tables. Elements are joined from the table of the provided joinedField using an RIGHT JOIN whereby rows from two tables are present either if there is a match between the joining columns or for each row from the table for the provided joinedField.

Unmatched rows will have entities from the table in the given joinedField set to null

Specified by:

rightJoinOn in interface HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>

Type Parameters:

T2 - entity type

Parameters:

joinedField - to add to the current join builder

Returns:

a builder where the provided joinedField is added

crossJoin

<T2> JoinBuilder3<T0,T1,T2> crossJoin(TableIdentifier<T2> joinedTable)

Description copied from interface: HasJoins

Adds the provided joinedTable to the collection of joined tables. Elements are joined from the table of the provided joinedTable using an CROSS JOIN whereby all combination of rows using all tables(s) are produced.

Specified by:

crossJoin in interface HasJoins<JoinBuilder2.AfterJoin<T0,T1,?>,JoinBuilder3<T0,T1,?>>

Type Parameters:

T2 - entity type

Parameters:

joinedTable - to add to the current join builder

Returns:

a builder where the provided joinedField is added

build

default Join<com.speedment.common.tuple.nullable.Tuple2OfNullables<T0,T1>> build()

Description copied from interface: HasDefaultBuild

Creates and returns a new Join object where elements in the Join object's stream method is of a default Tuple type.

Specified by:

build in interface HasDefaultBuild<com.speedment.common.tuple.nullable.Tuple2OfNullables<T0,T1>>

Returns:

a new Join object where elements in the Join object's stream method is of a default Tuple type

build

<T> Join<T> build(BiFunction<T0,T1,T> constructor)

Creates and returns a new Join object where elements in the Join object's stream method is created using the provided constructor.

Type Parameters:

T - the type of element in the Join object's stream method.

Parameters:

constructor - to use to create stream elements.

Returns:

a new Join object where elements in the Join object's stream method is of a default Tuple type

Throws:

NullPointerException - if the provided constructor is null